Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
5927 lines (5927 sloc) 203 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"
},
"checkAccountIsAssociatedWithAny": {
"method": "GET",
"params": {
"account_id": { "required": true, "type": "integer" },
"page": { "type": "integer" },
"per_page": { "type": "integer" }
},
"url": "/marketplace_listing/accounts/:account_id"
},
"checkAccountIsAssociatedWithAnyStubbed": {
"method": "GET",
"params": {
"account_id": { "required": true, "type": "integer" },
"page": { "type": "integer" },
"per_page": { "type": "integer" }
},
"url": "/marketplace_listing/stubbed/accounts/:account_id"
},
"checkAuthorization": {
"deprecated": "octokit.oauthAuthorizations.checkAuthorization() has been renamed to octokit.apps.checkAuthorization() (2019-11-05)",
"method": "GET",
"params": {
"access_token": { "required": true, "type": "string" },
"client_id": { "required": true, "type": "string" }
},
"url": "/applications/:client_id/tokens/:access_token"
},
"checkToken": {
"headers": {
"accept": "application/vnd.github.doctor-strange-preview+json"
},
"method": "POST",
"params": {
"access_token": { "type": "string" },
"client_id": { "required": true, "type": "string" }
},
"url": "/applications/:client_id/token"
},
"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"
},
"deleteAuthorization": {
"headers": {
"accept": "application/vnd.github.doctor-strange-preview+json"
},
"method": "DELETE",
"params": {
"access_token": { "type": "string" },
"client_id": { "required": true, "type": "string" }
},
"url": "/applications/:client_id/grant"
},
"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"
},
"deleteToken": {
"headers": {
"accept": "application/vnd.github.doctor-strange-preview+json"
},
"method": "DELETE",
"params": {
"access_token": { "type": "string" },
"client_id": { "required": true, "type": "string" }
},
"url": "/applications/:client_id/token"
},
"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"
},
"listAccountsUserOrOrgOnPlan": {
"method": "GET",
"params": {
"direction": { "enum": ["asc", "desc"], "type": "string" },
"page": { "type": "integer" },
"per_page": { "type": "integer" },
"plan_id": { "required": true, "type": "integer" },
"sort": { "enum": ["created", "updated"], "type": "string" }
},
"url": "/marketplace_listing/plans/:plan_id/accounts"
},
"listAccountsUserOrOrgOnPlanStubbed": {
"method": "GET",
"params": {
"direction": { "enum": ["asc", "desc"], "type": "string" },
"page": { "type": "integer" },
"per_page": { "type": "integer" },
"plan_id": { "required": true, "type": "integer" },
"sort": { "enum": ["created", "updated"], "type": "string" }
},
"url": "/marketplace_listing/stubbed/plans/:plan_id/accounts"
},
"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"
},
"listMarketplacePurchasesForAuthenticatedUser": {
"method": "GET",
"params": {
"page": { "type": "integer" },
"per_page": { "type": "integer" }
},
"url": "/user/marketplace_purchases"
},
"listMarketplacePurchasesForAuthenticatedUserStubbed": {
"method": "GET",
"params": {
"page": { "type": "integer" },
"per_page": { "type": "integer" }
},
"url": "/user/marketplace_purchases/stubbed"
},
"listPlans": {
"method": "GET",
"params": {
"page": { "type": "integer" },
"per_page": { "type": "integer" }
},
"url": "/marketplace_listing/plans"
},
"listPlansStubbed": {
"method": "GET",
"params": {
"page": { "type": "integer" },
"per_page": { "type": "integer" }
},
"url": "/marketplace_listing/stubbed/plans"
},
"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"
},
"resetAuthorization": {
"deprecated": "octokit.oauthAuthorizations.resetAuthorization() has been renamed to octokit.apps.resetAuthorization() (2019-11-05)",
"method": "POST",
"params": {
"access_token": { "required": true, "type": "string" },
"client_id": { "required": true, "type": "string" }
},
"url": "/applications/:client_id/tokens/:access_token"
},
"resetToken": {
"headers": {
"accept": "application/vnd.github.doctor-strange-preview+json"
},
"method": "PATCH",
"params": {
"access_token": { "type": "string" },
"client_id": { "required": true, "type": "string" }
},
"url": "/applications/:client_id/token"
},
"revokeAuthorizationForApplication": {
"deprecated": "octokit.oauthAuthorizations.revokeAuthorizationForApplication() has been renamed to octokit.apps.revokeAuthorizationForApplication() (2019-11-05)",
"method": "DELETE",
"params": {
"access_token": { "required": true, "type": "string" },
"client_id": { "required": true, "type": "string" }
},
"url": "/applications/:client_id/tokens/:access_token"
},
"revokeGrantForApplication": {
"deprecated": "octokit.oauthAuthorizations.revokeGrantForApplication() has been renamed to octokit.apps.revokeGrantForApplication() (2019-11-05)",
"method": "DELETE",
"params": {
"access_token": { "required": true, "type": "string" },
"client_id": { "required": true, "type": "string" }
},
"url": "/applications/:client_id/grants/:access_token"
}
},
"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" } },
"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/ref/: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"
},
"listMatchingRefs": {
"method": "GET",
"params": {
"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/git/matching-refs/:ref"
},
"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"
}
},
"interactions": {
"addOrUpdateRestrictionsForOrg": {
"headers": { "accept": "application/vnd.github.sombra-preview+json" },
"method": "PUT",
"params": {
"limit": {
"enum": ["existing_users", "contributors_only", "collaborators_only"],
"required": true,
"type": "string"
},
"org": { "required": true, "type": "string" }
},
"url": "/orgs/:org/interaction-limits"
},
"addOrUpdateRestrictionsForRepo": {
"headers": { "accept": "application/vnd.github.sombra-preview+json" },
"method": "PUT",
"params": {
"limit": {
"enum": ["existing_users", "contributors_only", "collaborators_only"],
"required": true,
"type": "string"
},
"owner": { "required": true, "type": "string" },
"repo": { "required": true, "type": "string" }
},
"url": "/repos/:owner/:repo/interaction-limits"
},
"getRestrictionsForOrg": {
"headers": { "accept": "application/vnd.github.sombra-preview+json" },
"method": "GET",
"params": { "org": { "required": true, "type": "string" } },
"url": "/orgs/:org/interaction-limits"
},
"getRestrictionsForRepo": {
"headers": { "accept": "application/vnd.github.sombra-preview+json" },
"method": "GET",
"params": {
"owner": { "required": true, "type": "string" },
"repo": { "required": true, "type": "string" }
},
"url": "/repos/:owner/:repo/interaction-limits"
},
"removeRestrictionsForOrg": {
"headers": { "accept": "application/vnd.github.sombra-preview+json" },
"method": "DELETE",
"params": { "org": { "required": true, "type": "string" } },
"url": "/orgs/:org/interaction-limits"
},
"removeRestrictionsForRepo": {
"headers": { "accept": "application/vnd.github.sombra-preview+json" },
"method": "DELETE",
"params": {
"owner": { "required": true, "type": "string" },
"repo": { "required": true, "type": "string" }
},
"url": "/repos/:owner/:repo/interaction-limits"
}
},
"issues": {
"addAssignees": {
"method": "POST",
"params": {
"assignees": { "type": "string[]" },
"issue_number": { "required": true, "type": "integer" },
"number": {
"alias": "issue_number",
"deprecated": true,
"type": "integer"
},
"owner": { "required": true, "type": "string" },
"repo": { "required": true, "type": "string" }
},
"url": "/repos/:owner/:repo/issues/:issue_number/assignees"
},
"addLabels": {
"method": "POST",
"params": {
"issue_number": { "required": true, "type": "integer" },
"labels": { "required": true, "type": "string[]" },
"number": {
"alias": "issue_number",
"deprecated": true,
"type": "integer"
},
"owner": { "required": true, "type": "string" },
"repo": { "required": true, "type": "string" }
},
"url": "/repos/:owner/:repo/issues/:issue_number/labels"
},
"checkAssignee": {
"method": "GET",
"params": {
"assignee": { "required": true, "type": "string" },
"owner": { "required": true, "type": "string" },
"repo": { "required": true, "type": "string" }
},
"url": "/repos/:owner/:repo/assignees/:assignee"
},
"create": {
"method": "POST",
"params": {
"assignee": { "type": "string" },
"assignees": { "type": "string[]" },
"body": { "type": "string" },
"labels": { "type": "string[]" },
"milestone": { "type": "integer" },
"owner": { "required": true, "type": "string" },
"repo": { "required": true, "type": "string" },
"title": { "required": true, "type": "string" }
},
"url": "/repos/:owner/:repo/issues"
},
"createComment": {
"method": "POST",
"params": {
"body": { "required": true, "type": "string" },
"issue_number": { "required": true, "type": "integer" },
"number": {
"alias": "issue_number",
"deprecated": true,
"type": "integer"
},
"owner": { "required": true, "type": "string" },
"repo": { "required": true, "type": "string" }
},
"url": "/repos/:owner/:repo/issues/:issue_number/comments"
},
"createLabel": {
"method": "POST",
"params": {
"color": { "required": true, "type": "string" },
"description": { "type": "string" },
"name": { "required": true, "type": "string" },
"owner": { "required": true, "type": "string" },
"repo": { "required": true, "type": "string" }
},
"url": "/repos/:owner/:repo/labels"
},
"createMilestone": {
"method": "POST",
"params": {
"description": { "type": "string" },
"due_on": { "type": "string" },
"owner": { "required": true, "type": "string" },
"repo": { "required": true, "type": "string" },
"state": { "enum": ["open", "closed"], "type": "string" },
"title": { "required": true, "type": "string" }
},
"url": "/repos/:owner/:repo/milestones"
},
"deleteComment": {
"method": "DELETE",
"params": {
"comment_id": { "required": true, "type": "integer" },
"owner": { "required": true, "type": "string" },
"repo": { "required": true, "type": "string" }
},
"url": "/repos/:owner/:repo/issues/comments/:comment_id"
},
"deleteLabel": {
"method": "DELETE",
"params": {
"name": { "required": true, "type": "string" },
"owner": { "required": true, "type": "string" },
"repo": { "required": true, "type": "string" }
},
"url": "/repos/:owner/:repo/labels/:name"
},
"deleteMilestone": {
"method": "DELETE",
"params": {
"milestone_number": { "required": true, "type": "integer" },
"number": {
"alias": "milestone_number",
"deprecated": true,
"type": "integer"
},
"owner": { "required": true, "type": "string" },
"repo": { "required": true, "type": "string" }
},
"url": "/repos/:owner/:repo/milestones/:milestone_number"
},
"get": {
"method": "GET",
"params": {
"issue_number": { "required": true, "type": "integer" },
"number": {
"alias": "issue_number",
"deprecated": true,
"type": "integer"
},
"owner": { "required": true, "type": "string" },
"repo": { "required": true, "type": "string" }
},
"url": "/repos/:owner/:repo/issues/:issue_number"
},
"getComment": {
"method": "GET",
"params": {
"comment_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/issues/comments/:comment_id"
},
"getEvent": {
"method": "GET",
"params": {
"event_id": { "required": true, "type": "integer" },
"owner": { "required": true, "type": "string" },
"repo": { "required": true, "type": "string" }
},
"url": "/repos/:owner/:repo/issues/events/:event_id"
},
"getLabel": {
"method": "GET",
"params": {
"name": { "required": true, "type": "string" },
"owner": { "required": true, "type": "string" },
"repo": { "required": true, "type": "string" }
},
"url": "/repos/:owner/:repo/labels/:name"
},
"getMilestone": {
"method": "GET",
"params": {
"milestone_number": { "required": true, "type": "integer" },
"number": {
"alias": "milestone_number",
"deprecated": true,
"type": "integer"
},
"owner": { "required": true, "type": "string" },
"repo": { "required": true, "type": "string" }
},
"url": "/repos/:owner/:repo/milestones/:milestone_number"
},
"list": {
"method": "GET",
"params": {
"direction": { "enum": ["asc", "desc"], "type": "string" },
"filter": {
"enum": ["assigned", "created", "mentioned", "subscribed", "all"],
"type": "string"
},
"labels": { "type": "string" },
"page": { "type": "integer" },
"per_page": { "type": "integer" },
"since": { "type": "string" },
"sort": {
"enum": ["created", "updated", "comments"],
"type": "string"
},
"state": { "enum": ["open", "closed", "all"], "type": "string" }
},
"url": "/issues"
},
"listAssignees": {
"method": "GET",
"params": {
"owner": { "required": true, "type": "string" },
"page": { "type": "integer" },
"per_page": { "type": "integer" },
"repo": { "required": true, "type": "string" }
},
"url": "/repos/:owner/:repo/assignees"
},
"listComments": {
"method": "GET",
"params": {
"issue_number": { "required": true, "type": "integer" },
"number": {
"alias": "issue_number",
"deprecated": true,
"type": "integer"
},
"owner": { "required": true, "type": "string" },
"page": { "type": "integer" },
"per_page": { "type": "integer" },
"repo": { "required": true, "type": "string" },
"since": { "type": "string" }
},
"url": "/repos/:owner/:repo/issues/:issue_number/comments"
},
"listCommentsForRepo": {
"method": "GET",
"params": {
"direction": { "enum": ["asc", "desc"], "type": "string" },
"owner": { "required": true, "type": "string" },
"repo": { "required": true, "type": "string" },
"since": { "type": "string" },
"sort": { "enum": ["created", "updated"], "type": "string" }
},
"url": "/repos/:owner/:repo/issues/comments"
},
"listEvents": {
"method": "GET",
"params": {
"issue_number": { "required": true, "type": "integer" },
"number": {
"alias": "issue_number",
"deprecated": true,
"type": "integer"
},
"owner": { "required": true, "type": "string" },
"page": { "type": "integer" },
"per_page": { "type": "integer" },
"repo": { "required": true, "type": "string" }
},
"url": "/repos/:owner/:repo/issues/:issue_number/events"
},
"listEventsForRepo": {
"method": "GET",
"params": {
"owner": { "required": true, "type": "string" },
"page": { "type": "integer" },
"per_page": { "type": "integer" },
"repo": { "required": true, "type": "string" }
},
"url": "/repos/:owner/:repo/issues/events"
},
"listEventsForTimeline": {
"headers": {
"accept": "application/vnd.github.mockingbird-preview+json"
},
"method": "GET",
"params": {
"issue_number": { "required": true, "type": "integer" },
"number": {
"alias": "issue_number",
"deprecated": true,
"type": "integer"
},
"owner": { "required": true, "type": "string" },
"page": { "type": "integer" },
"per_page": { "type": "integer" },
"repo": { "required": true, "type": "string" }
},
"url": "/repos/:owner/:repo/issues/:issue_number/timeline"
},
"listForAuthenticatedUser": {
"method": "GET",
"params": {
"direction": { "enum": ["asc", "desc"], "type": "string" },
"filter": {
"enum": ["assigned", "created", "mentioned", "subscribed", "all"],
"type": "string"
},
"labels": { "type": "string" },
"page": { "type": "integer" },
"per_page": { "type": "integer" },
"since": { "type": "string" },
"sort": {
"enum": ["created", "updated", "comments"],
"type": "string"
},
"state": { "enum": ["open", "closed", "all"], "type": "string" }
},
"url": "/user/issues"
},
"listForOrg": {
"method": "GET",
"params": {
"direction": { "enum": ["asc", "desc"], "type": "string" },
"filter": {
"enum": ["assigned", "created", "mentioned", "subscribed", "all"],
"type": "string"
},
"labels": { "type": "string" },
"org": { "required": true, "type": "string" },
"page": { "type": "integer" },
"per_page": { "type": "integer" },
"since": { "type": "string" },
"sort": {
"enum": ["created", "updated", "comments"],
"type": "string"
},
"state": { "enum": ["open", "closed", "all"], "type": "string" }
},
"url": "/orgs/:org/issues"
},
"listForRepo": {
"method": "GET",
"params": {
"assignee": { "type": "string" },
"creator": { "type": "string" },
"direction": { "enum": ["asc", "desc"], "type": "string" },
"labels": { "type": "string" },
"mentioned": { "type": "string" },
"milestone": { "type": "string" },
"owner": { "required": true, "type": "string" },
"page": { "type": "integer" },
"per_page": { "type": "integer" },
"repo": { "required": true, "type": "string" },
"since": { "type": "string" },
"sort": {
"enum": ["created", "updated", "comments"],
"type": "string"
},
"state": { "enum": ["open", "closed", "all"], "type": "string" }
},
"url": "/repos/:owner/:repo/issues"
},
"listLabelsForMilestone": {
"method": "GET",
"params": {
"milestone_number": { "required": true, "type": "integer" },
"number": {
"alias": "milestone_number",
"deprecated": true,
"type": "integer"
},
"owner": { "required": true, "type": "string" },
"page": { "type": "integer" },
"per_page": { "type": "integer" },
"repo": { "required": true, "type": "string" }
},
"url": "/repos/:owner/:repo/milestones/:milestone_number/labels"
},
"listLabelsForRepo": {
"method": "GET",
"params": {
"owner": { "required": true, "type": "string" },
"page": { "type": "integer" },
"per_page": { "type": "integer" },
"repo": { "required": true, "type": "string" }
},
"url": "/repos/:owner/:repo/labels"
},
"listLabelsOnIssue": {
"method": "GET",
"params": {
"issue_number": { "required": true, "type": "integer" },
"number": {
"alias": "issue_number",
"deprecated": true,
"type": "integer"
},
"owner": { "required": true, "type": "string" },
"page": { "type": "integer" },
"per_page": { "type": "integer" },
"repo": { "required": true, "type": "string" }
},
"url": "/repos/:owner/:repo/issues/:issue_number/labels"
},
"listMilestonesForRepo": {
"method": "GET",
"params": {
"direction": { "enum": ["asc", "desc"], "type": "string" },
"owner": { "required": true, "type": "string" },
"page": { "type": "integer" },
"per_page": { "type": "integer" },
"repo": { "required": true, "type": "string" },
"sort": { "enum": ["due_on", "completeness"], "type": "string" },
"state": { "enum": ["open", "closed", "all"], "type": "string" }
},
"url": "/repos/:owner/:repo/milestones"
},
"lock": {
"method": "PUT",
"params": {
"issue_number": { "required": true, "type": "integer" },
"lock_reason": {
"enum": ["off-topic", "too heated", "resolved", "spam"],
"type": "string"
},
"number": {
"alias": "issue_number",
"deprecated": true,
"type": "integer"
},
"owner": { "required": true, "type": "string" },
"repo": { "required": true, "type": "string" }
},
"url": "/repos/:owner/:repo/issues/:issue_number/lock"
},
"removeAssignees": {
"method": "DELETE",
"params": {
"assignees": { "type": "string[]" },
"issue_number": { "required": true, "type": "integer" },
"number": {
"alias": "issue_number",
"deprecated": true,
"type": "integer"
},
"owner": { "required": true, "type": "string" },
"repo": { "required": true, "type": "string" }
},
"url": "/repos/:owner/:repo/issues/:issue_number/assignees"
},
"removeLabel": {
"method": "DELETE",
"params": {
"issue_number": { "required": true, "type": "integer" },
"name": { "required": true, "type": "string" },
"number": {
"alias": "issue_number",
"deprecated": true,
"type": "integer"
},
"owner": { "required": true, "type": "string" },
"repo": { "required": true, "type": "string" }
},
"url": "/repos/:owner/:repo/issues/:issue_number/labels/:name"
},
"removeLabels": {
"method": "DELETE",
"params": {
"issue_number": { "required": true, "type": "integer" },
"number": {
"alias": "issue_number",
"deprecated": true,
"type": "integer"
},
"owner": { "required": true, "type": "string" },
"repo": { "required": true, "type": "string" }
},
"url": "/repos/:owner/:repo/issues/:issue_number/labels"
},
"replaceLabels": {
"method": "PUT",
"params": {
"issue_number": { "required": true, "type": "integer" },
"labels": { "type": "string[]" },
"number": {
"alias": "issue_number",
"deprecated": true,
"type": "integer"
},
"owner": { "required": true, "type": "string" },
"repo": { "required": true, "type": "string" }
},
"url": "/repos/:owner/:repo/issues/:issue_number/labels"
},
"unlock": {
"method": "DELETE",
"params": {
"issue_number": { "required": true, "type": "integer" },
"number": {
"alias": "issue_number",
"deprecated": true,
"type": "integer"
},
"owner": { "required": true, "type": "string" },
"repo": { "required": true, "type": "string" }
},
"url": "/repos/:owner/:repo/issues/:issue_number/lock"
},
"update": {
"method": "PATCH",
"params": {
"assignee": { "type": "string" },
"assignees": { "type": "string[]" },
"body": { "type": "string" },
"issue_number": { "required": true, "type": "integer" },
"labels": { "type": "string[]" },
"milestone": { "allowNull": true, "type": "integer" },
"number": {
"alias": "issue_number",
"deprecated": true,
"type": "integer"
},
"owner": { "required": true, "type": "string" },
"repo": { "required": true, "type": "string" },
"state": { "enum": ["open", "closed"], "type": "string" },
"title": { "type": "string" }
},
"url": "/repos/:owner/:repo/issues/:issue_number"
},
"updateComment": {
"method": "PATCH",
"params": {
"body": { "required": true, "type": "string" },
"comment_id": { "required": true, "type": "integer" },
"owner": { "required": true, "type": "string" },
"repo": { "required": true, "type": "string" }
},
"url": "/repos/:owner/:repo/issues/comments/:comment_id"
},
"updateLabel": {
"method": "PATCH",
"params": {
"color": { "type": "string" },
"current_name": { "required": true, "type": "string" },
"description": { "type": "string" },
"name": { "type": "string" },
"owner": { "required": true, "type": "string" },
"repo": { "required": true, "type": "string" }
},
"url": "/repos/:owner/:repo/labels/:current_name"
},
"updateMilestone": {
"method": "PATCH",
"params": {
"description": { "type": "string" },
"due_on": { "type": "string" },
"milestone_number": { "required": true, "type": "integer" },
"number": {
"alias": "milestone_number",
"deprecated": true,
"type": "integer"
},
"owner": { "required": true, "type": "string" },
"repo": { "required": true, "type": "string" },
"state": { "enum": ["open", "closed"], "type": "string" },
"title": { "type": "string" }
},
"url": "/repos/:owner/:repo/milestones/:milestone_number"
}
},
"licenses": {
"get": {
"method": "GET",
"params": { "license": { "required": true, "type": "string" } },
"url": "/licenses/:license"
},
"getForRepo": {
"method": "GET",
"params": {
"owner": { "required": true, "type": "string" },
"repo": { "required": true, "type": "string" }
},
"url": "/repos/:owner/:repo/license"
},
"list": {
"deprecated": "octokit.licenses.list() has been renamed to octokit.licenses.listCommonlyUsed() (2019-03-05)",
"method": "GET",
"params": {},
"url": "/licenses"
},
"listCommonlyUsed": { "method": "GET", "params": {}, "url": "/licenses" }
},
"markdown": {
"render": {
"method": "POST",
"params": {
"context": { "type": "string" },
"mode": { "enum": ["markdown", "gfm"], "type": "string" },
"text": { "required": true, "type": "string" }
},
"url": "/markdown"
},
"renderRaw": {
"headers": { "content-type": "text/plain; charset=utf-8" },
"method": "POST",
"params": {
"data": { "mapTo": "data", "required": true, "type": "string" }
},
"url": "/markdown/raw"
}
},
"meta": { "get": { "method": "GET", "params": {}, "url": "/meta" } },
"migrations": {
"cancelImport": {
"headers": {
"accept": "application/vnd.github.barred-rock-preview+json"
},
"method": "DELETE",
"params": {
"owner": { "required": true, "type": "string" },
"repo": { "required": true, "type": "string" }
},
"url": "/repos/:owner/:repo/import"
},
"deleteArchiveForAuthenticatedUser": {
"headers": { "accept": "application/vnd.github.wyandotte-preview+json" },
"method": "DELETE",
"params": { "migration_id": { "required": true, "type": "integer" } },
"url": "/user/migrations/:migration_id/archive"
},
"deleteArchiveForOrg": {
"headers": { "accept": "application/vnd.github.wyandotte-preview+json" },
"method": "DELETE",
"params": {
"migration_id": { "required": true, "type": "integer" },
"org": { "required": true, "type": "string" }
},
"url": "/orgs/:org/migrations/:migration_id/archive"
},
"getArchiveForAuthenticatedUser": {
"headers": { "accept": "application/vnd.github.wyandotte-preview+json" },
"method": "GET",
"params": { "migration_id": { "required": true, "type": "integer" } },
"url": "/user/migrations/:migration_id/archive"
},
"getArchiveForOrg": {
"headers": { "accept": "application/vnd.github.wyandotte-preview+json" },
"method": "GET",
"params": {
"migration_id": { "required": true, "type": "integer" },
"org": { "required": true, "type": "string" }
},
"url": "/orgs/:org/migrations/:migration_id/archive"
},
"getCommitAuthors": {
"headers": {
"accept": "application/vnd.github.barred-rock-preview+json"
},
"method": "GET",
"params": {
"owner": { "required": true, "type": "string" },
"repo": { "required": true, "type": "string" },
"since": { "type": "string" }
},
"url": "/repos/:owner/:repo/import/authors"
},
"getImportProgress": {
"headers": {
"accept": "application/vnd.github.barred-rock-preview+json"
},
"method": "GET",
"params": {
"owner": { "required": true, "type": "string" },
"repo": { "required": true, "type": "string" }
},
"url": "/repos/:owner/:repo/import"
},
"getLargeFiles": {
"headers": {
"accept": "application/vnd.github.barred-rock-preview+json"
},
"method": "GET",
"params": {
"owner": { "required": true, "type": "string" },
"repo": { "required": true, "type": "string" }
},
"url": "/repos/:owner/:repo/import/large_files"
},
"getStatusForAuthenticatedUser": {
"headers": { "accept": "application/vnd.github.wyandotte-preview+json" },
"method": "GET",
"params": { "migration_id": { "required": true, "type": "integer" } },
"url": "/user/migrations/:migration_id"
},
"getStatusForOrg": {
"headers": { "accept": "application/vnd.github.wyandotte-preview+json" },
"method": "GET",
"params": {
"migration_id": { "required": true, "type": "integer" },
"org": { "required": true, "type": "string" }
},
"url": "/orgs/:org/migrations/:migration_id"
},
"listForAuthenticatedUser": {
"headers": { "accept": "application/vnd.github.wyandotte-preview+json" },
"method": "GET",
"params": {
"page": { "type": "integer" },
"per_page": { "type": "integer" }
},
"url": "/user/migrations"
},
"listForOrg": {
"headers": { "accept": "application/vnd.github.wyandotte-preview+json" },
"method": "GET",
"params": {
"org": { "required": true, "type": "string" },
"page": { "type": "integer" },
"per_page": { "type": "integer" }
},
"url": "/orgs/:org/migrations"
},
"mapCommitAuthor": {
"headers": {
"accept": "application/vnd.github.barred-rock-preview+json"
},
"method": "PATCH",
"params": {
"author_id": { "required": true, "type": "integer" },
"email": { "type": "string" },
"name": { "type": "string" },
"owner": { "required": true, "type": "string" },
"repo": { "required": true, "type": "string" }
},
"url": "/repos/:owner/:repo/import/authors/:author_id"
},
"setLfsPreference": {
"headers": {
"accept": "application/vnd.github.barred-rock-preview+json"
},
"method": "PATCH",
"params": {
"owner": { "required": true, "type": "string" },
"repo": { "required": true, "type": "string" },
"use_lfs": {
"enum": ["opt_in", "opt_out"],
"required": true,
"type": "string"
}
},
"url": "/repos/:owner/:repo/import/lfs"
},
"startForAuthenticatedUser": {
"method": "POST",
"params": {
"exclude_attachments": { "type": "boolean" },
"lock_repositories": { "type": "boolean" },
"repositories": { "required": true, "type": "string[]" }
},
"url": "/user/migrations"
},
"startForOrg": {
"method": "POST",
"params": {
"exclude_attachments": { "type": "boolean" },
"lock_repositories": { "type": "boolean" },
"org": { "required": true, "type": "string" },
"repositories": { "required": true, "type": "string[]" }
},
"url": "/orgs/:org/migrations"
},
"startImport": {
"headers": {
"accept": "application/vnd.github.barred-rock-preview+json"
},
"method": "PUT",
"params": {
"owner": { "required": true, "type": "string" },
"repo": { "required": true, "type": "string" },
"tfvc_project": { "type": "string" },
"vcs": {
"enum": ["subversion", "git", "mercurial", "tfvc"],
"type": "string"
},
"vcs_password": { "type": "string" },
"vcs_url": { "required": true, "type": "string" },
"vcs_username": { "type": "string" }
},
"url": "/repos/:owner/:repo/import"
},
"unlockRepoForAuthenticatedUser": {
"headers": { "accept": "application/vnd.github.wyandotte-preview+json" },
"method": "DELETE",
"params": {
"migration_id": { "required": true, "type": "integer" },
"repo_name": { "required": true, "type": "string" }
},
"url": "/user/migrations/:migration_id/repos/:repo_name/lock"
},
"unlockRepoForOrg": {
"headers": { "accept": "application/vnd.github.wyandotte-preview+json" },
"method": "DELETE",
"params": {
"migration_id": { "required": true, "type": "integer" },
"org": { "required": true, "type": "string" },
"repo_name": { "required": true, "type": "string" }
},
"url": "/orgs/:org/migrations/:migration_id/repos/:repo_name/lock"
},
"updateImport": {
"headers": {
"accept": "application/vnd.github.barred-rock-preview+json"
},
"method": "PATCH",
"params": {
"owner": { "required": true, "type": "string" },
"repo": { "required": true, "type": "string" },
"vcs_password": { "type": "string" },
"vcs_username": { "type": "string" }
},
"url": "/repos/:owner/:repo/import"
}
},
"oauthAuthorizations": {
"checkAuthorization": {
"deprecated": "octokit.oauthAuthorizations.checkAuthorization() has been renamed to octokit.apps.checkAuthorization() (2019-11-05)",
"method": "GET",
"params": {
"access_token": { "required": true, "type": "string" },
"client_id": { "required": true, "type": "string" }
},
"url": "/applications/:client_id/tokens/:access_token"
},
"createAuthorization": {
"deprecated": "octokit.oauthAuthorizations.createAuthorization() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization",
"method": "POST",
"params": {
"client_id": { "type": "string" },
"client_secret": { "type": "string" },
"fingerprint": { "type": "string" },
"note": { "required": true, "type": "string" },
"note_url": { "type": "string" },
"scopes": { "type": "string[]" }
},
"url": "/authorizations"
},
"deleteAuthorization": {
"deprecated": "octokit.oauthAuthorizations.deleteAuthorization() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#delete-an-authorization",
"method": "DELETE",
"params": { "authorization_id": { "required": true, "type": "integer" } },
"url": "/authorizations/:authorization_id"
},
"deleteGrant": {
"deprecated": "octokit.oauthAuthorizations.deleteGrant() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#delete-a-grant",
"method": "DELETE",
"params": { "grant_id": { "required": true, "type": "integer" } },
"url": "/applications/grants/:grant_id"
},
"getAuthorization": {
"deprecated": "octokit.oauthAuthorizations.getAuthorization() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#get-a-single-authorization",
"method": "GET",
"params": { "authorization_id": { "required": true, "type": "integer" } },
"url": "/authorizations/:authorization_id"
},
"getGrant": {
"deprecated": "octokit.oauthAuthorizations.getGrant() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#get-a-single-grant",
"method": "GET",
"params": { "grant_id": { "required": true, "type": "integer" } },
"url": "/applications/grants/:grant_id"
},
"getOrCreateAuthorizationForApp": {
"deprecated": "octokit.oauthAuthorizations.getOrCreateAuthorizationForApp() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app",
"method": "PUT",
"params": {
"client_id": { "required": true, "type": "string" },
"client_secret": { "required": true, "type": "string" },
"fingerprint": { "type": "string" },
"note": { "type": "string" },
"note_url": { "type": "string" },
"scopes": { "type": "string[]" }
},
"url": "/authorizations/clients/:client_id"
},
"getOrCreateAuthorizationForAppAndFingerprint": {
"deprecated": "octokit.oauthAuthorizations.getOrCreateAuthorizationForAppAndFingerprint() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint",
"method": "PUT",
"params": {
"client_id": { "required": true, "type": "string" },
"client_secret": { "required": true, "type": "string" },
"fingerprint": { "required": true, "type": "string" },
"note": { "type": "string" },
"note_url": { "type": "string" },
"scopes": { "type": "string[]" }
},
"url": "/authorizations/clients/:client_id/:fingerprint"
},
"getOrCreateAuthorizationForAppFingerprint": {
"deprecated": "octokit.oauthAuthorizations.getOrCreateAuthorizationForAppFingerprint() has been renamed to octokit.oauthAuthorizations.getOrCreateAuthorizationForAppAndFingerprint() (2018-12-27)",
"method": "PUT",
"params": {
"client_id": { "required": true, "type": "string" },
"client_secret": { "required": true, "type": "string" },
"fingerprint": { "required": true, "type": "string" },
"note": { "type": "string" },
"note_url": { "type": "string" },
"scopes": { "type": "string[]" }
},
"url": "/authorizations/clients/:client_id/:fingerprint"
},
"listAuthorizations": {
"deprecated": "octokit.oauthAuthorizations.listAuthorizations() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#list-your-authorizations",
"method": "GET",
"params": {
"page": { "type": "integer" },
"per_page": { "type": "integer" }
},
"url": "/authorizations"
},
"listGrants": {
"deprecated": "octokit.oauthAuthorizations.listGrants() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#list-your-grants",
"method": "GET",
"params": {
"page": { "type": "integer" },
"per_page": { "type": "integer" }
},
"url": "/applications/grants"
},
"resetAuthorization": {
"deprecated": "octokit.oauthAuthorizations.resetAuthorization() has been renamed to octokit.apps.resetAuthorization() (2019-11-05)",
"method": "POST",
"params": {
"access_token": { "required": true, "type": "string" },
"client_id": { "required": true, "type": "string" }
},
"url": "/applications/:client_id/tokens/:access_token"
},
"revokeAuthorizationForApplication": {
"deprecated": "octokit.oauthAuthorizations.revokeAuthorizationForApplication() has been renamed to octokit.apps.revokeAuthorizationForApplication() (2019-11-05)",
"method": "DELETE",
"params": {
"access_token": { "required": true, "type": "string" },
"client_id": { "required": true, "type": "string" }
},
"url": "/applications/:client_id/tokens/:access_token"
},
"revokeGrantForApplication": {
"deprecated": "octokit.oauthAuthorizations.revokeGrantForApplication() has been renamed to octokit.apps.revokeGrantForApplication() (2019-11-05)",
"method": "DELETE",
"params": {
"access_token": { "required": true, "type": "string" },
"client_id": { "required": true, "type": "string" }
},
"url": "/applications/:client_id/grants/:access_token"
},
"updateAuthorization": {
"deprecated": "octokit.oauthAuthorizations.updateAuthorization() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#update-an-existing-authorization",
"method": "PATCH",
"params": {
"add_scopes": { "type": "string[]" },
"authorization_id": { "required": true, "type": "integer" },
"fingerprint": { "type": "string" },
"note": { "type": "string" },
"note_url": { "type": "string" },
"remove_scopes": { "type": "string[]" },
"scopes": { "type": "string[]" }
},
"url": "/authorizations/:authorization_id"
}
},
"orgs": {
"addOrUpdateMembership": {
"method": "PUT",
"params": {
"org": { "required": true, "type": "string" },
"role": { "enum": ["admin", "member"], "type": "string" },
"username": { "required": true, "type": "string" }
},
"url": "/orgs/:org/memberships/:username"
},
"blockUser": {
"method": "PUT",
"params": {
"org": { "required": true, "type": "string" },
"username": { "required": true, "type": "string" }
},
"url": "/orgs/:org/blocks/:username"
},
"checkBlockedUser": {
"method": "GET",
"params": {
"org": { "required": true, "type": "string" },
"username": { "required": true, "type": "string" }
},
"url": "/orgs/:org/blocks/:username"
},
"checkMembership": {
"method": "GET",
"params": {
"org": { "required": true, "type": "string" },
"username": { "required": true, "type": "string" }
},
"url": "/orgs/:org/members/:username"
},
"checkPublicMembership": {
"method": "GET",
"params": {
"org": { "required": true, "type": "string" },
"username": { "required": true, "type": "string" }
},
"url": "/orgs/:org/public_members/:username"
},
"concealMembership": {
"method": "DELETE",
"params": {
"org": { "required": true, "type": "string" },
"username": { "required": true, "type": "string" }
},
"url": "/orgs/:org/public_members/:username"
},
"convertMemberToOutsideCollaborator": {
"method": "PUT",
"params": {
"org": { "required": true, "type": "string" },
"username": { "required": true, "type": "string" }
},
"url": "/orgs/:org/outside_collaborators/:username"
},
"createHook": {
"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" },
"org": { "required": true, "type": "string" }
},
"url": "/orgs/:org/hooks"
},
"createInvitation": {
"method": "POST",
"params": {
"email": { "type": "string" },
"invitee_id": { "type": "integer" },
"org": { "required": true, "type": "string" },
"role": {
"enum": ["admin", "direct_member", "billing_manager"],
"type": "string"
},
"team_ids": { "type": "integer[]" }
},
"url": "/orgs/:org/invitations"
},
"deleteHook": {
"method": "DELETE",
"params": {
"hook_id": { "required": true, "type": "integer" },
"org": { "required": true, "type": "string" }
},
"url": "/orgs/:org/hooks/:hook_id"
},
"get": {
"method": "GET",
"params": { "org": { "required": true, "type": "string" } },
"url": "/orgs/:org"
},
"getHook": {
"method": "GET",
"params": {
"hook_id": { "required": true, "type": "integer" },
"org": { "required": true, "type": "string" }
},
"url": "/orgs/:org/hooks/:hook_id"
},
"getMembership": {
"method": "GET",
"params": {
"org": { "required": true, "type": "string" },
"username": { "required": true, "type": "string" }
},
"url": "/orgs/:org/memberships/:username"
},
"getMembershipForAuthenticatedUser": {
"method": "GET",
"params": { "org": { "required": true, "type": "string" } },
"url": "/user/memberships/orgs/:org"
},
"list": {
"method": "GET",
"params": {
"page": { "type": "integer" },
"per_page": { "type": "integer" },
"since": { "type": "string" }
},
"url": "/organizations"
},
"listBlockedUsers": {
"method": "GET",
"params": { "org": { "required": true, "type": "string" } },
"url": "/orgs/:org/blocks"
},
"listForAuthenticatedUser": {
"method": "GET",
"params": {
"page": { "type": "integer" },
"per_page": { "type": "integer" }
},
"url": "/user/orgs"
},
"listForUser": {
"method": "GET",
"params": {
"page": { "type": "integer" },
"per_page": { "type": "integer" },
"username": { "required": true, "type": "string" }
},
"url": "/users/:username/orgs"
},
"listHooks": {
"method": "GET",
"params": {
"org": { "required": true, "type": "string" },
"page": { "type": "integer" },
"per_page": { "type": "integer" }
},
"url": "/orgs/:org/hooks"
},
"listInstallations": {
"headers": {
"accept": "application/vnd.github.machine-man-preview+json"
},
"method": "GET",
"params": {
"org": { "required": true, "type": "string" },
"page": { "type": "integer" },
"per_page": { "type": "integer" }
},
"url": "/orgs/:org/installations"
},
"listInvitationTeams": {
"method": "GET",
"params": {
"invitation_id": { "required": true, "type": "integer" },
"org": { "required": true, "type": "string" },
"page": { "type": "integer" },
"per_page": { "type": "integer" }
},
"url": "/orgs/:org/invitations/:invitation_id/teams"
},
"listMembers": {
"method": "GET",
"params": {
"filter": { "enum": ["2fa_disabled", "all"], "type": "string" },
"org": { "required": true, "type": "string" },
"page": { "type": "integer" },
"per_page": { "type": "integer" },
"role": { "enum": ["all", "admin", "member"], "type": "string" }
},
"url": "/orgs/:org/members"
},
"listMemberships": {
"method": "GET",
"params": {
"page": { "type": "integer" },
"per_page": { "type": "integer" },
"state": { "enum": ["active", "pending"], "type": "string" }
},
"url": "/user/memberships/orgs"
},
"listOutsideCollaborators": {
"method": "GET",
"params": {
"filter": { "enum": ["2fa_disabled", "all"], "type": "string" },
"org": { "required": true, "type": "string" },
"page": { "type": "integer" },
"per_page": { "type": "integer" }
},
"url": "/orgs/:org/outside_collaborators"
},
"listPendingInvitations": {
"method": "GET",
"params": {
"org": { "required": true, "type": "string" },
"page": { "type": "integer" },
"per_page": { "type": "integer" }
},
"url": "/orgs/:org/invitations"
},
"listPublicMembers": {
"method": "GET",
"params": {
"org": { "required": true, "type": "string" },
"page": { "type": "integer" },
"per_page": { "type": "integer" }
},
"url": "/orgs/:org/public_members"
},
"pingHook": {
"method": "POST",
"params": {
"hook_id": { "required": true, "type": "integer" },
"org": { "required": true, "type": "string" }
},
"url": "/orgs/:org/hooks/:hook_id/pings"
},
"publicizeMembership": {
"method": "PUT",
"params": {
"org": { "required": true, "type": "string" },
"username": { "required": true, "type": "string" }
},
"url": "/orgs/:org/public_members/:username"
},
"removeMember": {
"method": "DELETE",
"params": {
"org": { "required": true, "type": "string" },
"username": { "required": true, "type": "string" }
},
"url": "/orgs/:org/members/:username"
},
"removeMembership": {
"method": "DELETE",
"params": {
"org": { "required":