plugin-rest-endpoint-methods.js
Octokit plugin adding one method for all of api.github.com REST API endpoints
Usage
Browsers
|
Load @octokit/plugin-rest-endpoint-methods and @octokit/core (or core-compatible module) directly from cdn.pika.dev
<script type="module">
import { Octokit } from "https://cdn.pika.dev/@octokit/core";
import { restEndpointMethods } from "https://cdn.pika.dev/@octokit/plugin-rest-endpoint-methods";
</script>
|
---|
Node
|
Install with npm install @octokit/core @octokit/plugin-rest-endpoint-methods . Optionally replace @octokit/core with a compatible module
const { Octokit } = require("@octokit/core");
const {
restEndpointMethods
} = require("@octokit/plugin-rest-endpoint-methods");
|
---|
const MyOctokit = Octokit.plugin(restEndpointMethods);
const octokit = new MyOctokit({ auth: "secret123" });
octokit.apps.getAuthenticated();
octokit.apps.createFromManifest({ code });
octokit.apps.listInstallations();
octokit.apps.getInstallation({ installation_id });
octokit.apps.deleteInstallation({ installation_id });
octokit.apps.createInstallationToken({
installation_id,
repository_ids,
permissions
});
octokit.oauthAuthorizations.listGrants();
octokit.oauthAuthorizations.getGrant({ grant_id });
octokit.oauthAuthorizations.deleteGrant({ grant_id });
octokit.apps.deleteAuthorization({ client_id, access_token });
octokit.apps.revokeGrantForApplication({ client_id, access_token });
octokit.oauthAuthorizations.revokeGrantForApplication({
client_id,
access_token
});
octokit.apps.checkToken({ client_id, access_token });
octokit.apps.resetToken({ client_id, access_token });
octokit.apps.deleteToken({ client_id, access_token });
octokit.apps.checkAuthorization({ client_id, access_token });
octokit.oauthAuthorizations.checkAuthorization({ client_id, access_token });
octokit.apps.resetAuthorization({ client_id, access_token });
octokit.oauthAuthorizations.resetAuthorization({ client_id, access_token });
octokit.apps.revokeAuthorizationForApplication({ client_id, access_token });
octokit.oauthAuthorizations.revokeAuthorizationForApplication({
client_id,
access_token
});
octokit.apps.getBySlug({ app_slug });
octokit.oauthAuthorizations.listAuthorizations();
octokit.oauthAuthorizations.createAuthorization({
scopes,
note,
note_url,
client_id,
client_secret,
fingerprint
});
octokit.oauthAuthorizations.getOrCreateAuthorizationForApp({
client_id,
client_secret,
scopes,
note,
note_url,
fingerprint
});
octokit.oauthAuthorizations.getOrCreateAuthorizationForAppAndFingerprint({
client_id,
fingerprint,
client_secret,
scopes,
note,
note_url
});
octokit.oauthAuthorizations.getOrCreateAuthorizationForAppFingerprint({
client_id,
fingerprint,
client_secret,
scopes,
note,
note_url
});
octokit.oauthAuthorizations.getAuthorization({ authorization_id });
octokit.oauthAuthorizations.updateAuthorization({
authorization_id,
scopes,
add_scopes,
remove_scopes,
note,
note_url,
fingerprint
});
octokit.oauthAuthorizations.deleteAuthorization({ authorization_id });
octokit.codesOfConduct.listConductCodes();
octokit.codesOfConduct.getConductCode({ key });
octokit.apps.createContentAttachment({ content_reference_id, title, body });
octokit.emojis.get();
octokit.activity.listPublicEvents();
octokit.activity.listFeeds();
octokit.gists.list({ since });
octokit.gists.create({ files, description, public });
octokit.gists.listPublic({ since });
octokit.gists.listStarred({ since });
octokit.gists.get({ gist_id });
octokit.gists.update({ gist_id, description, files });
octokit.gists.delete({ gist_id });
octokit.gists.listComments({ gist_id });
octokit.gists.createComment({ gist_id, body });
octokit.gists.getComment({ gist_id, comment_id });
octokit.gists.updateComment({ gist_id, comment_id, body });
octokit.gists.deleteComment({ gist_id, comment_id });
octokit.gists.listCommits({ gist_id });
octokit.gists.fork({ gist_id });
octokit.gists.listForks({ gist_id });
octokit.gists.star({ gist_id });
octokit.gists.unstar({ gist_id });
octokit.gists.checkIsStarred({ gist_id });
octokit.gists.getRevision({ gist_id, sha });
octokit.gitignore.listTemplates();
octokit.gitignore.getTemplate({ name });
octokit.apps.listRepos();
octokit.apps.revokeInstallationToken();
octokit.issues.list({ filter, state, labels, sort, direction, since });
octokit.licenses.listCommonlyUsed();
octokit.licenses.list();
octokit.licenses.get({ license });
octokit.markdown.render({ text, mode, context });
octokit.markdown.renderRaw({ data });
octokit.apps.checkAccountIsAssociatedWithAny({ account_id });
octokit.apps.listPlans();
octokit.apps.listAccountsUserOrOrgOnPlan({ plan_id, sort, direction });
octokit.apps.checkAccountIsAssociatedWithAnyStubbed({ account_id });
octokit.apps.listPlansStubbed();
octokit.apps.listAccountsUserOrOrgOnPlanStubbed({ plan_id, sort, direction });
octokit.meta.get();
octokit.activity.listPublicEventsForRepoNetwork({ owner, repo });
octokit.activity.listNotifications({ all, participating, since, before });
octokit.activity.markAsRead({ last_read_at });
octokit.activity.getThread({ thread_id });
octokit.activity.markThreadAsRead({ thread_id });
octokit.activity.getThreadSubscription({ thread_id });
octokit.activity.setThreadSubscription({ thread_id, ignored });
octokit.activity.deleteThreadSubscription({ thread_id });
octokit.orgs.list({ since });
octokit.orgs.get({ org });
octokit.orgs.update({
org,
billing_email,
company,
email,
location,
name,
description,
has_organization_projects,
has_repository_projects,
default_repository_permission,
members_can_create_repositories,
members_can_create_internal_repositories,
members_can_create_private_repositories,
members_can_create_public_repositories,
members_allowed_repository_creation_type
});
octokit.orgs.listBlockedUsers({ org });
octokit.orgs.checkBlockedUser({ org, username });
octokit.orgs.blockUser({ org, username });
octokit.orgs.unblockUser({ org, username });
octokit.activity.listPublicEventsForOrg({ org });
octokit.orgs.listHooks({ org });
octokit.orgs.createHook({ org, name, config, events, active });
octokit.orgs.getHook({ org, hook_id });
octokit.orgs.updateHook({ org, hook_id, config, events, active });
octokit.orgs.deleteHook({ org, hook_id });
octokit.orgs.pingHook({ org, hook_id });
octokit.apps.getOrgInstallation({ org });
octokit.apps.findOrgInstallation({ org });
octokit.orgs.listInstallations({ org });
octokit.interactions.getRestrictionsForOrg({ org });
octokit.interactions.addOrUpdateRestrictionsForOrg({ org, limit });
octokit.interactions.removeRestrictionsForOrg({ org });
octokit.orgs.listPendingInvitations({ org });
octokit.orgs.createInvitation({ org, invitee_id, email, role, team_ids });
octokit.orgs.listInvitationTeams({ org, invitation_id });
octokit.issues.listForOrg({
org,
filter,
state,
labels,
sort,
direction,
since
});
octokit.orgs.listMembers({ org, filter, role });
octokit.orgs.checkMembership({ org, username });
octokit.orgs.removeMember({ org, username });
octokit.orgs.getMembership({ org, username });
octokit.orgs.addOrUpdateMembership({ org, username, role });
octokit.orgs.removeMembership({ org, username });
octokit.migrations.startForOrg({
org,
repositories,
lock_repositories,
exclude_attachments
});
octokit.migrations.listForOrg({ org });
octokit.migrations.getStatusForOrg({ org, migration_id });
octokit.migrations.getArchiveForOrg({ org, migration_id });
octokit.migrations.deleteArchiveForOrg({ org, migration_id });
octokit.migrations.unlockRepoForOrg({ org, migration_id, repo_name });
octokit.migrations.listReposForOrg({ org, migration_id });
octokit.orgs.listOutsideCollaborators({ org, filter });
octokit.orgs.removeOutsideCollaborator({ org, username });
octokit.orgs.convertMemberToOutsideCollaborator({ org, username });
octokit.projects.listForOrg({ org, state });
octokit.projects.createForOrg({ org, name, body });
octokit.orgs.listPublicMembers({ org });
octokit.orgs.checkPublicMembership({ org, username });
octokit.orgs.publicizeMembership({ org, username });
octokit.orgs.concealMembership({ org, username });
octokit.repos.listForOrg({ org, type, sort, direction });
octokit.repos.createInOrg({
org,
name,
description,
homepage,
private,
visibility,
has_issues,
has_projects,
has_wiki,
is_template,
team_id,
auto_init,
gitignore_template,
license_template,
allow_squash_merge,
allow_merge_commit,
allow_rebase_merge,
delete_branch_on_merge
});
octokit.teams.list({ org });
octokit.teams.create({
org,
name,
description,
maintainers,
repo_names,
privacy,
permission,
parent_team_id
});
octokit.teams.getByName({ org, team_slug });
octokit.teams.updateInOrg({
org,
team_slug,
name,
description,
privacy,
permission,
parent_team_id
});
octokit.teams.deleteInOrg({ org, team_slug });
octokit.teams.listDiscussionsInOrg({ org, team_slug, direction });
octokit.teams.createDiscussionInOrg({ org, team_slug, title, body, private });
octokit.teams.getDiscussionInOrg({ org, team_slug, discussion_number });
octokit.teams.updateDiscussionInOrg({
org,
team_slug,
discussion_number,
title,
body
});
octokit.teams.deleteDiscussionInOrg({ org, team_slug, discussion_number });
octokit.teams.listDiscussionCommentsInOrg({
org,
team_slug,
discussion_number,
direction
});
octokit.teams.createDiscussionCommentInOrg({
org,
team_slug,
discussion_number,
body
});
octokit.teams.getDiscussionCommentInOrg({
org,
team_slug,
discussion_number,
comment_number
});
octokit.teams.updateDiscussionCommentInOrg({
org,
team_slug,
discussion_number,
comment_number,
body
});
octokit.teams.deleteDiscussionCommentInOrg({
org,
team_slug,
discussion_number,
comment_number
});
octokit.reactions.listForTeamDiscussionCommentInOrg({
org,
team_slug,
discussion_number,
comment_number,
content
});
octokit.reactions.createForTeamDiscussionCommentInOrg({
org,
team_slug,
discussion_number,
comment_number,
content
});
octokit.reactions.listForTeamDiscussionInOrg({
org,
team_slug,
discussion_number,
content
});
octokit.reactions.createForTeamDiscussionInOrg({
org,
team_slug,
discussion_number,
content
});
octokit.teams.listPendingInvitationsInOrg({ org, team_slug });
octokit.teams.listMembersInOrg({ org, team_slug, role });
octokit.teams.getMembershipInOrg({ org, team_slug, username });
octokit.teams.addOrUpdateMembershipInOrg({ org, team_slug, username, role });
octokit.teams.removeMembershipInOrg({ org, team_slug, username });
octokit.teams.listProjectsInOrg({ org, team_slug });
octokit.teams.reviewProjectInOrg({ org, team_slug, project_id });
octokit.teams.addOrUpdateProjectInOrg({
org,
team_slug,
project_id,
permission
});
octokit.teams.removeProjectInOrg({ org, team_slug, project_id });
octokit.teams.listReposInOrg({ org, team_slug });
octokit.teams.checkManagesRepoInOrg({ org, team_slug, owner, repo });
octokit.teams.addOrUpdateRepoInOrg({ org, team_slug, owner, repo, permission });
octokit.teams.removeRepoInOrg({ org, team_slug, owner, repo });
octokit.teams.listChildInOrg({ org, team_slug });
octokit.projects.getCard({ card_id });
octokit.projects.updateCard({ card_id, note, archived });
octokit.projects.deleteCard({ card_id });
octokit.projects.moveCard({ card_id, position, column_id });
octokit.projects.getColumn({ column_id });
octokit.projects.updateColumn({ column_id, name });
octokit.projects.deleteColumn({ column_id });
octokit.projects.listCards({ column_id, archived_state });
octokit.projects.createCard({ column_id, note, content_id, content_type });
octokit.projects.moveColumn({ column_id, position });
octokit.projects.get({ project_id });
octokit.projects.update({
project_id,
name,
body,
state,
organization_permission,
private
});
octokit.projects.delete({ project_id });
octokit.projects.listCollaborators({ project_id, affiliation });
octokit.projects.addCollaborator({ project_id, username, permission });
octokit.projects.removeCollaborator({ project_id, username });
octokit.projects.reviewUserPermissionLevel({ project_id, username });
octokit.projects.listColumns({ project_id });
octokit.projects.createColumn({ project_id, name });
octokit.rateLimit.get();
octokit.reactions.delete({ reaction_id });
octokit.repos.get({ owner, repo });
octokit.repos.update({
owner,
repo,
name,
description,
homepage,
private,
visibility,
has_issues,
has_projects,
has_wiki,
is_template,
default_branch,
allow_squash_merge,
allow_merge_commit,
allow_rebase_merge,
delete_branch_on_merge,
archived
});
octokit.repos.delete({ owner, repo });
octokit.issues.listAssignees({ owner, repo });
octokit.issues.checkAssignee({ owner, repo, assignee });
octokit.repos.enableAutomatedSecurityFixes({ owner, repo });
octokit.repos.disableAutomatedSecurityFixes({ owner, repo });
octokit.repos.listBranches({ owner, repo, protected });
octokit.repos.getBranch({ owner, repo, branch });
octokit.repos.getBranchProtection({ owner, repo, branch });
octokit.repos.updateBranchProtection({
owner,
repo,
branch,
required_status_checks,
enforce_admins,
required_pull_request_reviews,
restrictions,
required_linear_history,
allow_force_pushes,
allow_deletions
});
octokit.repos.removeBranchProtection({ owner, repo, branch });
octokit.repos.getProtectedBranchAdminEnforcement({ owner, repo, branch });
octokit.repos.addProtectedBranchAdminEnforcement({ owner, repo, branch });
octokit.repos.removeProtectedBranchAdminEnforcement({ owner, repo, branch });
octokit.repos.getProtectedBranchPullRequestReviewEnforcement({
owner,
repo,
branch
});
octokit.repos.updateProtectedBranchPullRequestReviewEnforcement({
owner,
repo,
branch,
dismissal_restrictions,
dismiss_stale_reviews,
require_code_owner_reviews,
required_approving_review_count
});
octokit.repos.removeProtectedBranchPullRequestReviewEnforcement({
owner,
repo,
branch
});
octokit.repos.getProtectedBranchRequiredSignatures({ owner, repo, branch });
octokit.repos.addProtectedBranchRequiredSignatures({ owner, repo, branch });
octokit.repos.removeProtectedBranchRequiredSignatures({ owner, repo, branch });
octokit.repos.getProtectedBranchRequiredStatusChecks({ owner, repo, branch });
octokit.repos.updateProtectedBranchRequiredStatusChecks({
owner,
repo,
branch,
strict,
contexts
});
octokit.repos.removeProtectedBranchRequiredStatusChecks({
owner,
repo,
branch
});
octokit.repos.listProtectedBranchRequiredStatusChecksContexts({
owner,
repo,
branch
});
octokit.repos.replaceProtectedBranchRequiredStatusChecksContexts({
owner,
repo,
branch,
contexts
});
octokit.repos.addProtectedBranchRequiredStatusChecksContexts({
owner,
repo,
branch,
contexts
});
octokit.repos.removeProtectedBranchRequiredStatusChecksContexts({
owner,
repo,
branch,
contexts
});
octokit.repos.getProtectedBranchRestrictions({ owner, repo, branch });
octokit.repos.removeProtectedBranchRestrictions({ owner, repo, branch });
octokit.repos.getAppsWithAccessToProtectedBranch({ owner, repo, branch });
octokit.repos.listAppsWithAccessToProtectedBranch({ owner, repo, branch });
octokit.repos.replaceProtectedBranchAppRestrictions({
owner,
repo,
branch,
apps
});
octokit.repos.addProtectedBranchAppRestrictions({ owner, repo, branch, apps });
octokit.repos.removeProtectedBranchAppRestrictions({
owner,
repo,
branch,
apps
});
octokit.repos.getTeamsWithAccessToProtectedBranch({ owner, repo, branch });
octokit.repos.listProtectedBranchTeamRestrictions({ owner, repo, branch });
octokit.repos.listTeamsWithAccessToProtectedBranch({ owner, repo, branch });
octokit.repos.replaceProtectedBranchTeamRestrictions({
owner,
repo,
branch,
teams
});
octokit.repos.addProtectedBranchTeamRestrictions({
owner,
repo,
branch,
teams
});
octokit.repos.removeProtectedBranchTeamRestrictions({
owner,
repo,
branch,
teams
});
octokit.repos.getUsersWithAccessToProtectedBranch({ owner, repo, branch });
octokit.repos.listProtectedBranchUserRestrictions({ owner, repo, branch });
octokit.repos.listUsersWithAccessToProtectedBranch({ owner, repo, branch });
octokit.repos.replaceProtectedBranchUserRestrictions({
owner,
repo,
branch,
users
});
octokit.repos.addProtectedBranchUserRestrictions({
owner,
repo,
branch,
users
});
octokit.repos.removeProtectedBranchUserRestrictions({
owner,
repo,
branch,
users
});
octokit.checks.create({
owner,
repo,
name,
head_sha,
details_url,
external_id,
status,
started_at,
conclusion,
completed_at,
output,
actions
});
octokit.checks.update({
owner,
repo,
check_run_id,
name,
details_url,
external_id,
started_at,
status,
conclusion,
completed_at,
output,
actions
});
octokit.checks.get({ owner, repo, check_run_id });
octokit.checks.listAnnotations({ owner, repo, check_run_id });
octokit.checks.createSuite({ owner, repo, head_sha });
octokit.checks.setSuitesPreferences({ owner, repo, auto_trigger_checks });
octokit.checks.getSuite({ owner, repo, check_suite_id });
octokit.checks.listForSuite({
owner,
repo,
check_suite_id,
check_name,
status,
filter
});
octokit.checks.rerequestSuite({ owner, repo, check_suite_id });
octokit.repos.listCollaborators({ owner, repo, affiliation });
octokit.repos.checkCollaborator({ owner, repo, username });
octokit.repos.addCollaborator({ owner, repo, username, permission });
octokit.repos.removeCollaborator({ owner, repo, username });
octokit.repos.getCollaboratorPermissionLevel({ owner, repo, username });
octokit.repos.listCommitComments({ owner, repo });
octokit.repos.getCommitComment({ owner, repo, comment_id });
octokit.repos.updateCommitComment({ owner, repo, comment_id, body });
octokit.repos.deleteCommitComment({ owner, repo, comment_id });
octokit.reactions.listForCommitComment({ owner, repo, comment_id, content });
octokit.reactions.createForCommitComment({ owner, repo, comment_id, content });
octokit.repos.listCommits({ owner, repo, sha, path, author, since, until });
octokit.repos.listBranchesForHeadCommit({ owner, repo, commit_sha });
octokit.repos.listCommentsForCommit({ owner, repo, commit_sha });
octokit.repos.createCommitComment({
owner,
repo,
commit_sha,
body,
path,
position,
line
});
octokit.repos.listPullRequestsAssociatedWithCommit({ owner, repo, commit_sha });
octokit.repos.getCommit({ owner, repo, ref });
octokit.checks.listForRef({ owner, repo, ref, check_name, status, filter });
octokit.checks.listSuitesForRef({ owner, repo, ref, app_id, check_name });
octokit.repos.getCombinedStatusForRef({ owner, repo, ref });
octokit.repos.listStatusesForRef({ owner, repo, ref });
octokit.codesOfConduct.getForRepo({ owner, repo });
octokit.repos.retrieveCommunityProfileMetrics({ owner, repo });
octokit.repos.compareCommits({ owner, repo, base, head });
octokit.repos.getContents({ owner, repo, path, ref });
octokit.repos.createOrUpdateFile({
owner,
repo,
path,
message,
content,
sha,
branch,
committer,
author
});
octokit.repos.createFile({
owner,
repo,
path,
message,
content,
sha,
branch,
committer,
author
});
octokit.repos.updateFile({
owner,
repo,
path,
message,
content,
sha,
branch,
committer,
author
});
octokit.repos.deleteFile({
owner,
repo,
path,
message,
sha,
branch,
committer,
author
});
octokit.repos.listContributors({ owner, repo, anon });
octokit.repos.listDeployments({ owner, repo, sha, ref, task, environment });
octokit.repos.createDeployment({
owner,
repo,
ref,
task,
auto_merge,
required_contexts,
payload,
environment,
description,
transient_environment,
production_environment
});
octokit.repos.getDeployment({ owner, repo, deployment_id });
octokit.repos.listDeploymentStatuses({ owner, repo, deployment_id });
octokit.repos.createDeploymentStatus({
owner,
repo,
deployment_id,
state,
target_url,
log_url,
description,
environment,
environment_url,
auto_inactive
});
octokit.repos.getDeploymentStatus({ owner, repo, deployment_id, status_id });
octokit.repos.createDispatchEvent({ owner, repo, event_type, client_payload });
octokit.repos.listDownloads({ owner, repo });
octokit.repos.getDownload({ owner, repo, download_id });
octokit.repos.deleteDownload({ owner, repo, download_id });
octokit.activity.listRepoEvents({ owner, repo });
octokit.repos.listForks({ owner, repo, sort });
octokit.repos.createFork({ owner, repo, organization });
octokit.git.createBlob({ owner, repo, content, encoding });
octokit.git.getBlob({ owner, repo, file_sha });
octokit.git.createCommit({
owner,
repo,
message,
tree,
parents,
author,
committer,
signature
});
octokit.git.getCommit({ owner, repo, commit_sha });
octokit.git.listMatchingRefs({ owner, repo, ref });
octokit.git.getRef({ owner, repo, ref });
octokit.git.createRef({ owner, repo, ref, sha });
octokit.git.updateRef({ owner, repo, ref, sha, force });
octokit.git.deleteRef({ owner, repo, ref });
octokit.git.createTag({ owner, repo, tag, message, object, type, tagger });
octokit.git.getTag({ owner, repo, tag_sha });
octokit.git.createTree({ owner, repo, tree, base_tree });
octokit.git.getTree({ owner, repo, tree_sha, recursive });
octokit.repos.listHooks({ owner, repo });
octokit.repos.createHook({ owner, repo, name, config, events, active });
octokit.repos.getHook({ owner, repo, hook_id });
octokit.repos.updateHook({
owner,
repo,
hook_id,
config,
events,
add_events,
remove_events,
active
});
octokit.repos.deleteHook({ owner, repo, hook_id });
octokit.repos.pingHook({ owner, repo, hook_id });
octokit.repos.testPushHook({ owner, repo, hook_id });
octokit.migrations.startImport({
owner,
repo,
vcs_url,
vcs,
vcs_username,
vcs_password,
tfvc_project
});
octokit.migrations.getImportProgress({ owner, repo });
octokit.migrations.updateImport({ owner, repo, vcs_username, vcs_password });
octokit.migrations.cancelImport({ owner, repo });
octokit.migrations.getCommitAuthors({ owner, repo, since });
octokit.migrations.mapCommitAuthor({ owner, repo, author_id, email, name });
octokit.migrations.getLargeFiles({ owner, repo });
octokit.migrations.setLfsPreference({ owner, repo, use_lfs });
octokit.apps.getRepoInstallation({ owner, repo });
octokit.apps.findRepoInstallation({ owner, repo });
octokit.interactions.getRestrictionsForRepo({ owner, repo });
octokit.interactions.addOrUpdateRestrictionsForRepo({ owner, repo, limit });
octokit.interactions.removeRestrictionsForRepo({ owner, repo });
octokit.repos.listInvitations({ owner, repo });
octokit.repos.deleteInvitation({ owner, repo, invitation_id });
octokit.repos.updateInvitation({ owner, repo, invitation_id, permissions });
octokit.issues.listForRepo({
owner,
repo,
milestone,
state,
assignee,
creator,
mentioned,
labels,
sort,
direction,
since
});
octokit.issues.create({
owner,
repo,
title,
body,
assignee,
milestone,
labels,
assignees
});
octokit.issues.listCommentsForRepo({ owner, repo, sort, direction, since });
octokit.issues.getComment({ owner, repo, comment_id });
octokit.issues.updateComment({ owner, repo, comment_id, body });
octokit.issues.deleteComment({ owner, repo, comment_id });
octokit.reactions.listForIssueComment({ owner, repo, comment_id, content });
octokit.reactions.createForIssueComment({ owner, repo, comment_id, content });
octokit.issues.listEventsForRepo({ owner, repo });
octokit.issues.getEvent({ owner, repo, event_id });
octokit.issues.get({ owner, repo, issue_number });
octokit.issues.update({
owner,
repo,
issue_number,
title,
body,
assignee,
state,
milestone,
labels,
assignees
});
octokit.issues.addAssignees({ owner, repo, issue_number, assignees });
octokit.issues.removeAssignees({ owner, repo, issue_number, assignees });
octokit.issues.listComments({ owner, repo, issue_number, since });
octokit.issues.createComment({ owner, repo, issue_number, body });
octokit.issues.listEvents({ owner, repo, issue_number });
octokit.issues.listLabelsOnIssue({ owner, repo, issue_number });
octokit.issues.addLabels({ owner, repo, issue_number, labels });
octokit.issues.replaceLabels({ owner, repo, issue_number, labels });
octokit.issues.removeLabels({ owner, repo, issue_number });
octokit.issues.removeLabel({ owner, repo, issue_number, name });
octokit.issues.lock({ owner, repo, issue_number, lock_reason });
octokit.issues.unlock({ owner, repo, issue_number });
octokit.reactions.listForIssue({ owner, repo, issue_number, content });
octokit.reactions.createForIssue({ owner, repo, issue_number, content });
octokit.issues.listEventsForTimeline({ owner, repo, issue_number });
octokit.repos.listDeployKeys({ owner, repo });
octokit.repos.addDeployKey({ owner, repo, title, key, read_only });
octokit.repos.getDeployKey({ owner, repo, key_id });
octokit.repos.removeDeployKey({ owner, repo, key_id });
octokit.issues.listLabelsForRepo({ owner, repo });
octokit.issues.createLabel({ owner, repo, name, color, description });
octokit.issues.getLabel({ owner, repo, name });
octokit.issues.updateLabel({ owner, repo, name, new_name, color, description });
octokit.issues.deleteLabel({ owner, repo, name });
octokit.repos.listLanguages({ owner, repo });
octokit.licenses.getForRepo({ owner, repo });
octokit.repos.merge({ owner, repo, base, head, commit_message });
octokit.issues.listMilestonesForRepo({ owner, repo, state, sort, direction });
octokit.issues.createMilestone({
owner,
repo,
title,
state,
description,
due_on
});
octokit.issues.getMilestone({ owner, repo, milestone_number });
octokit.issues.updateMilestone({
owner,
repo,
milestone_number,
title,
state,
description,
due_on
});
octokit.issues.deleteMilestone({ owner, repo, milestone_number });
octokit.issues.listLabelsForMilestone({ owner, repo, milestone_number });
octokit.activity.listNotificationsForRepo({
owner,
repo,
all,
participating,
since,
before
});
octokit.activity.markNotificationsAsReadForRepo({ owner, repo, last_read_at });
octokit.repos.getPages({ owner, repo });
octokit.repos.enablePagesSite({ owner, repo, source });
octokit.repos.disablePagesSite({ owner, repo });
octokit.repos.updateInformationAboutPagesSite({ owner, repo, cname, source });
octokit.repos.requestPageBuild({ owner, repo });
octokit.repos.listPagesBuilds({ owner, repo });
octokit.repos.getLatestPagesBuild({ owner, repo });
octokit.repos.getPagesBuild({ owner, repo, build_id });
octokit.projects.listForRepo({ owner, repo, state });
octokit.projects.createForRepo({ owner, repo, name, body });
octokit.pulls.list({ owner, repo, state, head, base, sort, direction });
octokit.pulls.create({
owner,
repo,
title,
head,
base,
body,
maintainer_can_modify,
draft
});
octokit.pulls.listCommentsForRepo({ owner, repo, sort, direction, since });
octokit.pulls.getComment({ owner, repo, comment_id });
octokit.pulls.updateComment({ owner, repo, comment_id, body });
octokit.pulls.deleteComment({ owner, repo, comment_id });
octokit.reactions.listForPullRequestReviewComment({
owner,
repo,
comment_id,
content
});
octokit.reactions.createForPullRequestReviewComment({
owner,
repo,
comment_id,
content
});
octokit.pulls.get({ owner, repo, pull_number });
octokit.pulls.update({
owner,
repo,
pull_number,
title,
body,
state,
base,
maintainer_can_modify
});
octokit.pulls.listComments({
owner,
repo,
pull_number,
sort,
direction,
since
});
octokit.pulls.createComment({
owner,
repo,
pull_number,
body,
commit_id,
path,
position,
side,
line,
start_line,
start_side,
in_reply_to
});
octokit.pulls.createCommentReply({
owner,
repo,
pull_number,
body,
commit_id,
path,
position,
side,
line,
start_line,
start_side,
in_reply_to
});
octokit.pulls.createReviewCommentReply({
owner,
repo,
pull_number,
comment_id,
body
});
octokit.pulls.listCommits({ owner, repo, pull_number });
octokit.pulls.listFiles({ owner, repo, pull_number });
octokit.pulls.checkIfMerged({ owner, repo, pull_number });
octokit.pulls.merge({
owner,
repo,
pull_number,
commit_title,
commit_message,
sha,
merge_method
});
octokit.pulls.listReviewRequests({ owner, repo, pull_number });
octokit.pulls.createReviewRequest({
owner,
repo,
pull_number,
reviewers,
team_reviewers
});
octokit.pulls.deleteReviewRequest({
owner,
repo,
pull_number,
reviewers,
team_reviewers
});
octokit.pulls.listReviews({ owner, repo, pull_number });
octokit.pulls.createReview({
owner,
repo,
pull_number,
commit_id,
body,
event,
comments
});
octokit.pulls.getReview({ owner, repo, pull_number, review_id });
octokit.pulls.deletePendingReview({ owner, repo, pull_number, review_id });
octokit.pulls.updateReview({ owner, repo, pull_number, review_id, body });
octokit.pulls.getCommentsForReview({ owner, repo, pull_number, review_id });
octokit.pulls.dismissReview({ owner, repo, pull_number, review_id, message });
octokit.pulls.submitReview({
owner,
repo,
pull_number,
review_id,
body,
event
});
octokit.pulls.updateBranch({ owner, repo, pull_number, expected_head_sha });
octokit.repos.getReadme({ owner, repo, ref });
octokit.repos.listReleases({ owner, repo });
octokit.repos.createRelease({
owner,
repo,
tag_name,
target_commitish,
name,
body,
draft,
prerelease
});
octokit.repos.getReleaseAsset({ owner, repo, asset_id });
octokit.repos.updateReleaseAsset({ owner, repo, asset_id, name, label });
octokit.repos.deleteReleaseAsset({ owner, repo, asset_id });
octokit.repos.getLatestRelease({ owner, repo });
octokit.repos.getReleaseByTag({ owner, repo, tag });
octokit.repos.getRelease({ owner, repo, release_id });
octokit.repos.updateRelease({
owner,
repo,
release_id,
tag_name,
target_commitish,
name,
body,
draft,
prerelease
});
octokit.repos.deleteRelease({ owner, repo, release_id });
octokit.repos.listAssetsForRelease({ owner, repo, release_id });
octokit.activity.listStargazersForRepo({ owner, repo });
octokit.repos.getCodeFrequencyStats({ owner, repo });
octokit.repos.getCommitActivityStats({ owner, repo });
octokit.repos.getContributorsStats({ owner, repo });
octokit.repos.getParticipationStats({ owner, repo });
octokit.repos.getPunchCardStats({ owner, repo });
octokit.repos.createStatus({
owner,
repo,
sha,
state,
target_url,
description,
context
});
octokit.activity.listWatchersForRepo({ owner, repo });
octokit.activity.getRepoSubscription({ owner, repo });
octokit.activity.setRepoSubscription({ owner, repo, subscribed, ignored });
octokit.activity.deleteRepoSubscription({ owner, repo });
octokit.repos.listTags({ owner, repo });
octokit.repos.listTeams({ owner, repo });
octokit.repos.listTopics({ owner, repo });
octokit.repos.replaceTopics({ owner, repo, names });
octokit.repos.getClones({ owner, repo, per });
octokit.repos.getTopPaths({ owner, repo });
octokit.repos.getTopReferrers({ owner, repo });
octokit.repos.getViews({ owner, repo, per });
octokit.repos.transfer({ owner, repo, new_owner, team_ids });
octokit.repos.checkVulnerabilityAlerts({ owner, repo });
octokit.repos.enableVulnerabilityAlerts({ owner, repo });
octokit.repos.disableVulnerabilityAlerts({ owner, repo });
octokit.repos.getArchiveLink({ owner, repo, archive_format, ref });
octokit.repos.createUsingTemplate({
template_owner,
template_repo,
owner,
name,
description,
private
});
octokit.repos.listPublic({ since });
octokit.search.code({ q, sort, order });
octokit.search.commits({ q, sort, order });
octokit.search.issuesAndPullRequests({ q, sort, order });
octokit.search.issues({ q, sort, order });
octokit.search.labels({ repository_id, q, sort, order });
octokit.search.repos({ q, sort, order });
octokit.search.topics({ q });
octokit.search.users({ q, sort, order });
octokit.teams.getLegacy({ team_id });
octokit.teams.get({ team_id });
octokit.teams.updateLegacy({
team_id,
name,
description,
privacy,
permission,
parent_team_id
});
octokit.teams.update({
team_id,
name,
description,
privacy,
permission,
parent_team_id
});
octokit.teams.deleteLegacy({ team_id });
octokit.teams.delete({ team_id });
octokit.teams.listDiscussionsLegacy({ team_id, direction });
octokit.teams.listDiscussions({ team_id, direction });
octokit.teams.createDiscussionLegacy({ team_id, title, body, private });
octokit.teams.createDiscussion({ team_id, title, body, private });
octokit.teams.getDiscussionLegacy({ team_id, discussion_number });
octokit.teams.getDiscussion({ team_id, discussion_number });
octokit.teams.updateDiscussionLegacy({
team_id,
discussion_number,
title,
body
});
octokit.teams.updateDiscussion({ team_id, discussion_number, title, body });
octokit.teams.deleteDiscussionLegacy({ team_id, discussion_number });
octokit.teams.deleteDiscussion({ team_id, discussion_number });
octokit.teams.listDiscussionCommentsLegacy({
team_id,
discussion_number,
direction
});
octokit.teams.listDiscussionComments({ team_id, discussion_number, direction });
octokit.teams.createDiscussionCommentLegacy({
team_id,
discussion_number,
body
});
octokit.teams.createDiscussionComment({ team_id, discussion_number, body });
octokit.teams.getDiscussionCommentLegacy({
team_id,
discussion_number,
comment_number
});
octokit.teams.getDiscussionComment({
team_id,
discussion_number,
comment_number
});
octokit.teams.updateDiscussionCommentLegacy({
team_id,
discussion_number,
comment_number,
body
});
octokit.teams.updateDiscussionComment({
team_id,
discussion_number,
comment_number,
body
});
octokit.teams.deleteDiscussionCommentLegacy({
team_id,
discussion_number,
comment_number
});
octokit.teams.deleteDiscussionComment({
team_id,
discussion_number,
comment_number
});
octokit.reactions.listForTeamDiscussionCommentLegacy({
team_id,
discussion_number,
comment_number,
content
});
octokit.reactions.listForTeamDiscussionComment({
team_id,
discussion_number,
comment_number,
content
});
octokit.reactions.createForTeamDiscussionCommentLegacy({
team_id,
discussion_number,
comment_number,
content
});
octokit.reactions.createForTeamDiscussionComment({
team_id,
discussion_number,
comment_number,
content
});
octokit.reactions.listForTeamDiscussionLegacy({
team_id,
discussion_number,
content
});
octokit.reactions.listForTeamDiscussion({
team_id,
discussion_number,
content
});
octokit.reactions.createForTeamDiscussionLegacy({
team_id,
discussion_number,
content
});
octokit.reactions.createForTeamDiscussion({
team_id,
discussion_number,
content
});
octokit.teams.listPendingInvitationsLegacy({ team_id });
octokit.teams.listPendingInvitations({ team_id });
octokit.teams.listMembersLegacy({ team_id, role });
octokit.teams.listMembers({ team_id, role });
octokit.teams.getMemberLegacy({ team_id, username });
octokit.teams.getMember({ team_id, username });
octokit.teams.addMemberLegacy({ team_id, username });
octokit.teams.addMember({ team_id, username });
octokit.teams.removeMemberLegacy({ team_id, username });
octokit.teams.removeMember({ team_id, username });
octokit.teams.getMembershipLegacy({ team_id, username });
octokit.teams.getMembership({ team_id, username });
octokit.teams.addOrUpdateMembershipLegacy({ team_id, username, role });
octokit.teams.addOrUpdateMembership({ team_id, username, role });
octokit.teams.removeMembershipLegacy({ team_id, username });
octokit.teams.removeMembership({ team_id, username });
octokit.teams.listProjectsLegacy({ team_id });
octokit.teams.listProjects({ team_id });
octokit.teams.reviewProjectLegacy({ team_id, project_id });
octokit.teams.reviewProject({ team_id, project_id });
octokit.teams.addOrUpdateProjectLegacy({ team_id, project_id, permission });
octokit.teams.addOrUpdateProject({ team_id, project_id, permission });
octokit.teams.removeProjectLegacy({ team_id, project_id });
octokit.teams.removeProject({ team_id, project_id });
octokit.teams.listReposLegacy({ team_id });
octokit.teams.listRepos({ team_id });
octokit.teams.checkManagesRepoLegacy({ team_id, owner, repo });
octokit.teams.checkManagesRepo({ team_id, owner, repo });
octokit.teams.addOrUpdateRepoLegacy({ team_id, owner, repo, permission });
octokit.teams.addOrUpdateRepo({ team_id, owner, repo, permission });
octokit.teams.removeRepoLegacy({ team_id, owner, repo });
octokit.teams.removeRepo({ team_id, owner, repo });
octokit.teams.listChildLegacy({ team_id });
octokit.teams.listChild({ team_id });
octokit.users.getAuthenticated();
octokit.users.updateAuthenticated({
name,
email,
blog,
company,
location,
hireable,
bio
});
octokit.users.listBlocked();
octokit.users.checkBlocked({ username });
octokit.users.block({ username });
octokit.users.unblock({ username });
octokit.users.togglePrimaryEmailVisibility({ email, visibility });
octokit.users.listEmails();
octokit.users.addEmails({ emails });
octokit.users.deleteEmails({ emails });
octokit.users.listFollowersForAuthenticatedUser();
octokit.users.listFollowingForAuthenticatedUser();
octokit.users.checkFollowing({ username });
octokit.users.follow({ username });
octokit.users.unfollow({ username });
octokit.users.listGpgKeys();
octokit.users.createGpgKey({ armored_public_key });
octokit.users.getGpgKey({ gpg_key_id });
octokit.users.deleteGpgKey({ gpg_key_id });
octokit.apps.listInstallationsForAuthenticatedUser();
octokit.apps.listInstallationReposForAuthenticatedUser({ installation_id });
octokit.apps.addRepoToInstallation({ installation_id, repository_id });
octokit.apps.removeRepoFromInstallation({ installation_id, repository_id });
octokit.issues.listForAuthenticatedUser({
filter,
state,
labels,
sort,
direction,
since
});
octokit.users.listPublicKeys();
octokit.users.createPublicKey({ title, key });
octokit.users.getPublicKey({ key_id });
octokit.users.deletePublicKey({ key_id });
octokit.apps.listMarketplacePurchasesForAuthenticatedUser();
octokit.apps.listMarketplacePurchasesForAuthenticatedUserStubbed();
octokit.orgs.listMemberships({ state });
octokit.orgs.getMembershipForAuthenticatedUser({ org });
octokit.orgs.updateMembership({ org, state });
octokit.migrations.startForAuthenticatedUser({
repositories,
lock_repositories,
exclude_attachments
});
octokit.migrations.listForAuthenticatedUser();
octokit.migrations.getStatusForAuthenticatedUser({ migration_id });
octokit.migrations.getArchiveForAuthenticatedUser({ migration_id });
octokit.migrations.deleteArchiveForAuthenticatedUser({ migration_id });
octokit.migrations.unlockRepoForAuthenticatedUser({ migration_id, repo_name });
octokit.orgs.listForAuthenticatedUser();
octokit.projects.createForAuthenticatedUser({ name, body });
octokit.users.listPublicEmails();
octokit.repos.list({ visibility, affiliation, type, sort, direction });
octokit.repos.createForAuthenticatedUser({
name,
description,
homepage,
private,
visibility,
has_issues,
has_projects,
has_wiki,
is_template,
team_id,
auto_init,
gitignore_template,
license_template,
allow_squash_merge,
allow_merge_commit,
allow_rebase_merge,
delete_branch_on_merge
});
octokit.repos.listInvitationsForAuthenticatedUser();
octokit.repos.acceptInvitation({ invitation_id });
octokit.repos.declineInvitation({ invitation_id });
octokit.activity.listReposStarredByAuthenticatedUser({ sort, direction });
octokit.activity.checkStarringRepo({ owner, repo });
octokit.activity.starRepo({ owner, repo });
octokit.activity.unstarRepo({ owner, repo });
octokit.activity.listWatchedReposForAuthenticatedUser();
octokit.teams.listForAuthenticatedUser();
octokit.migrations.listReposForUser({ migration_id });
octokit.users.list({ since });
octokit.users.getByUsername({ username });
octokit.activity.listEventsForUser({ username });
octokit.activity.listEventsForOrg({ username, org });
octokit.activity.listPublicEventsForUser({ username });
octokit.users.listFollowersForUser({ username });
octokit.users.listFollowingForUser({ username });
octokit.users.checkFollowingForUser({ username, target_user });
octokit.gists.listPublicForUser({ username, since });
octokit.users.listGpgKeysForUser({ username });
octokit.users.getContextForUser({ username, subject_type, subject_id });
octokit.apps.getUserInstallation({ username });
octokit.apps.findUserInstallation({ username });
octokit.users.listPublicKeysForUser({ username });
octokit.orgs.listForUser({ username });
octokit.projects.listForUser({ username, state });
octokit.activity.listReceivedEventsForUser({ username });
octokit.activity.listReceivedPublicEventsForUser({ username });
octokit.repos.listForUser({ username, type, sort, direction });
octokit.activity.listReposStarredByUser({ username, sort, direction });
octokit.activity.listReposWatchedByUser({ username });
octokit.repos.getCommitRefSha({ owner, ref, repo });
octokit.git.listRefs({ owner, repo, namespace });
octokit.issues.updateLabel({
owner,
repo,
current_name,
color,
name,
description
});
octokit.pulls.createFromIssue({
owner,
repo,
base,
draft,
head,
issue,
maintainer_can_modify,
owner,
repo
});
octokit.repos.uploadReleaseAsset({ file, headers, label, name, url });
There is one method for each REST API endpoint documented at https://developer.github.com/v3.
Contributing
See CONTRIBUTING.md
License
MIT