UNPKG

@octokit/plugin-enterprise-rest

Version:
1,473 lines 193 kB
{ "activity": { "checkStarringRepo": { "method": "GET", "params": { "owner": { "required": true, "type": "string" }, "repo": { "required": true, "type": "string" } }, "url": "/user/starred/:owner/:repo" }, "deleteRepoSubscription": { "method": "DELETE", "params": { "owner": { "required": true, "type": "string" }, "repo": { "required": true, "type": "string" } }, "url": "/repos/:owner/:repo/subscription" }, "deleteThreadSubscription": { "method": "DELETE", "params": { "thread_id": { "required": true, "type": "integer" } }, "url": "/notifications/threads/:thread_id/subscription" }, "getRepoSubscription": { "method": "GET", "params": { "owner": { "required": true, "type": "string" }, "repo": { "required": true, "type": "string" } }, "url": "/repos/:owner/:repo/subscription" }, "getThread": { "method": "GET", "params": { "thread_id": { "required": true, "type": "integer" } }, "url": "/notifications/threads/:thread_id" }, "getThreadSubscription": { "method": "GET", "params": { "thread_id": { "required": true, "type": "integer" } }, "url": "/notifications/threads/:thread_id/subscription" }, "listEventsForOrg": { "method": "GET", "params": { "org": { "required": true, "type": "string" }, "page": { "type": "integer" }, "per_page": { "type": "integer" }, "username": { "required": true, "type": "string" } }, "url": "/users/:username/events/orgs/:org" }, "listEventsForUser": { "method": "GET", "params": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "username": { "required": true, "type": "string" } }, "url": "/users/:username/events" }, "listFeeds": { "method": "GET", "params": {}, "url": "/feeds" }, "listNotifications": { "method": "GET", "params": { "all": { "type": "boolean" }, "before": { "type": "string" }, "page": { "type": "integer" }, "participating": { "type": "boolean" }, "per_page": { "type": "integer" }, "since": { "type": "string" } }, "url": "/notifications" }, "listNotificationsForRepo": { "method": "GET", "params": { "all": { "type": "boolean" }, "before": { "type": "string" }, "owner": { "required": true, "type": "string" }, "page": { "type": "integer" }, "participating": { "type": "boolean" }, "per_page": { "type": "integer" }, "repo": { "required": true, "type": "string" }, "since": { "type": "string" } }, "url": "/repos/:owner/:repo/notifications" }, "listPublicEvents": { "method": "GET", "params": { "page": { "type": "integer" }, "per_page": { "type": "integer" } }, "url": "/events" }, "listPublicEventsForOrg": { "method": "GET", "params": { "org": { "required": true, "type": "string" }, "page": { "type": "integer" }, "per_page": { "type": "integer" } }, "url": "/orgs/:org/events" }, "listPublicEventsForRepoNetwork": { "method": "GET", "params": { "owner": { "required": true, "type": "string" }, "page": { "type": "integer" }, "per_page": { "type": "integer" }, "repo": { "required": true, "type": "string" } }, "url": "/networks/:owner/:repo/events" }, "listPublicEventsForUser": { "method": "GET", "params": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "username": { "required": true, "type": "string" } }, "url": "/users/:username/events/public" }, "listReceivedEventsForUser": { "method": "GET", "params": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "username": { "required": true, "type": "string" } }, "url": "/users/:username/received_events" }, "listReceivedPublicEventsForUser": { "method": "GET", "params": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "username": { "required": true, "type": "string" } }, "url": "/users/:username/received_events/public" }, "listRepoEvents": { "method": "GET", "params": { "owner": { "required": true, "type": "string" }, "page": { "type": "integer" }, "per_page": { "type": "integer" }, "repo": { "required": true, "type": "string" } }, "url": "/repos/:owner/:repo/events" }, "listReposStarredByAuthenticatedUser": { "method": "GET", "params": { "direction": { "enum": ["asc", "desc"], "type": "string" }, "page": { "type": "integer" }, "per_page": { "type": "integer" }, "sort": { "enum": ["created", "updated"], "type": "string" } }, "url": "/user/starred" }, "listReposStarredByUser": { "method": "GET", "params": { "direction": { "enum": ["asc", "desc"], "type": "string" }, "page": { "type": "integer" }, "per_page": { "type": "integer" }, "sort": { "enum": ["created", "updated"], "type": "string" }, "username": { "required": true, "type": "string" } }, "url": "/users/:username/starred" }, "listReposWatchedByUser": { "method": "GET", "params": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "username": { "required": true, "type": "string" } }, "url": "/users/:username/subscriptions" }, "listStargazersForRepo": { "method": "GET", "params": { "owner": { "required": true, "type": "string" }, "page": { "type": "integer" }, "per_page": { "type": "integer" }, "repo": { "required": true, "type": "string" } }, "url": "/repos/:owner/:repo/stargazers" }, "listWatchedReposForAuthenticatedUser": { "method": "GET", "params": { "page": { "type": "integer" }, "per_page": { "type": "integer" } }, "url": "/user/subscriptions" }, "listWatchersForRepo": { "method": "GET", "params": { "owner": { "required": true, "type": "string" }, "page": { "type": "integer" }, "per_page": { "type": "integer" }, "repo": { "required": true, "type": "string" } }, "url": "/repos/:owner/:repo/subscribers" }, "markAsRead": { "method": "PUT", "params": { "last_read_at": { "type": "string" } }, "url": "/notifications" }, "markNotificationsAsReadForRepo": { "method": "PUT", "params": { "last_read_at": { "type": "string" }, "owner": { "required": true, "type": "string" }, "repo": { "required": true, "type": "string" } }, "url": "/repos/:owner/:repo/notifications" }, "markThreadAsRead": { "method": "PATCH", "params": { "thread_id": { "required": true, "type": "integer" } }, "url": "/notifications/threads/:thread_id" }, "setRepoSubscription": { "method": "PUT", "params": { "ignored": { "type": "boolean" }, "owner": { "required": true, "type": "string" }, "repo": { "required": true, "type": "string" }, "subscribed": { "type": "boolean" } }, "url": "/repos/:owner/:repo/subscription" }, "setThreadSubscription": { "method": "PUT", "params": { "ignored": { "type": "boolean" }, "thread_id": { "required": true, "type": "integer" } }, "url": "/notifications/threads/:thread_id/subscription" }, "starRepo": { "method": "PUT", "params": { "owner": { "required": true, "type": "string" }, "repo": { "required": true, "type": "string" } }, "url": "/user/starred/:owner/:repo" }, "unstarRepo": { "method": "DELETE", "params": { "owner": { "required": true, "type": "string" }, "repo": { "required": true, "type": "string" } }, "url": "/user/starred/:owner/:repo" } }, "apps": { "addRepoToInstallation": { "headers": { "accept": "application/vnd.github.machine-man-preview+json" }, "method": "PUT", "params": { "installation_id": { "required": true, "type": "integer" }, "repository_id": { "required": true, "type": "integer" } }, "url": "/user/installations/:installation_id/repositories/:repository_id" }, "createContentAttachment": { "headers": { "accept": "application/vnd.github.corsair-preview+json" }, "method": "POST", "params": { "body": { "required": true, "type": "string" }, "content_reference_id": { "required": true, "type": "integer" }, "title": { "required": true, "type": "string" } }, "url": "/content_references/:content_reference_id/attachments" }, "createFromManifest": { "headers": { "accept": "application/vnd.github.fury-preview+json" }, "method": "POST", "params": { "code": { "required": true, "type": "string" } }, "url": "/app-manifests/:code/conversions" }, "createInstallationToken": { "headers": { "accept": "application/vnd.github.machine-man-preview+json" }, "method": "POST", "params": { "installation_id": { "required": true, "type": "integer" }, "permissions": { "type": "object" }, "repository_ids": { "type": "integer[]" } }, "url": "/app/installations/:installation_id/access_tokens" }, "deleteInstallation": { "headers": { "accept": "application/vnd.github.gambit-preview+json,application/vnd.github.machine-man-preview+json" }, "method": "DELETE", "params": { "installation_id": { "required": true, "type": "integer" } }, "url": "/app/installations/:installation_id" }, "findOrgInstallation": { "deprecated": "octokit.apps.findOrgInstallation() has been renamed to octokit.apps.getOrgInstallation() (2019-04-10)", "headers": { "accept": "application/vnd.github.machine-man-preview+json" }, "method": "GET", "params": { "org": { "required": true, "type": "string" } }, "url": "/orgs/:org/installation" }, "findRepoInstallation": { "deprecated": "octokit.apps.findRepoInstallation() has been renamed to octokit.apps.getRepoInstallation() (2019-04-10)", "headers": { "accept": "application/vnd.github.machine-man-preview+json" }, "method": "GET", "params": { "owner": { "required": true, "type": "string" }, "repo": { "required": true, "type": "string" } }, "url": "/repos/:owner/:repo/installation" }, "findUserInstallation": { "deprecated": "octokit.apps.findUserInstallation() has been renamed to octokit.apps.getUserInstallation() (2019-04-10)", "headers": { "accept": "application/vnd.github.machine-man-preview+json" }, "method": "GET", "params": { "username": { "required": true, "type": "string" } }, "url": "/users/:username/installation" }, "getAuthenticated": { "headers": { "accept": "application/vnd.github.machine-man-preview+json" }, "method": "GET", "params": {}, "url": "/app" }, "getBySlug": { "headers": { "accept": "application/vnd.github.machine-man-preview+json" }, "method": "GET", "params": { "app_slug": { "required": true, "type": "string" } }, "url": "/apps/:app_slug" }, "getInstallation": { "headers": { "accept": "application/vnd.github.machine-man-preview+json" }, "method": "GET", "params": { "installation_id": { "required": true, "type": "integer" } }, "url": "/app/installations/:installation_id" }, "getOrgInstallation": { "headers": { "accept": "application/vnd.github.machine-man-preview+json" }, "method": "GET", "params": { "org": { "required": true, "type": "string" } }, "url": "/orgs/:org/installation" }, "getRepoInstallation": { "headers": { "accept": "application/vnd.github.machine-man-preview+json" }, "method": "GET", "params": { "owner": { "required": true, "type": "string" }, "repo": { "required": true, "type": "string" } }, "url": "/repos/:owner/:repo/installation" }, "getUserInstallation": { "headers": { "accept": "application/vnd.github.machine-man-preview+json" }, "method": "GET", "params": { "username": { "required": true, "type": "string" } }, "url": "/users/:username/installation" }, "listInstallationReposForAuthenticatedUser": { "headers": { "accept": "application/vnd.github.machine-man-preview+json" }, "method": "GET", "params": { "installation_id": { "required": true, "type": "integer" }, "page": { "type": "integer" }, "per_page": { "type": "integer" } }, "url": "/user/installations/:installation_id/repositories" }, "listInstallations": { "headers": { "accept": "application/vnd.github.machine-man-preview+json" }, "method": "GET", "params": { "page": { "type": "integer" }, "per_page": { "type": "integer" } }, "url": "/app/installations" }, "listInstallationsForAuthenticatedUser": { "headers": { "accept": "application/vnd.github.machine-man-preview+json" }, "method": "GET", "params": { "page": { "type": "integer" }, "per_page": { "type": "integer" } }, "url": "/user/installations" }, "listRepos": { "headers": { "accept": "application/vnd.github.machine-man-preview+json" }, "method": "GET", "params": { "page": { "type": "integer" }, "per_page": { "type": "integer" } }, "url": "/installation/repositories" }, "removeRepoFromInstallation": { "headers": { "accept": "application/vnd.github.machine-man-preview+json" }, "method": "DELETE", "params": { "installation_id": { "required": true, "type": "integer" }, "repository_id": { "required": true, "type": "integer" } }, "url": "/user/installations/:installation_id/repositories/:repository_id" } }, "checks": { "create": { "headers": { "accept": "application/vnd.github.antiope-preview+json" }, "method": "POST", "params": { "actions": { "type": "object[]" }, "actions[].description": { "required": true, "type": "string" }, "actions[].identifier": { "required": true, "type": "string" }, "actions[].label": { "required": true, "type": "string" }, "completed_at": { "type": "string" }, "conclusion": { "enum": [ "success", "failure", "neutral", "cancelled", "timed_out", "action_required" ], "type": "string" }, "details_url": { "type": "string" }, "external_id": { "type": "string" }, "head_sha": { "required": true, "type": "string" }, "name": { "required": true, "type": "string" }, "output": { "type": "object" }, "output.annotations": { "type": "object[]" }, "output.annotations[].annotation_level": { "enum": ["notice", "warning", "failure"], "required": true, "type": "string" }, "output.annotations[].end_column": { "type": "integer" }, "output.annotations[].end_line": { "required": true, "type": "integer" }, "output.annotations[].message": { "required": true, "type": "string" }, "output.annotations[].path": { "required": true, "type": "string" }, "output.annotations[].raw_details": { "type": "string" }, "output.annotations[].start_column": { "type": "integer" }, "output.annotations[].start_line": { "required": true, "type": "integer" }, "output.annotations[].title": { "type": "string" }, "output.images": { "type": "object[]" }, "output.images[].alt": { "required": true, "type": "string" }, "output.images[].caption": { "type": "string" }, "output.images[].image_url": { "required": true, "type": "string" }, "output.summary": { "required": true, "type": "string" }, "output.text": { "type": "string" }, "output.title": { "required": true, "type": "string" }, "owner": { "required": true, "type": "string" }, "repo": { "required": true, "type": "string" }, "started_at": { "type": "string" }, "status": { "enum": ["queued", "in_progress", "completed"], "type": "string" } }, "url": "/repos/:owner/:repo/check-runs" }, "createSuite": { "headers": { "accept": "application/vnd.github.antiope-preview+json" }, "method": "POST", "params": { "head_sha": { "required": true, "type": "string" }, "owner": { "required": true, "type": "string" }, "repo": { "required": true, "type": "string" } }, "url": "/repos/:owner/:repo/check-suites" }, "get": { "headers": { "accept": "application/vnd.github.antiope-preview+json" }, "method": "GET", "params": { "check_run_id": { "required": true, "type": "integer" }, "owner": { "required": true, "type": "string" }, "repo": { "required": true, "type": "string" } }, "url": "/repos/:owner/:repo/check-runs/:check_run_id" }, "getSuite": { "headers": { "accept": "application/vnd.github.antiope-preview+json" }, "method": "GET", "params": { "check_suite_id": { "required": true, "type": "integer" }, "owner": { "required": true, "type": "string" }, "repo": { "required": true, "type": "string" } }, "url": "/repos/:owner/:repo/check-suites/:check_suite_id" }, "listAnnotations": { "headers": { "accept": "application/vnd.github.antiope-preview+json" }, "method": "GET", "params": { "check_run_id": { "required": true, "type": "integer" }, "owner": { "required": true, "type": "string" }, "page": { "type": "integer" }, "per_page": { "type": "integer" }, "repo": { "required": true, "type": "string" } }, "url": "/repos/:owner/:repo/check-runs/:check_run_id/annotations" }, "listForRef": { "headers": { "accept": "application/vnd.github.antiope-preview+json" }, "method": "GET", "params": { "check_name": { "type": "string" }, "filter": { "enum": ["latest", "all"], "type": "string" }, "owner": { "required": true, "type": "string" }, "page": { "type": "integer" }, "per_page": { "type": "integer" }, "ref": { "required": true, "type": "string" }, "repo": { "required": true, "type": "string" }, "status": { "enum": ["queued", "in_progress", "completed"], "type": "string" } }, "url": "/repos/:owner/:repo/commits/:ref/check-runs" }, "listForSuite": { "headers": { "accept": "application/vnd.github.antiope-preview+json" }, "method": "GET", "params": { "check_name": { "type": "string" }, "check_suite_id": { "required": true, "type": "integer" }, "filter": { "enum": ["latest", "all"], "type": "string" }, "owner": { "required": true, "type": "string" }, "page": { "type": "integer" }, "per_page": { "type": "integer" }, "repo": { "required": true, "type": "string" }, "status": { "enum": ["queued", "in_progress", "completed"], "type": "string" } }, "url": "/repos/:owner/:repo/check-suites/:check_suite_id/check-runs" }, "listSuitesForRef": { "headers": { "accept": "application/vnd.github.antiope-preview+json" }, "method": "GET", "params": { "app_id": { "type": "integer" }, "check_name": { "type": "string" }, "owner": { "required": true, "type": "string" }, "page": { "type": "integer" }, "per_page": { "type": "integer" }, "ref": { "required": true, "type": "string" }, "repo": { "required": true, "type": "string" } }, "url": "/repos/:owner/:repo/commits/:ref/check-suites" }, "rerequestSuite": { "headers": { "accept": "application/vnd.github.antiope-preview+json" }, "method": "POST", "params": { "check_suite_id": { "required": true, "type": "integer" }, "owner": { "required": true, "type": "string" }, "repo": { "required": true, "type": "string" } }, "url": "/repos/:owner/:repo/check-suites/:check_suite_id/rerequest" }, "setSuitesPreferences": { "headers": { "accept": "application/vnd.github.antiope-preview+json" }, "method": "PATCH", "params": { "auto_trigger_checks": { "type": "object[]" }, "auto_trigger_checks[].app_id": { "required": true, "type": "integer" }, "auto_trigger_checks[].setting": { "required": true, "type": "boolean" }, "owner": { "required": true, "type": "string" }, "repo": { "required": true, "type": "string" } }, "url": "/repos/:owner/:repo/check-suites/preferences" }, "update": { "headers": { "accept": "application/vnd.github.antiope-preview+json" }, "method": "PATCH", "params": { "actions": { "type": "object[]" }, "actions[].description": { "required": true, "type": "string" }, "actions[].identifier": { "required": true, "type": "string" }, "actions[].label": { "required": true, "type": "string" }, "check_run_id": { "required": true, "type": "integer" }, "completed_at": { "type": "string" }, "conclusion": { "enum": [ "success", "failure", "neutral", "cancelled", "timed_out", "action_required" ], "type": "string" }, "details_url": { "type": "string" }, "external_id": { "type": "string" }, "name": { "type": "string" }, "output": { "type": "object" }, "output.annotations": { "type": "object[]" }, "output.annotations[].annotation_level": { "enum": ["notice", "warning", "failure"], "required": true, "type": "string" }, "output.annotations[].end_column": { "type": "integer" }, "output.annotations[].end_line": { "required": true, "type": "integer" }, "output.annotations[].message": { "required": true, "type": "string" }, "output.annotations[].path": { "required": true, "type": "string" }, "output.annotations[].raw_details": { "type": "string" }, "output.annotations[].start_column": { "type": "integer" }, "output.annotations[].start_line": { "required": true, "type": "integer" }, "output.annotations[].title": { "type": "string" }, "output.images": { "type": "object[]" }, "output.images[].alt": { "required": true, "type": "string" }, "output.images[].caption": { "type": "string" }, "output.images[].image_url": { "required": true, "type": "string" }, "output.summary": { "required": true, "type": "string" }, "output.text": { "type": "string" }, "output.title": { "type": "string" }, "owner": { "required": true, "type": "string" }, "repo": { "required": true, "type": "string" }, "started_at": { "type": "string" }, "status": { "enum": ["queued", "in_progress", "completed"], "type": "string" } }, "url": "/repos/:owner/:repo/check-runs/:check_run_id" } }, "codesOfConduct": { "getConductCode": { "headers": { "accept": "application/vnd.github.scarlet-witch-preview+json" }, "method": "GET", "params": { "key": { "required": true, "type": "string" } }, "url": "/codes_of_conduct/:key" }, "getForRepo": { "headers": { "accept": "application/vnd.github.scarlet-witch-preview+json" }, "method": "GET", "params": { "owner": { "required": true, "type": "string" }, "repo": { "required": true, "type": "string" } }, "url": "/repos/:owner/:repo/community/code_of_conduct" }, "listConductCodes": { "headers": { "accept": "application/vnd.github.scarlet-witch-preview+json" }, "method": "GET", "params": {}, "url": "/codes_of_conduct" } }, "emojis": { "get": { "method": "GET", "params": {}, "url": "/emojis" } }, "enterpriseAdmin": { "addAuthorizedSshKey": { "method": "POST", "params": { "authorized_key": { "required": true, "type": "string" } }, "url": "/setup/api/settings/authorized-keys" }, "checkConfigurationStatus": { "method": "GET", "params": {}, "url": "/setup/api/configcheck" }, "checkMaintenanceStatus": { "method": "GET", "params": {}, "url": "/setup/api/maintenance" }, "createGlobalHook": { "headers": { "accept": "application/vnd.github.superpro-preview+json" }, "method": "POST", "params": { "active": { "type": "boolean" }, "config": { "required": true, "type": "object" }, "config.content_type": { "type": "string" }, "config.insecure_ssl": { "type": "string" }, "config.secret": { "type": "string" }, "config.url": { "required": true, "type": "string" }, "events": { "type": "string[]" }, "name": { "required": true, "type": "string" } }, "url": "/admin/hooks" }, "createImpersonationOAuthToken": { "method": "POST", "params": { "scopes": { "type": "string[]" }, "username": { "required": true, "type": "string" } }, "url": "/admin/users/:username/authorizations" }, "createOrg": { "method": "POST", "params": { "admin": { "required": true, "type": "string" }, "login": { "required": true, "type": "string" }, "profile_name": { "type": "string" } }, "url": "/admin/organizations" }, "createPreReceiveEnvironment": { "method": "POST", "params": { "image_url": { "required": true, "type": "string" }, "name": { "required": true, "type": "string" } }, "url": "/admin/pre-receive-environments" }, "createPreReceiveHook": { "method": "POST", "params": { "allow_downstream_configuration": { "type": "boolean" }, "enforcement": { "type": "string" }, "environment": { "required": true, "type": "object" }, "name": { "required": true, "type": "string" }, "script": { "required": true, "type": "string" }, "script_repository": { "required": true, "type": "object" } }, "url": "/admin/pre-receive-hooks" }, "createUser": { "method": "POST", "params": { "email": { "type": "string" }, "login": { "required": true, "type": "string" } }, "url": "/admin/users" }, "deleteGlobalHook": { "headers": { "accept": "application/vnd.github.superpro-preview+json" }, "method": "DELETE", "params": { "hook_id": { "required": true, "type": "integer" } }, "url": "/admin/hooks/:hook_id" }, "deleteImpersonationOAuthToken": { "method": "DELETE", "params": { "username": { "required": true, "type": "string" } }, "url": "/admin/users/:username/authorizations" }, "deletePersonalAccessToken": { "method": "DELETE", "params": { "token_id": { "required": true, "type": "integer" } }, "url": "/admin/tokens/:token_id" }, "deletePreReceiveEnvironment": { "method": "DELETE", "params": { "pre_receive_environment_id": { "required": true, "type": "integer" } }, "url": "/admin/pre-receive-environments/:pre_receive_environment_id" }, "deletePreReceiveHook": { "method": "DELETE", "params": { "pre_receive_hook_id": { "required": true, "type": "integer" } }, "url": "/admin/pre_receive_hooks/:pre_receive_hook_id" }, "deletePublicKey": { "method": "DELETE", "params": { "key_ids": { "required": true, "type": "string" } }, "url": "/admin/keys/:key_ids" }, "deleteUser": { "method": "DELETE", "params": { "username": { "required": true, "type": "string" } }, "url": "/admin/users/:username" }, "demoteSiteAdministratorToOrdinaryUser": { "method": "DELETE", "params": { "username": { "required": true, "type": "string" } }, "url": "/users/:username/site_admin" }, "enableOrDisableMaintenanceMode": { "method": "POST", "params": { "maintenance": { "required": true, "type": "string" } }, "url": "/setup/api/maintenance" }, "getGlobalHook": { "headers": { "accept": "application/vnd.github.superpro-preview+json" }, "method": "GET", "params": { "hook_id": { "required": true, "type": "integer" } }, "url": "/admin/hooks/:hook_id" }, "getLicenseInformation": { "method": "GET", "params": {}, "url": "/enterprise/settings/license" }, "getPreReceiveEnvironment": { "method": "GET", "params": { "pre_receive_environment_id": { "required": true, "type": "integer" } }, "url": "/admin/pre-receive-environments/:pre_receive_environment_id" }, "getPreReceiveEnvironmentDownloadStatus": { "method": "GET", "params": { "downloaded_at": { "type": "string" }, "message": { "type": "string" }, "pre_receive_environment_id": { "required": true, "type": "integer" }, "state": { "type": "string" } }, "url": "/admin/pre-receive-environments/:pre_receive_environment_id/downloads/latest" }, "getPreReceiveHook": { "method": "GET", "params": { "pre_receive_hook_id": { "required": true, "type": "integer" } }, "url": "/admin/pre-receive-hooks/:pre_receive_hook_id" }, "getPreReceiveHookForOrg": { "method": "GET", "params": { "org": { "required": true, "type": "string" }, "pre_receive_hook_id": { "required": true, "type": "integer" } }, "url": "/orgs/:org/pre-receive-hooks/:pre_receive_hook_id" }, "getPreReceiveHookForRepo": { "method": "GET", "params": { "owner": { "required": true, "type": "string" }, "pre_receive_hook_id": { "required": true, "type": "integer" }, "repo": { "required": true, "type": "string" } }, "url": "/repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id" }, "getTypeStats": { "method": "GET", "params": { "type": { "required": true, "type": "string" } }, "url": "/enterprise/stats/:type" }, "listGlobalHooks": { "headers": { "accept": "application/vnd.github.superpro-preview+json" }, "method": "GET", "params": { "page": { "type": "integer" }, "per_page": { "type": "integer" } }, "url": "/admin/hooks" }, "listPersonalAccessTokens": { "method": "GET", "params": { "page": { "type": "integer" }, "per_page": { "type": "integer" } }, "url": "/admin/tokens" }, "listPreReceiveEnvironments": { "method": "GET", "params": { "page": { "type": "integer" }, "per_page": { "type": "integer" } }, "url": "/admin/pre-receive-environments" }, "listPreReceiveHooks": { "method": "GET", "params": { "page": { "type": "integer" }, "per_page": { "type": "integer" } }, "url": "/admin/pre-receive-hooks" }, "listPreReceiveHooksForOrg": { "method": "GET", "params": { "org": { "required": true, "type": "string" }, "page": { "type": "integer" }, "per_page": { "type": "integer" } }, "url": "/orgs/:org/pre-receive-hooks" }, "listPreReceiveHooksForRepo": { "method": "GET", "params": { "owner": { "required": true, "type": "string" }, "page": { "type": "integer" }, "per_page": { "type": "integer" }, "repo": { "required": true, "type": "string" } }, "url": "/repos/:owner/:repo/pre-receive-hooks" }, "modifySettings": { "method": "PUT", "params": { "settings": { "required": true, "type": "string" } }, "url": "/setup/api/settings" }, "pingGlobalHook": { "headers": { "accept": "application/vnd.github.superpro-preview+json" }, "method": "POST", "params": { "hook_id": { "required": true, "type": "integer" } }, "url": "/admin/hooks/:hook_id/pings" }, "promoteOrdinaryUserToSiteAdministrator": { "method": "PUT", "params": { "username": { "required": true, "type": "string" } }, "url": "/users/:username/site_admin" }, "queueIndexingJob": { "method": "POST", "params": { "target": { "required": true, "type": "string" } }, "url": "/staff/indexing_jobs" }, "removeAuthorizedSshKey": { "method": "DELETE", "params": { "authorized_key": { "required": true, "type": "string" } }, "url": "/setup/api/settings/authorized-keys" }, "removeEnforcementOverridesForPreReceiveHookForOrg": { "method": "DELETE", "params": { "org": { "required": true, "type": "string" }, "pre_receive_hook_id": { "required": true, "type": "integer" } }, "url": "/orgs/:org/pre-receive-hooks/:pre_receive_hook_id" }, "removeEnforcementOverridesForPreReceiveHookForRepo": { "method": "DELETE", "params": { "owner": { "required": true, "type": "string" }, "pre_receive_hook_id": { "required": true, "type": "integer" }, "repo": { "required": true, "type": "string" } }, "url": "/repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id" }, "renameOrg": { "method": "PATCH", "params": { "login": { "required": true, "type": "string" }, "org": { "required": true, "type": "string" } }, "url": "/admin/organizations/:org" }, "renameUser": { "method": "PATCH", "params": { "login": { "required": true, "type": "string" }, "username": { "required": true, "type": "string" } }, "url": "/admin/users/:username" }, "retrieveAuthorizedSshKeys": { "method": "GET", "params": {}, "url": "/setup/api/settings/authorized-keys" }, "retrieveSettings": { "method": "GET", "params": {}, "url": "/setup/api/settings" }, "startConfigurationProcess": { "method": "POST", "params": {}, "url": "/setup/api/configure" }, "suspendUser": { "method": "PUT", "params": { "reason": { "type": "string" }, "username": { "required": true, "type": "string" } }, "url": "/users/:username/suspended" }, "syncLdapMappingForTeam": { "method": "POST", "params": { "team_id": { "required": true, "type": "integer" } }, "url": "/admin/ldap/teams/:team_id/sync" }, "syncLdapMappingForUser": { "method": "POST", "params": { "username": { "required": true, "type": "string" } }, "url": "/admin/ldap/users/:username/sync" }, "triggerPreReceiveEnvironmentDownload": { "method": "POST", "params": { "pre_receive_environment_id": { "required": true, "type": "integer" } }, "url": "/admin/pre-receive-environments/:pre_receive_environment_id/downloads" }, "unsuspendUser": { "method": "DELETE", "params": { "reason": { "type": "string" }, "username": { "required": true, "type": "string" } }, "url": "/users/:username/suspended" }, "updateGlobalHook": { "headers": { "accept": "application/vnd.github.superpro-preview+json" }, "method": "PATCH", "params": { "active": { "type": "boolean" }, "config": { "type": "object" }, "config.content_type": { "type": "string" }, "config.insecure_ssl": { "type": "string" }, "config.secret": { "type": "string" }, "config.url": { "required": true, "type": "string" }, "events": { "type": "string[]" }, "hook_id": { "required": true, "type": "integer" } }, "url": "/admin/hooks/:hook_id" }, "updateLdapMappingForTeam": { "method": "PATCH", "params": { "ldap_dn": { "type": "string" }, "team_id": { "required": true, "type": "integer" } }, "url": "/admin/ldap/teams/:team_id/mapping" }, "updateLdapMappingForUser": { "method": "PATCH", "params": { "ldap_dn": { "type": "string" }, "username": { "required": true, "type": "string" } }, "url": "/admin/ldap/users/:username/mapping" }, "updatePreReceiveEnvironment": { "method": "PATCH", "params": { "image_url": { "type": "string" }, "name": { "type": "string" }, "pre_receive_environment_id": { "required": true, "type": "integer" } }, "url": "/admin/pre-receive-environments/:pre_receive_environment_id" }, "updatePreReceiveHook": { "method": "PATCH", "params": { "pre_receive_hook_id": { "required": true, "type": "integer" } }, "url": "/admin/pre_receive_hooks/:pre_receive_hook_id" }, "updatePreReceiveHookEnforcementForOrg": { "method": "PATCH", "params": { "org": { "required": true, "type": "string" }, "pre_receive_hook_id": { "required": true, "type": "integer" } }, "url": "/orgs/:org/pre-receive-hooks/:pre_receive_hook_id" }, "updatePreReceiveHookEnforcementForRepo": { "method": "PATCH", "params": { "owner": { "required": true, "type": "string" }, "pre_receive_hook_id": { "required": true, "type": "integer" }, "repo": { "required": true, "type": "string" } }, "url": "/repos/:owner/:repo/pre-receive-hooks/:pre_receive_hook_id" }, "upgradeLicense": { "method": "POST", "params": { "license": { "type": "string" } }, "url": "/setup/api/upgrade" }, "uploadLicenseForFirstTime": { "method": "POST", "params": { "license": { "required": true, "type": "string" }, "password": { "type": "string" }, "settings": { "type": "string" } }, "url": "/setup/api/start" } }, "gists": { "checkIsStarred": { "method": "GET", "params": { "gist_id": { "required": true, "type": "string" } }, "url": "/gists/:gist_id/star" }, "create": { "method": "POST", "params": { "description": { "type": "string" }, "files": { "required": true, "type": "object" }, "files.content": { "type": "string" }, "public": { "type": "boolean" } }, "url": "/gists" }, "createComment": { "method": "POST", "params": { "body": { "required": true, "type": "string" }, "gist_id": { "required": true, "type": "string" } }, "url": "/gists/:gist_id/comments" }, "delete": { "method": "DELETE", "params": { "gist_id": { "required": true, "type": "string" } }, "url": "/gists/:gist_id" }, "deleteComment": { "method": "DELETE", "params": { "comment_id": { "required": true, "type": "integer" }, "gist_id": { "required": true, "type": "string" } }, "url": "/gists/:gist_id/comments/:comment_id" }, "fork": { "method": "POST", "params": { "gist_id": { "required": true, "type": "string" } }, "url": "/gists/:gist_id/forks" }, "get": { "method": "GET", "params": { "gist_id": { "required": true, "type": "string" } }, "url": "/gists/:gist_id" }, "getComment": { "method": "GET", "params": { "comment_id": { "required": true, "type": "integer" }, "gist_id": { "required": true, "type": "string" } }, "url": "/gists/:gist_id/comments/:comment_id" }, "getRevision": { "method": "GET", "params": { "gist_id": { "required": true, "type": "string" }, "sha": { "required": true, "type": "string" } }, "url": "/gists/:gist_id/:sha" }, "list": { "method": "GET", "params": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "since": { "type": "string" } }, "url": "/gists" }, "listComments": { "method": "GET", "params": { "gist_id": { "required": true, "type": "string" }, "page": { "type": "integer" }, "per_page": { "type": "integer" } }, "url": "/gists/:gist_id/comments" }, "listCommits": { "method": "GET", "params": { "gist_id": { "required": true, "type": "string" }, "page": { "type": "integer" }, "per_page": { "type": "integer" } }, "url": "/gists/:gist_id/commits" }, "listForks": { "method": "GET", "params": { "gist_id": { "required": true, "type": "string" }, "page": { "type": "integer" }, "per_page": { "type": "integer" } }, "url": "/gists/:gist_id/forks" }, "listPublic": { "method": "GET", "params": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "since": { "type": "string" } }, "url": "/gists/public" }, "listPublicForUser": { "method": "GET", "params": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "since": { "type": "string" }, "username": { "required": true, "type": "string" } }, "url": "/users/:username/gists" }, "listStarred": { "method": "GET", "params": { "page": { "type": "integer" }, "per_page": { "type": "integer" }, "since": { "type": "string" } }, "url": "/gists/starred" }, "star": { "method": "PUT", "params": { "gist_id": { "required": true, "type": "string" } }, "url": "/gists/:gist_id/star" }, "unstar": { "method": "DELETE", "params": { "gist_id": { "required": true, "type": "string" } }, "url": "/gists/:gist_id/star" }, "update": { "method": "PATCH", "params": { "description": { "type": "string" }, "files": { "type": "object" }, "files.content": { "type": "string" }, "files.filename": { "type": "string" }, "gist_id": { "required": true, "type": "string" } }, "url": "/gists/:gist_id" }, "updateComment": { "method": "PATCH", "params": { "body": { "required": true, "type": "string" }, "comment_id": { "required": true, "type": "integer" }, "gist_id": { "required": true, "type": "string" } }, "url": "/gists/:gist_id/comments/:comment_id" } }, "git": { "createBlob": { "method": "POST", "params": { "content": { "required": true, "type": "string" }, "encoding": { "type": "string" }, "owner": { "required": true, "type": "string" }, "repo": { "required": true, "type": "string" } }, "url": "/repos/:owner/:repo/git/blobs" }, "createCommit": { "method": "POST", "params": { "author": { "type": "object" }, "author.date": { "type": "string" }, "author.email": { "type": "string" }, "author.name": { "type": "string" }, "committer": { "type": "object" }, "committer.date": { "type": "string" }, "committer.email": { "type": "string" }, "committer.name": { "type": "string" }, "message": { "required": true, "type": "string" }, "owner": { "required": true, "type": "string" }, "parents": { "required": true, "type": "string[]" }, "repo": { "required": true, "type": "string" }, "signature": { "type": "string" }, "tree": { "required": true, "type": "string" } }, "url": "/repos/:owner/:repo/git/commits" }, "createRef": { "method": "POST", "params": { "owner": { "required": true, "type": "string" }, "ref": { "required": true, "type": "string" }, "repo": { "required": true, "type": "string" }, "sha": { "required": true, "type": "string" } }, "url": "/repos/:owner/:repo/git/refs" }, "createTag": { "method": "POST", "params": { "message": { "required": true, "type": "string" }, "object": { "required": true, "type": "string" }, "owner": { "required": true, "type": "string" }, "repo": { "required": true, "type": "string" }, "tag": { "required": true, "type": "string" }, "tagger": { "type": "object" }, "tagger.date": { "type": "string" }, "tagger.email": { "type": "string" }, "tagger.name": { "type": "string" }, "type": { "enum": ["commit", "tree", "blob"], "required": true, "type": "string" } }, "url": "/repos/:owner/:repo/git/tags" }, "createTree": { "method": "POST", "params": { "base_tree": { "type": "string" }, "owner": { "required": true, "type": "string" }, "repo": { "required": true, "type": "string" }, "tree": { "required": true, "type": "object[]" }, "tree[].content": { "type": "string" }, "tree[].mode": { "enum": ["100644", "100755", "040000", "160000", "120000"], "type": "string" }, "tree[].path": { "type": "string" }, "tree[].sha": { "allowNull": true, "type": "string" }, "tree[].type": { "enum": ["blob", "tree", "commit"], "type": "string" } }, "url": "/repos/:owner/:repo/git/trees" }, "deleteRef": { "method": "DELETE", "params": { "owner": { "required": true, "type": "string" }, "ref": { "required": true, "type": "string" }, "repo": { "required": true, "type": "string" } }, "url": "/repos/:owner/:repo/git/refs/:ref" }, "getBlob": { "method": "GET", "params": { "file_sha": { "required": true, "type": "string" }, "owner": { "required": true, "type": "string" }, "repo": { "required": true, "type": "string" } }, "url": "/repos/:owner/:repo/git/blobs/:file_sha" }, "getCommit": { "method": "GET", "params": { "commit_sha": { "required": true, "type": "string" }, "owner": { "required": true, "type": "string" }, "repo": { "required": true, "type": "string" } }, "url": "/repos/:owner/:repo/git/commits/:commit_sha" }, "getRef": { "method": "GET", "params": { "owner": { "required": true, "type": "string" }, "ref": { "required": true, "type": "string" }, "repo": { "required": true, "type": "string" } }, "url": "/repos/:owner/:repo/git/refs/:ref" }, "getTag": { "method": "GET", "params": { "owner": { "required": true, "type": "string" }, "repo": { "required": true, "type": "string" }, "tag_sha": { "required": true, "type": "string" } }, "url": "/repos/:owner/:repo/git/tags/:tag_sha" }, "getTree": { "method": "GET", "params": { "owner": { "required": true, "type": "string" }, "recursive": { "enum": ["1"], "type": "integer" }, "repo": { "required": true, "type": "string" }, "tree_sha": { "required": true, "type": "string" } }, "url": "/repos/:owner/:repo/git/trees/:tree_sha" }, "listRefs": { "method": "GET", "params": { "namespace": { "type": "string" }, "owner": { "required": true, "type": "string" }, "page": { "type": "integer" }, "per_page": { "type": "integer" }, "repo": { "required": true, "type": "string" } }, "url": "/repos/:owner/:repo/git/refs/:namespace" }, "updateRef": { "method": "PATCH", "params": { "force": { "type": "boolean" }, "owner": { "required": true, "type": "string" }, "ref": { "required": true, "type": "string" }, "repo": { "required": true, "type": "string" }, "sha": { "required": true, "type": "string" } }, "url": "/repos/:owner/:repo/git/refs/:ref" } }, "gitignore": { "getTemplate": { "method": "GET", "params": { "name": { "required": true, "type": "string" } }, "url": "/gitignore/templates/:name" }, "listTemplates": { "method": "GET", "params": {}, "url": "/gitignore/templates" } }, "issues": { "addAssignees": { "met