diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index ae590ba2a..2eee55d1b 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -24,7 +24,7 @@ jobs: ${{ runner.os }}-node- - run: npm ci - run: npm run build - - run: npx semantic-release + - run: npx semantic-release --debug env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} NPM_TOKEN: ${{ secrets.NPM_TOKEN }} diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index d75408bd6..e978219ad 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -12,7 +12,7 @@ jobs: runs-on: ubuntu-latest strategy: matrix: - node_version: ['8', '10', '12'] + node_version: ["10", "12"] steps: - uses: actions/checkout@master diff --git a/README.md b/README.md index 2c3ae5c17..2994e7058 100644 --- a/README.md +++ b/README.md @@ -67,27 +67,9 @@ octokit.apps.createInstallationToken({ permissions }); -// https://developer.github.com/v3/oauth_authorizations/#list-your-grants -octokit.oauthAuthorizations.listGrants(); - -// https://developer.github.com/v3/oauth_authorizations/#get-a-single-grant -octokit.oauthAuthorizations.getGrant({ grant_id }); - -// https://developer.github.com/v3/oauth_authorizations/#delete-a-grant -octokit.oauthAuthorizations.deleteGrant({ grant_id }); - // https://developer.github.com/v3/apps/oauth_applications/#delete-an-app-authorization octokit.apps.deleteAuthorization({ client_id, access_token }); -// https://developer.github.com/v3/apps/oauth_applications/#revoke-a-grant-for-an-application -octokit.apps.revokeGrantForApplication({ client_id, access_token }); - -// DEPRECATED: octokit.oauthAuthorizations.revokeGrantForApplication() has been renamed to octokit.apps.revokeGrantForApplication() -octokit.oauthAuthorizations.revokeGrantForApplication({ - client_id, - access_token -}); - // https://developer.github.com/v3/apps/oauth_applications/#check-a-token octokit.apps.checkToken({ client_id, access_token }); @@ -97,90 +79,9 @@ octokit.apps.resetToken({ client_id, access_token }); // https://developer.github.com/v3/apps/oauth_applications/#delete-an-app-token octokit.apps.deleteToken({ client_id, access_token }); -// https://developer.github.com/v3/apps/oauth_applications/#check-an-authorization -octokit.apps.checkAuthorization({ client_id, access_token }); - -// DEPRECATED: octokit.oauthAuthorizations.checkAuthorization() has been renamed to octokit.apps.checkAuthorization() -octokit.oauthAuthorizations.checkAuthorization({ client_id, access_token }); - -// https://developer.github.com/v3/apps/oauth_applications/#reset-an-authorization -octokit.apps.resetAuthorization({ client_id, access_token }); - -// DEPRECATED: octokit.oauthAuthorizations.resetAuthorization() has been renamed to octokit.apps.resetAuthorization() -octokit.oauthAuthorizations.resetAuthorization({ client_id, access_token }); - -// https://developer.github.com/v3/apps/oauth_applications/#revoke-an-authorization-for-an-application -octokit.apps.revokeAuthorizationForApplication({ client_id, access_token }); - -// DEPRECATED: octokit.oauthAuthorizations.revokeAuthorizationForApplication() has been renamed to octokit.apps.revokeAuthorizationForApplication() -octokit.oauthAuthorizations.revokeAuthorizationForApplication({ - client_id, - access_token -}); - // https://developer.github.com/v3/apps/#get-a-single-github-app octokit.apps.getBySlug({ app_slug }); -// https://developer.github.com/v3/oauth_authorizations/#list-your-authorizations -octokit.oauthAuthorizations.listAuthorizations(); - -// https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization -octokit.oauthAuthorizations.createAuthorization({ - scopes, - note, - note_url, - client_id, - client_secret, - fingerprint -}); - -// https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app -octokit.oauthAuthorizations.getOrCreateAuthorizationForApp({ - client_id, - client_secret, - scopes, - note, - note_url, - fingerprint -}); - -// https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint -octokit.oauthAuthorizations.getOrCreateAuthorizationForAppAndFingerprint({ - client_id, - fingerprint, - client_secret, - scopes, - note, - note_url -}); - -// DEPRECATED: octokit.oauthAuthorizations.getOrCreateAuthorizationForAppFingerprint() has been renamed to octokit.oauthAuthorizations.getOrCreateAuthorizationForAppAndFingerprint() -octokit.oauthAuthorizations.getOrCreateAuthorizationForAppFingerprint({ - client_id, - fingerprint, - client_secret, - scopes, - note, - note_url -}); - -// https://developer.github.com/v3/oauth_authorizations/#get-a-single-authorization -octokit.oauthAuthorizations.getAuthorization({ authorization_id }); - -// https://developer.github.com/v3/oauth_authorizations/#update-an-existing-authorization -octokit.oauthAuthorizations.updateAuthorization({ - authorization_id, - scopes, - add_scopes, - remove_scopes, - note, - note_url, - fingerprint -}); - -// https://developer.github.com/v3/oauth_authorizations/#delete-an-authorization -octokit.oauthAuthorizations.deleteAuthorization({ authorization_id }); - // https://developer.github.com/v3/codes_of_conduct/#list-all-codes-of-conduct octokit.codesOfConduct.listConductCodes(); @@ -274,9 +175,6 @@ octokit.issues.list({ filter, state, labels, sort, direction, since }); // https://developer.github.com/v3/licenses/#list-commonly-used-licenses octokit.licenses.listCommonlyUsed(); -// DEPRECATED: octokit.licenses.list() has been renamed to octokit.licenses.listCommonlyUsed() -octokit.licenses.list(); - // https://developer.github.com/v3/licenses/#get-an-individual-license octokit.licenses.get({ license }); @@ -392,9 +290,6 @@ octokit.orgs.pingHook({ org, hook_id }); // https://developer.github.com/v3/apps/#get-an-organization-installation octokit.apps.getOrgInstallation({ org }); -// DEPRECATED: octokit.apps.findOrgInstallation() has been renamed to octokit.apps.getOrgInstallation() -octokit.apps.findOrgInstallation({ org }); - // https://developer.github.com/v3/orgs/#list-installations-for-an-organization octokit.orgs.listInstallations({ org }); @@ -462,9 +357,6 @@ octokit.migrations.getStatusForOrg({ org, migration_id }); // https://developer.github.com/v3/migrations/orgs/#download-an-organization-migration-archive octokit.migrations.downloadArchiveForOrg({ org, migration_id }); -// DEPRECATED: octokit.migrations.getArchiveForOrg() has been renamed to octokit.migrations.downloadArchiveForOrg() -octokit.migrations.getArchiveForOrg({ org, migration_id }); - // https://developer.github.com/v3/migrations/orgs/#delete-an-organization-migration-archive octokit.migrations.deleteArchiveForOrg({ org, migration_id }); @@ -1037,9 +929,6 @@ octokit.repos.removeProtectedBranchRestrictions({ owner, repo, branch }); // https://developer.github.com/v3/repos/branches/#list-apps-with-access-to-protected-branch octokit.repos.getAppsWithAccessToProtectedBranch({ owner, repo, branch }); -// DEPRECATED: octokit.repos.listAppsWithAccessToProtectedBranch() has been renamed to octokit.repos.getAppsWithAccessToProtectedBranch() -octokit.repos.listAppsWithAccessToProtectedBranch({ owner, repo, branch }); - // https://developer.github.com/v3/repos/branches/#replace-app-restrictions-of-protected-branch octokit.repos.replaceProtectedBranchAppRestrictions({ owner, @@ -1062,12 +951,6 @@ octokit.repos.removeProtectedBranchAppRestrictions({ // https://developer.github.com/v3/repos/branches/#list-teams-with-access-to-protected-branch octokit.repos.getTeamsWithAccessToProtectedBranch({ owner, repo, branch }); -// DEPRECATED: octokit.repos.listProtectedBranchTeamRestrictions() has been renamed to octokit.repos.getTeamsWithAccessToProtectedBranch() -octokit.repos.listProtectedBranchTeamRestrictions({ owner, repo, branch }); - -// DEPRECATED: octokit.repos.listTeamsWithAccessToProtectedBranch() has been renamed to octokit.repos.getTeamsWithAccessToProtectedBranch() -octokit.repos.listTeamsWithAccessToProtectedBranch({ owner, repo, branch }); - // https://developer.github.com/v3/repos/branches/#replace-team-restrictions-of-protected-branch octokit.repos.replaceProtectedBranchTeamRestrictions({ owner, @@ -1095,12 +978,6 @@ octokit.repos.removeProtectedBranchTeamRestrictions({ // https://developer.github.com/v3/repos/branches/#list-users-with-access-to-protected-branch octokit.repos.getUsersWithAccessToProtectedBranch({ owner, repo, branch }); -// DEPRECATED: octokit.repos.listProtectedBranchUserRestrictions() has been renamed to octokit.repos.getUsersWithAccessToProtectedBranch() -octokit.repos.listProtectedBranchUserRestrictions({ owner, repo, branch }); - -// DEPRECATED: octokit.repos.listUsersWithAccessToProtectedBranch() has been renamed to octokit.repos.getUsersWithAccessToProtectedBranch() -octokit.repos.listUsersWithAccessToProtectedBranch({ owner, repo, branch }); - // https://developer.github.com/v3/repos/branches/#replace-user-restrictions-of-protected-branch octokit.repos.replaceProtectedBranchUserRestrictions({ owner, @@ -1281,32 +1158,6 @@ octokit.repos.createOrUpdateFile({ author }); -// DEPRECATED: octokit.repos.createFile() has been renamed to octokit.repos.createOrUpdateFile() -octokit.repos.createFile({ - owner, - repo, - path, - message, - content, - sha, - branch, - committer, - author -}); - -// DEPRECATED: octokit.repos.updateFile() has been renamed to octokit.repos.createOrUpdateFile() -octokit.repos.updateFile({ - owner, - repo, - path, - message, - content, - sha, - branch, - committer, - author -}); - // https://developer.github.com/v3/repos/contents/#delete-a-file octokit.repos.deleteFile({ owner, @@ -1497,9 +1348,6 @@ octokit.migrations.setLfsPreference({ owner, repo, use_lfs }); // https://developer.github.com/v3/apps/#get-a-repository-installation octokit.apps.getRepoInstallation({ owner, repo }); -// DEPRECATED: octokit.apps.findRepoInstallation() has been renamed to octokit.apps.getRepoInstallation() -octokit.apps.findRepoInstallation({ owner, repo }); - // https://developer.github.com/v3/interactions/repos/#get-interaction-restrictions-for-a-repository octokit.interactions.getRestrictionsForRepo({ owner, repo }); @@ -1823,24 +1671,7 @@ octokit.pulls.createComment({ side, line, start_line, - start_side, - in_reply_to -}); - -// DEPRECATED: octokit.pulls.createCommentReply() has been renamed to octokit.pulls.createComment() -octokit.pulls.createCommentReply({ - owner, - repo, - pull_number, - body, - commit_id, - path, - position, - side, - line, - start_line, - start_side, - in_reply_to + start_side }); // https://developer.github.com/v3/pulls/comments/#create-a-review-comment-reply @@ -2103,9 +1934,6 @@ octokit.search.commits({ q, sort, order }); // https://developer.github.com/v3/search/#search-issues-and-pull-requests octokit.search.issuesAndPullRequests({ q, sort, order }); -// DEPRECATED: octokit.search.issues() has been renamed to octokit.search.issuesAndPullRequests() -octokit.search.issues({ q, sort, order }); - // https://developer.github.com/v3/search/#search-labels octokit.search.labels({ repository_id, q, sort, order }); @@ -2118,299 +1946,6 @@ octokit.search.topics({ q }); // https://developer.github.com/v3/search/#search-users octokit.search.users({ q, sort, order }); -// https://developer.github.com/v3/teams/#get-team-legacy -octokit.teams.getLegacy({ team_id }); - -// DEPRECATED: octokit.teams.get() has been renamed to octokit.teams.getLegacy() -octokit.teams.get({ team_id }); - -// https://developer.github.com/v3/teams/#edit-team-legacy -octokit.teams.updateLegacy({ - team_id, - name, - description, - privacy, - permission, - parent_team_id -}); - -// DEPRECATED: octokit.teams.update() has been renamed to octokit.teams.updateLegacy() -octokit.teams.update({ - team_id, - name, - description, - privacy, - permission, - parent_team_id -}); - -// https://developer.github.com/v3/teams/#delete-team-legacy -octokit.teams.deleteLegacy({ team_id }); - -// DEPRECATED: octokit.teams.delete() has been renamed to octokit.teams.deleteLegacy() -octokit.teams.delete({ team_id }); - -// https://developer.github.com/v3/teams/discussions/#list-discussions-legacy -octokit.teams.listDiscussionsLegacy({ team_id, direction }); - -// DEPRECATED: octokit.teams.listDiscussions() has been renamed to octokit.teams.listDiscussionsLegacy() -octokit.teams.listDiscussions({ team_id, direction }); - -// https://developer.github.com/v3/teams/discussions/#create-a-discussion-legacy -octokit.teams.createDiscussionLegacy({ team_id, title, body, private }); - -// DEPRECATED: octokit.teams.createDiscussion() has been renamed to octokit.teams.createDiscussionLegacy() -octokit.teams.createDiscussion({ team_id, title, body, private }); - -// https://developer.github.com/v3/teams/discussions/#get-a-single-discussion-legacy -octokit.teams.getDiscussionLegacy({ team_id, discussion_number }); - -// DEPRECATED: octokit.teams.getDiscussion() has been renamed to octokit.teams.getDiscussionLegacy() -octokit.teams.getDiscussion({ team_id, discussion_number }); - -// https://developer.github.com/v3/teams/discussions/#edit-a-discussion-legacy -octokit.teams.updateDiscussionLegacy({ - team_id, - discussion_number, - title, - body -}); - -// DEPRECATED: octokit.teams.updateDiscussion() has been renamed to octokit.teams.updateDiscussionLegacy() -octokit.teams.updateDiscussion({ team_id, discussion_number, title, body }); - -// https://developer.github.com/v3/teams/discussions/#delete-a-discussion-legacy -octokit.teams.deleteDiscussionLegacy({ team_id, discussion_number }); - -// DEPRECATED: octokit.teams.deleteDiscussion() has been renamed to octokit.teams.deleteDiscussionLegacy() -octokit.teams.deleteDiscussion({ team_id, discussion_number }); - -// https://developer.github.com/v3/teams/discussion_comments/#list-comments-legacy -octokit.teams.listDiscussionCommentsLegacy({ - team_id, - discussion_number, - direction -}); - -// DEPRECATED: octokit.teams.listDiscussionComments() has been renamed to octokit.teams.listDiscussionCommentsLegacy() -octokit.teams.listDiscussionComments({ team_id, discussion_number, direction }); - -// https://developer.github.com/v3/teams/discussion_comments/#create-a-comment-legacy -octokit.teams.createDiscussionCommentLegacy({ - team_id, - discussion_number, - body -}); - -// DEPRECATED: octokit.teams.createDiscussionComment() has been renamed to octokit.teams.createDiscussionCommentLegacy() -octokit.teams.createDiscussionComment({ team_id, discussion_number, body }); - -// https://developer.github.com/v3/teams/discussion_comments/#get-a-single-comment-legacy -octokit.teams.getDiscussionCommentLegacy({ - team_id, - discussion_number, - comment_number -}); - -// DEPRECATED: octokit.teams.getDiscussionComment() has been renamed to octokit.teams.getDiscussionCommentLegacy() -octokit.teams.getDiscussionComment({ - team_id, - discussion_number, - comment_number -}); - -// https://developer.github.com/v3/teams/discussion_comments/#edit-a-comment-legacy -octokit.teams.updateDiscussionCommentLegacy({ - team_id, - discussion_number, - comment_number, - body -}); - -// DEPRECATED: octokit.teams.updateDiscussionComment() has been renamed to octokit.teams.updateDiscussionCommentLegacy() -octokit.teams.updateDiscussionComment({ - team_id, - discussion_number, - comment_number, - body -}); - -// https://developer.github.com/v3/teams/discussion_comments/#delete-a-comment-legacy -octokit.teams.deleteDiscussionCommentLegacy({ - team_id, - discussion_number, - comment_number -}); - -// DEPRECATED: octokit.teams.deleteDiscussionComment() has been renamed to octokit.teams.deleteDiscussionCommentLegacy() -octokit.teams.deleteDiscussionComment({ - team_id, - discussion_number, - comment_number -}); - -// https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-comment-legacy -octokit.reactions.listForTeamDiscussionCommentLegacy({ - team_id, - discussion_number, - comment_number, - content -}); - -// DEPRECATED: octokit.reactions.listForTeamDiscussionComment() has been renamed to octokit.reactions.listForTeamDiscussionCommentLegacy() -octokit.reactions.listForTeamDiscussionComment({ - team_id, - discussion_number, - comment_number, - content -}); - -// https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-comment-legacy -octokit.reactions.createForTeamDiscussionCommentLegacy({ - team_id, - discussion_number, - comment_number, - content -}); - -// DEPRECATED: octokit.reactions.createForTeamDiscussionComment() has been renamed to octokit.reactions.createForTeamDiscussionCommentLegacy() -octokit.reactions.createForTeamDiscussionComment({ - team_id, - discussion_number, - comment_number, - content -}); - -// https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-legacy -octokit.reactions.listForTeamDiscussionLegacy({ - team_id, - discussion_number, - content -}); - -// DEPRECATED: octokit.reactions.listForTeamDiscussion() has been renamed to octokit.reactions.listForTeamDiscussionLegacy() -octokit.reactions.listForTeamDiscussion({ - team_id, - discussion_number, - content -}); - -// https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-legacy -octokit.reactions.createForTeamDiscussionLegacy({ - team_id, - discussion_number, - content -}); - -// DEPRECATED: octokit.reactions.createForTeamDiscussion() has been renamed to octokit.reactions.createForTeamDiscussionLegacy() -octokit.reactions.createForTeamDiscussion({ - team_id, - discussion_number, - content -}); - -// https://developer.github.com/v3/teams/members/#list-pending-team-invitations-legacy -octokit.teams.listPendingInvitationsLegacy({ team_id }); - -// DEPRECATED: octokit.teams.listPendingInvitations() has been renamed to octokit.teams.listPendingInvitationsLegacy() -octokit.teams.listPendingInvitations({ team_id }); - -// https://developer.github.com/v3/teams/members/#list-team-members-legacy -octokit.teams.listMembersLegacy({ team_id, role }); - -// DEPRECATED: octokit.teams.listMembers() has been renamed to octokit.teams.listMembersLegacy() -octokit.teams.listMembers({ team_id, role }); - -// https://developer.github.com/v3/teams/members/#get-team-member-legacy -octokit.teams.getMemberLegacy({ team_id, username }); - -// DEPRECATED: octokit.teams.getMember() has been renamed to octokit.teams.getMemberLegacy() -octokit.teams.getMember({ team_id, username }); - -// https://developer.github.com/v3/teams/members/#add-team-member-legacy -octokit.teams.addMemberLegacy({ team_id, username }); - -// DEPRECATED: octokit.teams.addMember() has been renamed to octokit.teams.addMemberLegacy() -octokit.teams.addMember({ team_id, username }); - -// https://developer.github.com/v3/teams/members/#remove-team-member-legacy -octokit.teams.removeMemberLegacy({ team_id, username }); - -// DEPRECATED: octokit.teams.removeMember() has been renamed to octokit.teams.removeMemberLegacy() -octokit.teams.removeMember({ team_id, username }); - -// https://developer.github.com/v3/teams/members/#get-team-membership-legacy -octokit.teams.getMembershipLegacy({ team_id, username }); - -// DEPRECATED: octokit.teams.getMembership() has been renamed to octokit.teams.getMembershipLegacy() -octokit.teams.getMembership({ team_id, username }); - -// https://developer.github.com/v3/teams/members/#add-or-update-team-membership-legacy -octokit.teams.addOrUpdateMembershipLegacy({ team_id, username, role }); - -// DEPRECATED: octokit.teams.addOrUpdateMembership() has been renamed to octokit.teams.addOrUpdateMembershipLegacy() -octokit.teams.addOrUpdateMembership({ team_id, username, role }); - -// https://developer.github.com/v3/teams/members/#remove-team-membership-legacy -octokit.teams.removeMembershipLegacy({ team_id, username }); - -// DEPRECATED: octokit.teams.removeMembership() has been renamed to octokit.teams.removeMembershipLegacy() -octokit.teams.removeMembership({ team_id, username }); - -// https://developer.github.com/v3/teams/#list-team-projects-legacy -octokit.teams.listProjectsLegacy({ team_id }); - -// DEPRECATED: octokit.teams.listProjects() has been renamed to octokit.teams.listProjectsLegacy() -octokit.teams.listProjects({ team_id }); - -// https://developer.github.com/v3/teams/#review-a-team-project-legacy -octokit.teams.reviewProjectLegacy({ team_id, project_id }); - -// DEPRECATED: octokit.teams.reviewProject() has been renamed to octokit.teams.reviewProjectLegacy() -octokit.teams.reviewProject({ team_id, project_id }); - -// https://developer.github.com/v3/teams/#add-or-update-team-project-legacy -octokit.teams.addOrUpdateProjectLegacy({ team_id, project_id, permission }); - -// DEPRECATED: octokit.teams.addOrUpdateProject() has been renamed to octokit.teams.addOrUpdateProjectLegacy() -octokit.teams.addOrUpdateProject({ team_id, project_id, permission }); - -// https://developer.github.com/v3/teams/#remove-team-project-legacy -octokit.teams.removeProjectLegacy({ team_id, project_id }); - -// DEPRECATED: octokit.teams.removeProject() has been renamed to octokit.teams.removeProjectLegacy() -octokit.teams.removeProject({ team_id, project_id }); - -// https://developer.github.com/v3/teams/#list-team-repos-legacy -octokit.teams.listReposLegacy({ team_id }); - -// DEPRECATED: octokit.teams.listRepos() has been renamed to octokit.teams.listReposLegacy() -octokit.teams.listRepos({ team_id }); - -// https://developer.github.com/v3/teams/#check-if-a-team-manages-a-repository-legacy -octokit.teams.checkManagesRepoLegacy({ team_id, owner, repo }); - -// DEPRECATED: octokit.teams.checkManagesRepo() has been renamed to octokit.teams.checkManagesRepoLegacy() -octokit.teams.checkManagesRepo({ team_id, owner, repo }); - -// https://developer.github.com/v3/teams/#add-or-update-team-repository-legacy -octokit.teams.addOrUpdateRepoLegacy({ team_id, owner, repo, permission }); - -// DEPRECATED: octokit.teams.addOrUpdateRepo() has been renamed to octokit.teams.addOrUpdateRepoLegacy() -octokit.teams.addOrUpdateRepo({ team_id, owner, repo, permission }); - -// https://developer.github.com/v3/teams/#remove-team-repository-legacy -octokit.teams.removeRepoLegacy({ team_id, owner, repo }); - -// DEPRECATED: octokit.teams.removeRepo() has been renamed to octokit.teams.removeRepoLegacy() -octokit.teams.removeRepo({ team_id, owner, repo }); - -// https://developer.github.com/v3/teams/#list-child-teams-legacy -octokit.teams.listChildLegacy({ team_id }); - -// DEPRECATED: octokit.teams.listChild() has been renamed to octokit.teams.listChildLegacy() -octokit.teams.listChild({ team_id }); - // https://developer.github.com/v3/users/#get-the-authenticated-user octokit.users.getAuthenticated(); @@ -2646,9 +2181,6 @@ octokit.users.getContextForUser({ username, subject_type, subject_id }); // https://developer.github.com/v3/apps/#get-a-user-installation octokit.apps.getUserInstallation({ username }); -// DEPRECATED: octokit.apps.findUserInstallation() has been renamed to octokit.apps.getUserInstallation() -octokit.apps.findUserInstallation({ username }); - // https://developer.github.com/v3/users/keys/#list-public-keys-for-a-user octokit.users.listPublicKeysForUser({ username }); @@ -2672,38 +2204,6 @@ octokit.activity.listReposStarredByUser({ username, sort, direction }); // https://developer.github.com/v3/activity/watching/#list-repositories-being-watched octokit.activity.listReposWatchedByUser({ username }); - -// https://developer.github.com/v3/repos/commits/#get-a-single-commit -octokit.repos.getCommitRefSha({ owner, ref, repo }); - -// https://developer.github.com/v3/git/refs/#get-all-references -octokit.git.listRefs({ owner, repo, namespace }); - -// https://developer.github.com/v3/issues/labels/#update-a-label -octokit.issues.updateLabel({ - owner, - repo, - current_name, - color, - name, - description -}); - -// https://developer.github.com/v3/pulls/#create-a-pull-request -octokit.pulls.createFromIssue({ - owner, - repo, - base, - draft, - head, - issue, - maintainer_can_modify, - owner, - repo -}); - -// https://developer.github.com/v3/repos/releases/#upload-a-release-asset -octokit.repos.uploadReleaseAsset({ data, headers, label, name, url }); ``` There is one method for each REST API endpoint documented at [https://developer.github.com/v3](https://developer.github.com/v3). diff --git a/package-lock.json b/package-lock.json index f7ec60036..35d8b2a06 100644 --- a/package-lock.json +++ b/package-lock.json @@ -48,53 +48,226 @@ } }, "@babel/helper-annotate-as-pure": { - "version": "7.7.0", - "resolved": "https://registry.npmjs.org/@babel/helper-annotate-as-pure/-/helper-annotate-as-pure-7.7.0.tgz", - "integrity": "sha512-k50CQxMlYTYo+GGyUGFwpxKVtxVJi9yh61sXZji3zYHccK9RYliZGSTOgci85T+r+0VFN2nWbGM04PIqwfrpMg==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-annotate-as-pure/-/helper-annotate-as-pure-7.7.4.tgz", + "integrity": "sha512-2BQmQgECKzYKFPpiycoF9tlb5HA4lrVyAmLLVK177EcQAqjVLciUb2/R+n1boQ9y5ENV3uz2ZqiNw7QMBBw1Og==", "dev": true, "requires": { - "@babel/types": "^7.7.0" + "@babel/types": "^7.7.4" + }, + "dependencies": { + "@babel/types": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.7.4.tgz", + "integrity": "sha512-cz5Ji23KCi4T+YIE/BolWosrJuSmoZeN1EFnRtBwF+KKLi8GG/Z2c2hOJJeCXPk4mwk4QFvTmwIodJowXgttRA==", + "dev": true, + "requires": { + "esutils": "^2.0.2", + "lodash": "^4.17.13", + "to-fast-properties": "^2.0.0" + } + } } }, "@babel/helper-builder-binary-assignment-operator-visitor": { - "version": "7.7.0", - "resolved": "https://registry.npmjs.org/@babel/helper-builder-binary-assignment-operator-visitor/-/helper-builder-binary-assignment-operator-visitor-7.7.0.tgz", - "integrity": "sha512-Cd8r8zs4RKDwMG/92lpZcnn5WPQ3LAMQbCw42oqUh4s7vsSN5ANUZjMel0OOnxDLq57hoDDbai+ryygYfCTOsw==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-builder-binary-assignment-operator-visitor/-/helper-builder-binary-assignment-operator-visitor-7.7.4.tgz", + "integrity": "sha512-Biq/d/WtvfftWZ9Uf39hbPBYDUo986m5Bb4zhkeYDGUllF43D+nUe5M6Vuo6/8JDK/0YX/uBdeoQpyaNhNugZQ==", "dev": true, "requires": { - "@babel/helper-explode-assignable-expression": "^7.7.0", - "@babel/types": "^7.7.0" + "@babel/helper-explode-assignable-expression": "^7.7.4", + "@babel/types": "^7.7.4" + }, + "dependencies": { + "@babel/types": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.7.4.tgz", + "integrity": "sha512-cz5Ji23KCi4T+YIE/BolWosrJuSmoZeN1EFnRtBwF+KKLi8GG/Z2c2hOJJeCXPk4mwk4QFvTmwIodJowXgttRA==", + "dev": true, + "requires": { + "esutils": "^2.0.2", + "lodash": "^4.17.13", + "to-fast-properties": "^2.0.0" + } + } } }, "@babel/helper-call-delegate": { - "version": "7.7.0", - "resolved": "https://registry.npmjs.org/@babel/helper-call-delegate/-/helper-call-delegate-7.7.0.tgz", - "integrity": "sha512-Su0Mdq7uSSWGZayGMMQ+z6lnL00mMCnGAbO/R0ZO9odIdB/WNU/VfQKqMQU0fdIsxQYbRjDM4BixIa93SQIpvw==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-call-delegate/-/helper-call-delegate-7.7.4.tgz", + "integrity": "sha512-8JH9/B7J7tCYJ2PpWVpw9JhPuEVHztagNVuQAFBVFYluRMlpG7F1CgKEgGeL6KFqcsIa92ZYVj6DSc0XwmN1ZA==", "dev": true, "requires": { - "@babel/helper-hoist-variables": "^7.7.0", - "@babel/traverse": "^7.7.0", - "@babel/types": "^7.7.0" + "@babel/helper-hoist-variables": "^7.7.4", + "@babel/traverse": "^7.7.4", + "@babel/types": "^7.7.4" + }, + "dependencies": { + "@babel/generator": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/generator/-/generator-7.7.4.tgz", + "integrity": "sha512-m5qo2WgdOJeyYngKImbkyQrnUN1mPceaG5BV+G0E3gWsa4l/jCSryWJdM2x8OuGAOyh+3d5pVYfZWCiNFtynxg==", + "dev": true, + "requires": { + "@babel/types": "^7.7.4", + "jsesc": "^2.5.1", + "lodash": "^4.17.13", + "source-map": "^0.5.0" + } + }, + "@babel/helper-function-name": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-function-name/-/helper-function-name-7.7.4.tgz", + "integrity": "sha512-AnkGIdiBhEuiwdoMnKm7jfPfqItZhgRaZfMg1XX3bS25INOnLPjPG1Ppnajh8eqgt5kPJnfqrRHqFqmjKDZLzQ==", + "dev": true, + "requires": { + "@babel/helper-get-function-arity": "^7.7.4", + "@babel/template": "^7.7.4", + "@babel/types": "^7.7.4" + } + }, + "@babel/helper-get-function-arity": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-get-function-arity/-/helper-get-function-arity-7.7.4.tgz", + "integrity": "sha512-QTGKEdCkjgzgfJ3bAyRwF4yyT3pg+vDgan8DSivq1eS0gwi+KGKE5x8kRcbeFTb/673mkO5SN1IZfmCfA5o+EA==", + "dev": true, + "requires": { + "@babel/types": "^7.7.4" + } + }, + "@babel/helper-split-export-declaration": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-split-export-declaration/-/helper-split-export-declaration-7.7.4.tgz", + "integrity": "sha512-guAg1SXFcVr04Guk9eq0S4/rWS++sbmyqosJzVs8+1fH5NI+ZcmkaSkc7dmtAFbHFva6yRJnjW3yAcGxjueDug==", + "dev": true, + "requires": { + "@babel/types": "^7.7.4" + } + }, + "@babel/parser": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.7.4.tgz", + "integrity": "sha512-jIwvLO0zCL+O/LmEJQjWA75MQTWwx3c3u2JOTDK5D3/9egrWRRA0/0hk9XXywYnXZVVpzrBYeIQTmhwUaePI9g==", + "dev": true + }, + "@babel/template": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/template/-/template-7.7.4.tgz", + "integrity": "sha512-qUzihgVPguAzXCK7WXw8pqs6cEwi54s3E+HrejlkuWO6ivMKx9hZl3Y2fSXp9i5HgyWmj7RKP+ulaYnKM4yYxw==", + "dev": true, + "requires": { + "@babel/code-frame": "^7.0.0", + "@babel/parser": "^7.7.4", + "@babel/types": "^7.7.4" + } + }, + "@babel/traverse": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/traverse/-/traverse-7.7.4.tgz", + "integrity": "sha512-P1L58hQyupn8+ezVA2z5KBm4/Zr4lCC8dwKCMYzsa5jFMDMQAzaBNy9W5VjB+KAmBjb40U7a/H6ao+Xo+9saIw==", + "dev": true, + "requires": { + "@babel/code-frame": "^7.5.5", + "@babel/generator": "^7.7.4", + "@babel/helper-function-name": "^7.7.4", + "@babel/helper-split-export-declaration": "^7.7.4", + "@babel/parser": "^7.7.4", + "@babel/types": "^7.7.4", + "debug": "^4.1.0", + "globals": "^11.1.0", + "lodash": "^4.17.13" + } + }, + "@babel/types": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.7.4.tgz", + "integrity": "sha512-cz5Ji23KCi4T+YIE/BolWosrJuSmoZeN1EFnRtBwF+KKLi8GG/Z2c2hOJJeCXPk4mwk4QFvTmwIodJowXgttRA==", + "dev": true, + "requires": { + "esutils": "^2.0.2", + "lodash": "^4.17.13", + "to-fast-properties": "^2.0.0" + } + } } }, "@babel/helper-create-class-features-plugin": { - "version": "7.7.0", - "resolved": "https://registry.npmjs.org/@babel/helper-create-class-features-plugin/-/helper-create-class-features-plugin-7.7.0.tgz", - "integrity": "sha512-MZiB5qvTWoyiFOgootmRSDV1udjIqJW/8lmxgzKq6oDqxdmHUjeP2ZUOmgHdYjmUVNABqRrHjYAYRvj8Eox/UA==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-create-class-features-plugin/-/helper-create-class-features-plugin-7.7.4.tgz", + "integrity": "sha512-l+OnKACG4uiDHQ/aJT8dwpR+LhCJALxL0mJ6nzjB25e5IPwqV1VOsY7ah6UB1DG+VOXAIMtuC54rFJGiHkxjgA==", "dev": true, "requires": { - "@babel/helper-function-name": "^7.7.0", - "@babel/helper-member-expression-to-functions": "^7.7.0", - "@babel/helper-optimise-call-expression": "^7.7.0", + "@babel/helper-function-name": "^7.7.4", + "@babel/helper-member-expression-to-functions": "^7.7.4", + "@babel/helper-optimise-call-expression": "^7.7.4", "@babel/helper-plugin-utils": "^7.0.0", - "@babel/helper-replace-supers": "^7.7.0", - "@babel/helper-split-export-declaration": "^7.7.0" + "@babel/helper-replace-supers": "^7.7.4", + "@babel/helper-split-export-declaration": "^7.7.4" + }, + "dependencies": { + "@babel/helper-function-name": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-function-name/-/helper-function-name-7.7.4.tgz", + "integrity": "sha512-AnkGIdiBhEuiwdoMnKm7jfPfqItZhgRaZfMg1XX3bS25INOnLPjPG1Ppnajh8eqgt5kPJnfqrRHqFqmjKDZLzQ==", + "dev": true, + "requires": { + "@babel/helper-get-function-arity": "^7.7.4", + "@babel/template": "^7.7.4", + "@babel/types": "^7.7.4" + } + }, + "@babel/helper-get-function-arity": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-get-function-arity/-/helper-get-function-arity-7.7.4.tgz", + "integrity": "sha512-QTGKEdCkjgzgfJ3bAyRwF4yyT3pg+vDgan8DSivq1eS0gwi+KGKE5x8kRcbeFTb/673mkO5SN1IZfmCfA5o+EA==", + "dev": true, + "requires": { + "@babel/types": "^7.7.4" + } + }, + "@babel/helper-split-export-declaration": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-split-export-declaration/-/helper-split-export-declaration-7.7.4.tgz", + "integrity": "sha512-guAg1SXFcVr04Guk9eq0S4/rWS++sbmyqosJzVs8+1fH5NI+ZcmkaSkc7dmtAFbHFva6yRJnjW3yAcGxjueDug==", + "dev": true, + "requires": { + "@babel/types": "^7.7.4" + } + }, + "@babel/parser": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.7.4.tgz", + "integrity": "sha512-jIwvLO0zCL+O/LmEJQjWA75MQTWwx3c3u2JOTDK5D3/9egrWRRA0/0hk9XXywYnXZVVpzrBYeIQTmhwUaePI9g==", + "dev": true + }, + "@babel/template": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/template/-/template-7.7.4.tgz", + "integrity": "sha512-qUzihgVPguAzXCK7WXw8pqs6cEwi54s3E+HrejlkuWO6ivMKx9hZl3Y2fSXp9i5HgyWmj7RKP+ulaYnKM4yYxw==", + "dev": true, + "requires": { + "@babel/code-frame": "^7.0.0", + "@babel/parser": "^7.7.4", + "@babel/types": "^7.7.4" + } + }, + "@babel/types": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.7.4.tgz", + "integrity": "sha512-cz5Ji23KCi4T+YIE/BolWosrJuSmoZeN1EFnRtBwF+KKLi8GG/Z2c2hOJJeCXPk4mwk4QFvTmwIodJowXgttRA==", + "dev": true, + "requires": { + "esutils": "^2.0.2", + "lodash": "^4.17.13", + "to-fast-properties": "^2.0.0" + } + } } }, "@babel/helper-create-regexp-features-plugin": { - "version": "7.7.2", - "resolved": "https://registry.npmjs.org/@babel/helper-create-regexp-features-plugin/-/helper-create-regexp-features-plugin-7.7.2.tgz", - "integrity": "sha512-pAil/ZixjTlrzNpjx+l/C/wJk002Wo7XbbZ8oujH/AoJ3Juv0iN/UTcPUHXKMFLqsfS0Hy6Aow8M31brUYBlQQ==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-create-regexp-features-plugin/-/helper-create-regexp-features-plugin-7.7.4.tgz", + "integrity": "sha512-Mt+jBKaxL0zfOIWrfQpnfYCN7/rS6GKx6CCCfuoqVVd+17R8zNDlzVYmIi9qyb2wOk002NsmSTDymkIygDUH7A==", "dev": true, "requires": { "@babel/helper-regex": "^7.4.4", @@ -102,24 +275,162 @@ } }, "@babel/helper-define-map": { - "version": "7.7.0", - "resolved": "https://registry.npmjs.org/@babel/helper-define-map/-/helper-define-map-7.7.0.tgz", - "integrity": "sha512-kPKWPb0dMpZi+ov1hJiwse9dWweZsz3V9rP4KdytnX1E7z3cTNmFGglwklzFPuqIcHLIY3bgKSs4vkwXXdflQA==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-define-map/-/helper-define-map-7.7.4.tgz", + "integrity": "sha512-v5LorqOa0nVQUvAUTUF3KPastvUt/HzByXNamKQ6RdJRTV7j8rLL+WB5C/MzzWAwOomxDhYFb1wLLxHqox86lg==", "dev": true, "requires": { - "@babel/helper-function-name": "^7.7.0", - "@babel/types": "^7.7.0", + "@babel/helper-function-name": "^7.7.4", + "@babel/types": "^7.7.4", "lodash": "^4.17.13" + }, + "dependencies": { + "@babel/helper-function-name": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-function-name/-/helper-function-name-7.7.4.tgz", + "integrity": "sha512-AnkGIdiBhEuiwdoMnKm7jfPfqItZhgRaZfMg1XX3bS25INOnLPjPG1Ppnajh8eqgt5kPJnfqrRHqFqmjKDZLzQ==", + "dev": true, + "requires": { + "@babel/helper-get-function-arity": "^7.7.4", + "@babel/template": "^7.7.4", + "@babel/types": "^7.7.4" + } + }, + "@babel/helper-get-function-arity": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-get-function-arity/-/helper-get-function-arity-7.7.4.tgz", + "integrity": "sha512-QTGKEdCkjgzgfJ3bAyRwF4yyT3pg+vDgan8DSivq1eS0gwi+KGKE5x8kRcbeFTb/673mkO5SN1IZfmCfA5o+EA==", + "dev": true, + "requires": { + "@babel/types": "^7.7.4" + } + }, + "@babel/parser": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.7.4.tgz", + "integrity": "sha512-jIwvLO0zCL+O/LmEJQjWA75MQTWwx3c3u2JOTDK5D3/9egrWRRA0/0hk9XXywYnXZVVpzrBYeIQTmhwUaePI9g==", + "dev": true + }, + "@babel/template": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/template/-/template-7.7.4.tgz", + "integrity": "sha512-qUzihgVPguAzXCK7WXw8pqs6cEwi54s3E+HrejlkuWO6ivMKx9hZl3Y2fSXp9i5HgyWmj7RKP+ulaYnKM4yYxw==", + "dev": true, + "requires": { + "@babel/code-frame": "^7.0.0", + "@babel/parser": "^7.7.4", + "@babel/types": "^7.7.4" + } + }, + "@babel/types": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.7.4.tgz", + "integrity": "sha512-cz5Ji23KCi4T+YIE/BolWosrJuSmoZeN1EFnRtBwF+KKLi8GG/Z2c2hOJJeCXPk4mwk4QFvTmwIodJowXgttRA==", + "dev": true, + "requires": { + "esutils": "^2.0.2", + "lodash": "^4.17.13", + "to-fast-properties": "^2.0.0" + } + } } }, "@babel/helper-explode-assignable-expression": { - "version": "7.7.0", - "resolved": "https://registry.npmjs.org/@babel/helper-explode-assignable-expression/-/helper-explode-assignable-expression-7.7.0.tgz", - "integrity": "sha512-CDs26w2shdD1urNUAji2RJXyBFCaR+iBEGnFz3l7maizMkQe3saVw9WtjG1tz8CwbjvlFnaSLVhgnu1SWaherg==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-explode-assignable-expression/-/helper-explode-assignable-expression-7.7.4.tgz", + "integrity": "sha512-2/SicuFrNSXsZNBxe5UGdLr+HZg+raWBLE9vC98bdYOKX/U6PY0mdGlYUJdtTDPSU0Lw0PNbKKDpwYHJLn2jLg==", "dev": true, "requires": { - "@babel/traverse": "^7.7.0", - "@babel/types": "^7.7.0" + "@babel/traverse": "^7.7.4", + "@babel/types": "^7.7.4" + }, + "dependencies": { + "@babel/generator": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/generator/-/generator-7.7.4.tgz", + "integrity": "sha512-m5qo2WgdOJeyYngKImbkyQrnUN1mPceaG5BV+G0E3gWsa4l/jCSryWJdM2x8OuGAOyh+3d5pVYfZWCiNFtynxg==", + "dev": true, + "requires": { + "@babel/types": "^7.7.4", + "jsesc": "^2.5.1", + "lodash": "^4.17.13", + "source-map": "^0.5.0" + } + }, + "@babel/helper-function-name": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-function-name/-/helper-function-name-7.7.4.tgz", + "integrity": "sha512-AnkGIdiBhEuiwdoMnKm7jfPfqItZhgRaZfMg1XX3bS25INOnLPjPG1Ppnajh8eqgt5kPJnfqrRHqFqmjKDZLzQ==", + "dev": true, + "requires": { + "@babel/helper-get-function-arity": "^7.7.4", + "@babel/template": "^7.7.4", + "@babel/types": "^7.7.4" + } + }, + "@babel/helper-get-function-arity": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-get-function-arity/-/helper-get-function-arity-7.7.4.tgz", + "integrity": "sha512-QTGKEdCkjgzgfJ3bAyRwF4yyT3pg+vDgan8DSivq1eS0gwi+KGKE5x8kRcbeFTb/673mkO5SN1IZfmCfA5o+EA==", + "dev": true, + "requires": { + "@babel/types": "^7.7.4" + } + }, + "@babel/helper-split-export-declaration": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-split-export-declaration/-/helper-split-export-declaration-7.7.4.tgz", + "integrity": "sha512-guAg1SXFcVr04Guk9eq0S4/rWS++sbmyqosJzVs8+1fH5NI+ZcmkaSkc7dmtAFbHFva6yRJnjW3yAcGxjueDug==", + "dev": true, + "requires": { + "@babel/types": "^7.7.4" + } + }, + "@babel/parser": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.7.4.tgz", + "integrity": "sha512-jIwvLO0zCL+O/LmEJQjWA75MQTWwx3c3u2JOTDK5D3/9egrWRRA0/0hk9XXywYnXZVVpzrBYeIQTmhwUaePI9g==", + "dev": true + }, + "@babel/template": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/template/-/template-7.7.4.tgz", + "integrity": "sha512-qUzihgVPguAzXCK7WXw8pqs6cEwi54s3E+HrejlkuWO6ivMKx9hZl3Y2fSXp9i5HgyWmj7RKP+ulaYnKM4yYxw==", + "dev": true, + "requires": { + "@babel/code-frame": "^7.0.0", + "@babel/parser": "^7.7.4", + "@babel/types": "^7.7.4" + } + }, + "@babel/traverse": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/traverse/-/traverse-7.7.4.tgz", + "integrity": "sha512-P1L58hQyupn8+ezVA2z5KBm4/Zr4lCC8dwKCMYzsa5jFMDMQAzaBNy9W5VjB+KAmBjb40U7a/H6ao+Xo+9saIw==", + "dev": true, + "requires": { + "@babel/code-frame": "^7.5.5", + "@babel/generator": "^7.7.4", + "@babel/helper-function-name": "^7.7.4", + "@babel/helper-split-export-declaration": "^7.7.4", + "@babel/parser": "^7.7.4", + "@babel/types": "^7.7.4", + "debug": "^4.1.0", + "globals": "^11.1.0", + "lodash": "^4.17.13" + } + }, + "@babel/types": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.7.4.tgz", + "integrity": "sha512-cz5Ji23KCi4T+YIE/BolWosrJuSmoZeN1EFnRtBwF+KKLi8GG/Z2c2hOJJeCXPk4mwk4QFvTmwIodJowXgttRA==", + "dev": true, + "requires": { + "esutils": "^2.0.2", + "lodash": "^4.17.13", + "to-fast-properties": "^2.0.0" + } + } } }, "@babel/helper-function-name": { @@ -143,53 +454,144 @@ } }, "@babel/helper-hoist-variables": { - "version": "7.7.0", - "resolved": "https://registry.npmjs.org/@babel/helper-hoist-variables/-/helper-hoist-variables-7.7.0.tgz", - "integrity": "sha512-LUe/92NqsDAkJjjCEWkNe+/PcpnisvnqdlRe19FahVapa4jndeuJ+FBiTX1rcAKWKcJGE+C3Q3tuEuxkSmCEiQ==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-hoist-variables/-/helper-hoist-variables-7.7.4.tgz", + "integrity": "sha512-wQC4xyvc1Jo/FnLirL6CEgPgPCa8M74tOdjWpRhQYapz5JC7u3NYU1zCVoVAGCE3EaIP9T1A3iW0WLJ+reZlpQ==", "dev": true, "requires": { - "@babel/types": "^7.7.0" + "@babel/types": "^7.7.4" + }, + "dependencies": { + "@babel/types": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.7.4.tgz", + "integrity": "sha512-cz5Ji23KCi4T+YIE/BolWosrJuSmoZeN1EFnRtBwF+KKLi8GG/Z2c2hOJJeCXPk4mwk4QFvTmwIodJowXgttRA==", + "dev": true, + "requires": { + "esutils": "^2.0.2", + "lodash": "^4.17.13", + "to-fast-properties": "^2.0.0" + } + } } }, "@babel/helper-member-expression-to-functions": { - "version": "7.7.0", - "resolved": "https://registry.npmjs.org/@babel/helper-member-expression-to-functions/-/helper-member-expression-to-functions-7.7.0.tgz", - "integrity": "sha512-QaCZLO2RtBcmvO/ekOLp8p7R5X2JriKRizeDpm5ChATAFWrrYDcDxPuCIBXKyBjY+i1vYSdcUTMIb8psfxHDPA==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-member-expression-to-functions/-/helper-member-expression-to-functions-7.7.4.tgz", + "integrity": "sha512-9KcA1X2E3OjXl/ykfMMInBK+uVdfIVakVe7W7Lg3wfXUNyS3Q1HWLFRwZIjhqiCGbslummPDnmb7vIekS0C1vw==", "dev": true, "requires": { - "@babel/types": "^7.7.0" + "@babel/types": "^7.7.4" + }, + "dependencies": { + "@babel/types": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.7.4.tgz", + "integrity": "sha512-cz5Ji23KCi4T+YIE/BolWosrJuSmoZeN1EFnRtBwF+KKLi8GG/Z2c2hOJJeCXPk4mwk4QFvTmwIodJowXgttRA==", + "dev": true, + "requires": { + "esutils": "^2.0.2", + "lodash": "^4.17.13", + "to-fast-properties": "^2.0.0" + } + } } }, "@babel/helper-module-imports": { - "version": "7.7.0", - "resolved": "https://registry.npmjs.org/@babel/helper-module-imports/-/helper-module-imports-7.7.0.tgz", - "integrity": "sha512-Dv3hLKIC1jyfTkClvyEkYP2OlkzNvWs5+Q8WgPbxM5LMeorons7iPP91JM+DU7tRbhqA1ZeooPaMFvQrn23RHw==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-module-imports/-/helper-module-imports-7.7.4.tgz", + "integrity": "sha512-dGcrX6K9l8258WFjyDLJwuVKxR4XZfU0/vTUgOQYWEnRD8mgr+p4d6fCUMq/ys0h4CCt/S5JhbvtyErjWouAUQ==", "dev": true, "requires": { - "@babel/types": "^7.7.0" + "@babel/types": "^7.7.4" + }, + "dependencies": { + "@babel/types": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.7.4.tgz", + "integrity": "sha512-cz5Ji23KCi4T+YIE/BolWosrJuSmoZeN1EFnRtBwF+KKLi8GG/Z2c2hOJJeCXPk4mwk4QFvTmwIodJowXgttRA==", + "dev": true, + "requires": { + "esutils": "^2.0.2", + "lodash": "^4.17.13", + "to-fast-properties": "^2.0.0" + } + } } }, "@babel/helper-module-transforms": { - "version": "7.7.0", - "resolved": "https://registry.npmjs.org/@babel/helper-module-transforms/-/helper-module-transforms-7.7.0.tgz", - "integrity": "sha512-rXEefBuheUYQyX4WjV19tuknrJFwyKw0HgzRwbkyTbB+Dshlq7eqkWbyjzToLrMZk/5wKVKdWFluiAsVkHXvuQ==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-module-transforms/-/helper-module-transforms-7.7.4.tgz", + "integrity": "sha512-ehGBu4mXrhs0FxAqN8tWkzF8GSIGAiEumu4ONZ/hD9M88uHcD+Yu2ttKfOCgwzoesJOJrtQh7trI5YPbRtMmnA==", "dev": true, "requires": { - "@babel/helper-module-imports": "^7.7.0", - "@babel/helper-simple-access": "^7.7.0", - "@babel/helper-split-export-declaration": "^7.7.0", - "@babel/template": "^7.7.0", - "@babel/types": "^7.7.0", + "@babel/helper-module-imports": "^7.7.4", + "@babel/helper-simple-access": "^7.7.4", + "@babel/helper-split-export-declaration": "^7.7.4", + "@babel/template": "^7.7.4", + "@babel/types": "^7.7.4", "lodash": "^4.17.13" + }, + "dependencies": { + "@babel/helper-split-export-declaration": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-split-export-declaration/-/helper-split-export-declaration-7.7.4.tgz", + "integrity": "sha512-guAg1SXFcVr04Guk9eq0S4/rWS++sbmyqosJzVs8+1fH5NI+ZcmkaSkc7dmtAFbHFva6yRJnjW3yAcGxjueDug==", + "dev": true, + "requires": { + "@babel/types": "^7.7.4" + } + }, + "@babel/parser": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.7.4.tgz", + "integrity": "sha512-jIwvLO0zCL+O/LmEJQjWA75MQTWwx3c3u2JOTDK5D3/9egrWRRA0/0hk9XXywYnXZVVpzrBYeIQTmhwUaePI9g==", + "dev": true + }, + "@babel/template": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/template/-/template-7.7.4.tgz", + "integrity": "sha512-qUzihgVPguAzXCK7WXw8pqs6cEwi54s3E+HrejlkuWO6ivMKx9hZl3Y2fSXp9i5HgyWmj7RKP+ulaYnKM4yYxw==", + "dev": true, + "requires": { + "@babel/code-frame": "^7.0.0", + "@babel/parser": "^7.7.4", + "@babel/types": "^7.7.4" + } + }, + "@babel/types": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.7.4.tgz", + "integrity": "sha512-cz5Ji23KCi4T+YIE/BolWosrJuSmoZeN1EFnRtBwF+KKLi8GG/Z2c2hOJJeCXPk4mwk4QFvTmwIodJowXgttRA==", + "dev": true, + "requires": { + "esutils": "^2.0.2", + "lodash": "^4.17.13", + "to-fast-properties": "^2.0.0" + } + } } }, "@babel/helper-optimise-call-expression": { - "version": "7.7.0", - "resolved": "https://registry.npmjs.org/@babel/helper-optimise-call-expression/-/helper-optimise-call-expression-7.7.0.tgz", - "integrity": "sha512-48TeqmbazjNU/65niiiJIJRc5JozB8acui1OS7bSd6PgxfuovWsvjfWSzlgx+gPFdVveNzUdpdIg5l56Pl5jqg==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-optimise-call-expression/-/helper-optimise-call-expression-7.7.4.tgz", + "integrity": "sha512-VB7gWZ2fDkSuqW6b1AKXkJWO5NyNI3bFL/kK79/30moK57blr6NbH8xcl2XcKCwOmJosftWunZqfO84IGq3ZZg==", "dev": true, "requires": { - "@babel/types": "^7.7.0" + "@babel/types": "^7.7.4" + }, + "dependencies": { + "@babel/types": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.7.4.tgz", + "integrity": "sha512-cz5Ji23KCi4T+YIE/BolWosrJuSmoZeN1EFnRtBwF+KKLi8GG/Z2c2hOJJeCXPk4mwk4QFvTmwIodJowXgttRA==", + "dev": true, + "requires": { + "esutils": "^2.0.2", + "lodash": "^4.17.13", + "to-fast-properties": "^2.0.0" + } + } } }, "@babel/helper-plugin-utils": { @@ -208,61 +610,355 @@ } }, "@babel/helper-remap-async-to-generator": { - "version": "7.7.0", - "resolved": "https://registry.npmjs.org/@babel/helper-remap-async-to-generator/-/helper-remap-async-to-generator-7.7.0.tgz", - "integrity": "sha512-pHx7RN8X0UNHPB/fnuDnRXVZ316ZigkO8y8D835JlZ2SSdFKb6yH9MIYRU4fy/KPe5sPHDFOPvf8QLdbAGGiyw==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-remap-async-to-generator/-/helper-remap-async-to-generator-7.7.4.tgz", + "integrity": "sha512-Sk4xmtVdM9sA/jCI80f+KS+Md+ZHIpjuqmYPk1M7F/upHou5e4ReYmExAiu6PVe65BhJPZA2CY9x9k4BqE5klw==", "dev": true, "requires": { - "@babel/helper-annotate-as-pure": "^7.7.0", - "@babel/helper-wrap-function": "^7.7.0", - "@babel/template": "^7.7.0", - "@babel/traverse": "^7.7.0", - "@babel/types": "^7.7.0" + "@babel/helper-annotate-as-pure": "^7.7.4", + "@babel/helper-wrap-function": "^7.7.4", + "@babel/template": "^7.7.4", + "@babel/traverse": "^7.7.4", + "@babel/types": "^7.7.4" + }, + "dependencies": { + "@babel/generator": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/generator/-/generator-7.7.4.tgz", + "integrity": "sha512-m5qo2WgdOJeyYngKImbkyQrnUN1mPceaG5BV+G0E3gWsa4l/jCSryWJdM2x8OuGAOyh+3d5pVYfZWCiNFtynxg==", + "dev": true, + "requires": { + "@babel/types": "^7.7.4", + "jsesc": "^2.5.1", + "lodash": "^4.17.13", + "source-map": "^0.5.0" + } + }, + "@babel/helper-function-name": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-function-name/-/helper-function-name-7.7.4.tgz", + "integrity": "sha512-AnkGIdiBhEuiwdoMnKm7jfPfqItZhgRaZfMg1XX3bS25INOnLPjPG1Ppnajh8eqgt5kPJnfqrRHqFqmjKDZLzQ==", + "dev": true, + "requires": { + "@babel/helper-get-function-arity": "^7.7.4", + "@babel/template": "^7.7.4", + "@babel/types": "^7.7.4" + } + }, + "@babel/helper-get-function-arity": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-get-function-arity/-/helper-get-function-arity-7.7.4.tgz", + "integrity": "sha512-QTGKEdCkjgzgfJ3bAyRwF4yyT3pg+vDgan8DSivq1eS0gwi+KGKE5x8kRcbeFTb/673mkO5SN1IZfmCfA5o+EA==", + "dev": true, + "requires": { + "@babel/types": "^7.7.4" + } + }, + "@babel/helper-split-export-declaration": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-split-export-declaration/-/helper-split-export-declaration-7.7.4.tgz", + "integrity": "sha512-guAg1SXFcVr04Guk9eq0S4/rWS++sbmyqosJzVs8+1fH5NI+ZcmkaSkc7dmtAFbHFva6yRJnjW3yAcGxjueDug==", + "dev": true, + "requires": { + "@babel/types": "^7.7.4" + } + }, + "@babel/parser": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.7.4.tgz", + "integrity": "sha512-jIwvLO0zCL+O/LmEJQjWA75MQTWwx3c3u2JOTDK5D3/9egrWRRA0/0hk9XXywYnXZVVpzrBYeIQTmhwUaePI9g==", + "dev": true + }, + "@babel/template": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/template/-/template-7.7.4.tgz", + "integrity": "sha512-qUzihgVPguAzXCK7WXw8pqs6cEwi54s3E+HrejlkuWO6ivMKx9hZl3Y2fSXp9i5HgyWmj7RKP+ulaYnKM4yYxw==", + "dev": true, + "requires": { + "@babel/code-frame": "^7.0.0", + "@babel/parser": "^7.7.4", + "@babel/types": "^7.7.4" + } + }, + "@babel/traverse": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/traverse/-/traverse-7.7.4.tgz", + "integrity": "sha512-P1L58hQyupn8+ezVA2z5KBm4/Zr4lCC8dwKCMYzsa5jFMDMQAzaBNy9W5VjB+KAmBjb40U7a/H6ao+Xo+9saIw==", + "dev": true, + "requires": { + "@babel/code-frame": "^7.5.5", + "@babel/generator": "^7.7.4", + "@babel/helper-function-name": "^7.7.4", + "@babel/helper-split-export-declaration": "^7.7.4", + "@babel/parser": "^7.7.4", + "@babel/types": "^7.7.4", + "debug": "^4.1.0", + "globals": "^11.1.0", + "lodash": "^4.17.13" + } + }, + "@babel/types": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.7.4.tgz", + "integrity": "sha512-cz5Ji23KCi4T+YIE/BolWosrJuSmoZeN1EFnRtBwF+KKLi8GG/Z2c2hOJJeCXPk4mwk4QFvTmwIodJowXgttRA==", + "dev": true, + "requires": { + "esutils": "^2.0.2", + "lodash": "^4.17.13", + "to-fast-properties": "^2.0.0" + } + } } }, "@babel/helper-replace-supers": { - "version": "7.7.0", - "resolved": "https://registry.npmjs.org/@babel/helper-replace-supers/-/helper-replace-supers-7.7.0.tgz", - "integrity": "sha512-5ALYEul5V8xNdxEeWvRsBzLMxQksT7MaStpxjJf9KsnLxpAKBtfw5NeMKZJSYDa0lKdOcy0g+JT/f5mPSulUgg==", - "dev": true, - "requires": { - "@babel/helper-member-expression-to-functions": "^7.7.0", - "@babel/helper-optimise-call-expression": "^7.7.0", - "@babel/traverse": "^7.7.0", - "@babel/types": "^7.7.0" - } - }, - "@babel/helper-simple-access": { - "version": "7.7.0", - "resolved": "https://registry.npmjs.org/@babel/helper-simple-access/-/helper-simple-access-7.7.0.tgz", - "integrity": "sha512-AJ7IZD7Eem3zZRuj5JtzFAptBw7pMlS3y8Qv09vaBWoFsle0d1kAn5Wq6Q9MyBXITPOKnxwkZKoAm4bopmv26g==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-replace-supers/-/helper-replace-supers-7.7.4.tgz", + "integrity": "sha512-pP0tfgg9hsZWo5ZboYGuBn/bbYT/hdLPVSS4NMmiRJdwWhP0IznPwN9AE1JwyGsjSPLC364I0Qh5p+EPkGPNpg==", "dev": true, "requires": { - "@babel/template": "^7.7.0", - "@babel/types": "^7.7.0" - } - }, - "@babel/helper-split-export-declaration": { - "version": "7.7.0", - "resolved": "https://registry.npmjs.org/@babel/helper-split-export-declaration/-/helper-split-export-declaration-7.7.0.tgz", - "integrity": "sha512-HgYSI8rH08neWlAH3CcdkFg9qX9YsZysZI5GD8LjhQib/mM0jGOZOVkoUiiV2Hu978fRtjtsGsW6w0pKHUWtqA==", - "dev": true, - "requires": { - "@babel/types": "^7.7.0" - } - }, - "@babel/helper-wrap-function": { - "version": "7.7.0", - "resolved": "https://registry.npmjs.org/@babel/helper-wrap-function/-/helper-wrap-function-7.7.0.tgz", - "integrity": "sha512-sd4QjeMgQqzshSjecZjOp8uKfUtnpmCyQhKQrVJBBgeHAB/0FPi33h3AbVlVp07qQtMD4QgYSzaMI7VwncNK/w==", - "dev": true, + "@babel/helper-member-expression-to-functions": "^7.7.4", + "@babel/helper-optimise-call-expression": "^7.7.4", + "@babel/traverse": "^7.7.4", + "@babel/types": "^7.7.4" + }, + "dependencies": { + "@babel/generator": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/generator/-/generator-7.7.4.tgz", + "integrity": "sha512-m5qo2WgdOJeyYngKImbkyQrnUN1mPceaG5BV+G0E3gWsa4l/jCSryWJdM2x8OuGAOyh+3d5pVYfZWCiNFtynxg==", + "dev": true, + "requires": { + "@babel/types": "^7.7.4", + "jsesc": "^2.5.1", + "lodash": "^4.17.13", + "source-map": "^0.5.0" + } + }, + "@babel/helper-function-name": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-function-name/-/helper-function-name-7.7.4.tgz", + "integrity": "sha512-AnkGIdiBhEuiwdoMnKm7jfPfqItZhgRaZfMg1XX3bS25INOnLPjPG1Ppnajh8eqgt5kPJnfqrRHqFqmjKDZLzQ==", + "dev": true, + "requires": { + "@babel/helper-get-function-arity": "^7.7.4", + "@babel/template": "^7.7.4", + "@babel/types": "^7.7.4" + } + }, + "@babel/helper-get-function-arity": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-get-function-arity/-/helper-get-function-arity-7.7.4.tgz", + "integrity": "sha512-QTGKEdCkjgzgfJ3bAyRwF4yyT3pg+vDgan8DSivq1eS0gwi+KGKE5x8kRcbeFTb/673mkO5SN1IZfmCfA5o+EA==", + "dev": true, + "requires": { + "@babel/types": "^7.7.4" + } + }, + "@babel/helper-split-export-declaration": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-split-export-declaration/-/helper-split-export-declaration-7.7.4.tgz", + "integrity": "sha512-guAg1SXFcVr04Guk9eq0S4/rWS++sbmyqosJzVs8+1fH5NI+ZcmkaSkc7dmtAFbHFva6yRJnjW3yAcGxjueDug==", + "dev": true, + "requires": { + "@babel/types": "^7.7.4" + } + }, + "@babel/parser": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.7.4.tgz", + "integrity": "sha512-jIwvLO0zCL+O/LmEJQjWA75MQTWwx3c3u2JOTDK5D3/9egrWRRA0/0hk9XXywYnXZVVpzrBYeIQTmhwUaePI9g==", + "dev": true + }, + "@babel/template": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/template/-/template-7.7.4.tgz", + "integrity": "sha512-qUzihgVPguAzXCK7WXw8pqs6cEwi54s3E+HrejlkuWO6ivMKx9hZl3Y2fSXp9i5HgyWmj7RKP+ulaYnKM4yYxw==", + "dev": true, + "requires": { + "@babel/code-frame": "^7.0.0", + "@babel/parser": "^7.7.4", + "@babel/types": "^7.7.4" + } + }, + "@babel/traverse": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/traverse/-/traverse-7.7.4.tgz", + "integrity": "sha512-P1L58hQyupn8+ezVA2z5KBm4/Zr4lCC8dwKCMYzsa5jFMDMQAzaBNy9W5VjB+KAmBjb40U7a/H6ao+Xo+9saIw==", + "dev": true, + "requires": { + "@babel/code-frame": "^7.5.5", + "@babel/generator": "^7.7.4", + "@babel/helper-function-name": "^7.7.4", + "@babel/helper-split-export-declaration": "^7.7.4", + "@babel/parser": "^7.7.4", + "@babel/types": "^7.7.4", + "debug": "^4.1.0", + "globals": "^11.1.0", + "lodash": "^4.17.13" + } + }, + "@babel/types": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.7.4.tgz", + "integrity": "sha512-cz5Ji23KCi4T+YIE/BolWosrJuSmoZeN1EFnRtBwF+KKLi8GG/Z2c2hOJJeCXPk4mwk4QFvTmwIodJowXgttRA==", + "dev": true, + "requires": { + "esutils": "^2.0.2", + "lodash": "^4.17.13", + "to-fast-properties": "^2.0.0" + } + } + } + }, + "@babel/helper-simple-access": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-simple-access/-/helper-simple-access-7.7.4.tgz", + "integrity": "sha512-zK7THeEXfan7UlWsG2A6CI/L9jVnI5+xxKZOdej39Y0YtDYKx9raHk5F2EtK9K8DHRTihYwg20ADt9S36GR78A==", + "dev": true, + "requires": { + "@babel/template": "^7.7.4", + "@babel/types": "^7.7.4" + }, + "dependencies": { + "@babel/parser": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.7.4.tgz", + "integrity": "sha512-jIwvLO0zCL+O/LmEJQjWA75MQTWwx3c3u2JOTDK5D3/9egrWRRA0/0hk9XXywYnXZVVpzrBYeIQTmhwUaePI9g==", + "dev": true + }, + "@babel/template": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/template/-/template-7.7.4.tgz", + "integrity": "sha512-qUzihgVPguAzXCK7WXw8pqs6cEwi54s3E+HrejlkuWO6ivMKx9hZl3Y2fSXp9i5HgyWmj7RKP+ulaYnKM4yYxw==", + "dev": true, + "requires": { + "@babel/code-frame": "^7.0.0", + "@babel/parser": "^7.7.4", + "@babel/types": "^7.7.4" + } + }, + "@babel/types": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.7.4.tgz", + "integrity": "sha512-cz5Ji23KCi4T+YIE/BolWosrJuSmoZeN1EFnRtBwF+KKLi8GG/Z2c2hOJJeCXPk4mwk4QFvTmwIodJowXgttRA==", + "dev": true, + "requires": { + "esutils": "^2.0.2", + "lodash": "^4.17.13", + "to-fast-properties": "^2.0.0" + } + } + } + }, + "@babel/helper-split-export-declaration": { + "version": "7.7.0", + "resolved": "https://registry.npmjs.org/@babel/helper-split-export-declaration/-/helper-split-export-declaration-7.7.0.tgz", + "integrity": "sha512-HgYSI8rH08neWlAH3CcdkFg9qX9YsZysZI5GD8LjhQib/mM0jGOZOVkoUiiV2Hu978fRtjtsGsW6w0pKHUWtqA==", + "dev": true, "requires": { - "@babel/helper-function-name": "^7.7.0", - "@babel/template": "^7.7.0", - "@babel/traverse": "^7.7.0", "@babel/types": "^7.7.0" } }, + "@babel/helper-wrap-function": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-wrap-function/-/helper-wrap-function-7.7.4.tgz", + "integrity": "sha512-VsfzZt6wmsocOaVU0OokwrIytHND55yvyT4BPB9AIIgwr8+x7617hetdJTsuGwygN5RC6mxA9EJztTjuwm2ofg==", + "dev": true, + "requires": { + "@babel/helper-function-name": "^7.7.4", + "@babel/template": "^7.7.4", + "@babel/traverse": "^7.7.4", + "@babel/types": "^7.7.4" + }, + "dependencies": { + "@babel/generator": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/generator/-/generator-7.7.4.tgz", + "integrity": "sha512-m5qo2WgdOJeyYngKImbkyQrnUN1mPceaG5BV+G0E3gWsa4l/jCSryWJdM2x8OuGAOyh+3d5pVYfZWCiNFtynxg==", + "dev": true, + "requires": { + "@babel/types": "^7.7.4", + "jsesc": "^2.5.1", + "lodash": "^4.17.13", + "source-map": "^0.5.0" + } + }, + "@babel/helper-function-name": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-function-name/-/helper-function-name-7.7.4.tgz", + "integrity": "sha512-AnkGIdiBhEuiwdoMnKm7jfPfqItZhgRaZfMg1XX3bS25INOnLPjPG1Ppnajh8eqgt5kPJnfqrRHqFqmjKDZLzQ==", + "dev": true, + "requires": { + "@babel/helper-get-function-arity": "^7.7.4", + "@babel/template": "^7.7.4", + "@babel/types": "^7.7.4" + } + }, + "@babel/helper-get-function-arity": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-get-function-arity/-/helper-get-function-arity-7.7.4.tgz", + "integrity": "sha512-QTGKEdCkjgzgfJ3bAyRwF4yyT3pg+vDgan8DSivq1eS0gwi+KGKE5x8kRcbeFTb/673mkO5SN1IZfmCfA5o+EA==", + "dev": true, + "requires": { + "@babel/types": "^7.7.4" + } + }, + "@babel/helper-split-export-declaration": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-split-export-declaration/-/helper-split-export-declaration-7.7.4.tgz", + "integrity": "sha512-guAg1SXFcVr04Guk9eq0S4/rWS++sbmyqosJzVs8+1fH5NI+ZcmkaSkc7dmtAFbHFva6yRJnjW3yAcGxjueDug==", + "dev": true, + "requires": { + "@babel/types": "^7.7.4" + } + }, + "@babel/parser": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.7.4.tgz", + "integrity": "sha512-jIwvLO0zCL+O/LmEJQjWA75MQTWwx3c3u2JOTDK5D3/9egrWRRA0/0hk9XXywYnXZVVpzrBYeIQTmhwUaePI9g==", + "dev": true + }, + "@babel/template": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/template/-/template-7.7.4.tgz", + "integrity": "sha512-qUzihgVPguAzXCK7WXw8pqs6cEwi54s3E+HrejlkuWO6ivMKx9hZl3Y2fSXp9i5HgyWmj7RKP+ulaYnKM4yYxw==", + "dev": true, + "requires": { + "@babel/code-frame": "^7.0.0", + "@babel/parser": "^7.7.4", + "@babel/types": "^7.7.4" + } + }, + "@babel/traverse": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/traverse/-/traverse-7.7.4.tgz", + "integrity": "sha512-P1L58hQyupn8+ezVA2z5KBm4/Zr4lCC8dwKCMYzsa5jFMDMQAzaBNy9W5VjB+KAmBjb40U7a/H6ao+Xo+9saIw==", + "dev": true, + "requires": { + "@babel/code-frame": "^7.5.5", + "@babel/generator": "^7.7.4", + "@babel/helper-function-name": "^7.7.4", + "@babel/helper-split-export-declaration": "^7.7.4", + "@babel/parser": "^7.7.4", + "@babel/types": "^7.7.4", + "debug": "^4.1.0", + "globals": "^11.1.0", + "lodash": "^4.17.13" + } + }, + "@babel/types": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.7.4.tgz", + "integrity": "sha512-cz5Ji23KCi4T+YIE/BolWosrJuSmoZeN1EFnRtBwF+KKLi8GG/Z2c2hOJJeCXPk4mwk4QFvTmwIodJowXgttRA==", + "dev": true, + "requires": { + "esutils": "^2.0.2", + "lodash": "^4.17.13", + "to-fast-properties": "^2.0.0" + } + } + } + }, "@babel/helpers": { "version": "7.7.0", "resolved": "https://registry.npmjs.org/@babel/helpers/-/helpers-7.7.0.tgz", @@ -292,97 +988,125 @@ "dev": true }, "@babel/plugin-proposal-async-generator-functions": { - "version": "7.7.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-proposal-async-generator-functions/-/plugin-proposal-async-generator-functions-7.7.0.tgz", - "integrity": "sha512-ot/EZVvf3mXtZq0Pd0+tSOfGWMizqmOohXmNZg6LNFjHOV+wOPv7BvVYh8oPR8LhpIP3ye8nNooKL50YRWxpYA==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-proposal-async-generator-functions/-/plugin-proposal-async-generator-functions-7.7.4.tgz", + "integrity": "sha512-1ypyZvGRXriY/QP668+s8sFr2mqinhkRDMPSQLNghCQE+GAkFtp+wkHVvg2+Hdki8gwP+NFzJBJ/N1BfzCCDEw==", "dev": true, "requires": { "@babel/helper-plugin-utils": "^7.0.0", - "@babel/helper-remap-async-to-generator": "^7.7.0", - "@babel/plugin-syntax-async-generators": "^7.2.0" + "@babel/helper-remap-async-to-generator": "^7.7.4", + "@babel/plugin-syntax-async-generators": "^7.7.4" } }, "@babel/plugin-proposal-dynamic-import": { - "version": "7.7.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-proposal-dynamic-import/-/plugin-proposal-dynamic-import-7.7.0.tgz", - "integrity": "sha512-7poL3Xi+QFPC7sGAzEIbXUyYzGJwbc2+gSD0AkiC5k52kH2cqHdqxm5hNFfLW3cRSTcx9bN0Fl7/6zWcLLnKAQ==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-proposal-dynamic-import/-/plugin-proposal-dynamic-import-7.7.4.tgz", + "integrity": "sha512-StH+nGAdO6qDB1l8sZ5UBV8AC3F2VW2I8Vfld73TMKyptMU9DY5YsJAS8U81+vEtxcH3Y/La0wG0btDrhpnhjQ==", "dev": true, "requires": { "@babel/helper-plugin-utils": "^7.0.0", - "@babel/plugin-syntax-dynamic-import": "^7.2.0" + "@babel/plugin-syntax-dynamic-import": "^7.7.4" } }, "@babel/plugin-proposal-json-strings": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-proposal-json-strings/-/plugin-proposal-json-strings-7.2.0.tgz", - "integrity": "sha512-MAFV1CA/YVmYwZG0fBQyXhmj0BHCB5egZHCKWIFVv/XCxAeVGIHfos3SwDck4LvCllENIAg7xMKOG5kH0dzyUg==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-proposal-json-strings/-/plugin-proposal-json-strings-7.7.4.tgz", + "integrity": "sha512-wQvt3akcBTfLU/wYoqm/ws7YOAQKu8EVJEvHip/mzkNtjaclQoCCIqKXFP5/eyfnfbQCDV3OLRIK3mIVyXuZlw==", "dev": true, "requires": { "@babel/helper-plugin-utils": "^7.0.0", - "@babel/plugin-syntax-json-strings": "^7.2.0" + "@babel/plugin-syntax-json-strings": "^7.7.4" } }, "@babel/plugin-proposal-object-rest-spread": { - "version": "7.6.2", - "resolved": "https://registry.npmjs.org/@babel/plugin-proposal-object-rest-spread/-/plugin-proposal-object-rest-spread-7.6.2.tgz", - "integrity": "sha512-LDBXlmADCsMZV1Y9OQwMc0MyGZ8Ta/zlD9N67BfQT8uYwkRswiu2hU6nJKrjrt/58aH/vqfQlR/9yId/7A2gWw==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-proposal-object-rest-spread/-/plugin-proposal-object-rest-spread-7.7.4.tgz", + "integrity": "sha512-rnpnZR3/iWKmiQyJ3LKJpSwLDcX/nSXhdLk4Aq/tXOApIvyu7qoabrige0ylsAJffaUC51WiBu209Q0U+86OWQ==", "dev": true, "requires": { "@babel/helper-plugin-utils": "^7.0.0", - "@babel/plugin-syntax-object-rest-spread": "^7.2.0" + "@babel/plugin-syntax-object-rest-spread": "^7.7.4" + }, + "dependencies": { + "@babel/plugin-syntax-object-rest-spread": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-object-rest-spread/-/plugin-syntax-object-rest-spread-7.7.4.tgz", + "integrity": "sha512-mObR+r+KZq0XhRVS2BrBKBpr5jqrqzlPvS9C9vuOf5ilSwzloAl7RPWLrgKdWS6IreaVrjHxTjtyqFiOisaCwg==", + "dev": true, + "requires": { + "@babel/helper-plugin-utils": "^7.0.0" + } + } } }, "@babel/plugin-proposal-optional-catch-binding": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-proposal-optional-catch-binding/-/plugin-proposal-optional-catch-binding-7.2.0.tgz", - "integrity": "sha512-mgYj3jCcxug6KUcX4OBoOJz3CMrwRfQELPQ5560F70YQUBZB7uac9fqaWamKR1iWUzGiK2t0ygzjTScZnVz75g==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-proposal-optional-catch-binding/-/plugin-proposal-optional-catch-binding-7.7.4.tgz", + "integrity": "sha512-DyM7U2bnsQerCQ+sejcTNZh8KQEUuC3ufzdnVnSiUv/qoGJp2Z3hanKL18KDhsBT5Wj6a7CMT5mdyCNJsEaA9w==", "dev": true, "requires": { "@babel/helper-plugin-utils": "^7.0.0", - "@babel/plugin-syntax-optional-catch-binding": "^7.2.0" + "@babel/plugin-syntax-optional-catch-binding": "^7.7.4" } }, "@babel/plugin-proposal-unicode-property-regex": { - "version": "7.7.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-proposal-unicode-property-regex/-/plugin-proposal-unicode-property-regex-7.7.0.tgz", - "integrity": "sha512-mk34H+hp7kRBWJOOAR0ZMGCydgKMD4iN9TpDRp3IIcbunltxEY89XSimc6WbtSLCDrwcdy/EEw7h5CFCzxTchw==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-proposal-unicode-property-regex/-/plugin-proposal-unicode-property-regex-7.7.4.tgz", + "integrity": "sha512-cHgqHgYvffluZk85dJ02vloErm3Y6xtH+2noOBOJ2kXOJH3aVCDnj5eR/lVNlTnYu4hndAPJD3rTFjW3qee0PA==", "dev": true, "requires": { - "@babel/helper-create-regexp-features-plugin": "^7.7.0", + "@babel/helper-create-regexp-features-plugin": "^7.7.4", "@babel/helper-plugin-utils": "^7.0.0" } }, "@babel/plugin-syntax-async-generators": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-async-generators/-/plugin-syntax-async-generators-7.2.0.tgz", - "integrity": "sha512-1ZrIRBv2t0GSlcwVoQ6VgSLpLgiN/FVQUzt9znxo7v2Ov4jJrs8RY8tv0wvDmFN3qIdMKWrmMMW6yZ0G19MfGg==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-async-generators/-/plugin-syntax-async-generators-7.7.4.tgz", + "integrity": "sha512-Li4+EjSpBgxcsmeEF8IFcfV/+yJGxHXDirDkEoyFjumuwbmfCVHUt0HuowD/iGM7OhIRyXJH9YXxqiH6N815+g==", "dev": true, "requires": { "@babel/helper-plugin-utils": "^7.0.0" } }, + "@babel/plugin-syntax-bigint": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-bigint/-/plugin-syntax-bigint-7.8.3.tgz", + "integrity": "sha512-wnTnFlG+YxQm3vDxpGE57Pj0srRU4sHE/mDkt1qv2YJJSeUAec2ma4WLUnUPeKjyrfntVwe/N6dCXpU+zL3Npg==", + "dev": true, + "requires": { + "@babel/helper-plugin-utils": "^7.8.0" + }, + "dependencies": { + "@babel/helper-plugin-utils": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/helper-plugin-utils/-/helper-plugin-utils-7.8.3.tgz", + "integrity": "sha512-j+fq49Xds2smCUNYmEHF9kGNkhbet6yVIBp4e6oeQpH1RUs/Ir06xUKzDjDkGcaaokPiTNs2JBWHjaE4csUkZQ==", + "dev": true + } + } + }, "@babel/plugin-syntax-dynamic-import": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-dynamic-import/-/plugin-syntax-dynamic-import-7.2.0.tgz", - "integrity": "sha512-mVxuJ0YroI/h/tbFTPGZR8cv6ai+STMKNBq0f8hFxsxWjl94qqhsb+wXbpNMDPU3cfR1TIsVFzU3nXyZMqyK4w==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-dynamic-import/-/plugin-syntax-dynamic-import-7.7.4.tgz", + "integrity": "sha512-jHQW0vbRGvwQNgyVxwDh4yuXu4bH1f5/EICJLAhl1SblLs2CDhrsmCk+v5XLdE9wxtAFRyxx+P//Iw+a5L/tTg==", "dev": true, "requires": { "@babel/helper-plugin-utils": "^7.0.0" } }, "@babel/plugin-syntax-import-meta": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-import-meta/-/plugin-syntax-import-meta-7.2.0.tgz", - "integrity": "sha512-Hq6kFSZD7+PHkmBN8bCpHR6J8QEoCuEV/B38AIQscYjgMZkGlXB7cHNFzP5jR4RCh5545yP1ujHdmO7hAgKtBA==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-import-meta/-/plugin-syntax-import-meta-7.7.4.tgz", + "integrity": "sha512-hl6aKgm2IbVB+X9Z2xcKvGObOOS//vbohHPpNvd8iaKA3XQi3Sz/3oOyb3GLes6hY871mkbZQYK7lxriVECRAQ==", "dev": true, "requires": { "@babel/helper-plugin-utils": "^7.0.0" } }, "@babel/plugin-syntax-json-strings": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-json-strings/-/plugin-syntax-json-strings-7.2.0.tgz", - "integrity": "sha512-5UGYnMSLRE1dqqZwug+1LISpA403HzlSfsg6P9VXU6TBjcSHeNlw4DxDx7LgpF+iKZoOG/+uzqoRHTdcUpiZNg==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-json-strings/-/plugin-syntax-json-strings-7.7.4.tgz", + "integrity": "sha512-QpGupahTQW1mHRXddMG5srgpHWqRLwJnJZKXTigB9RPFCCGbDGCgBeM/iC82ICXp414WeYx/tD54w7M2qRqTMg==", "dev": true, "requires": { "@babel/helper-plugin-utils": "^7.0.0" @@ -398,65 +1122,65 @@ } }, "@babel/plugin-syntax-optional-catch-binding": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-optional-catch-binding/-/plugin-syntax-optional-catch-binding-7.2.0.tgz", - "integrity": "sha512-bDe4xKNhb0LI7IvZHiA13kff0KEfaGX/Hv4lMA9+7TEc63hMNvfKo6ZFpXhKuEp+II/q35Gc4NoMeDZyaUbj9w==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-optional-catch-binding/-/plugin-syntax-optional-catch-binding-7.7.4.tgz", + "integrity": "sha512-4ZSuzWgFxqHRE31Glu+fEr/MirNZOMYmD/0BhBWyLyOOQz/gTAl7QmWm2hX1QxEIXsr2vkdlwxIzTyiYRC4xcQ==", "dev": true, "requires": { "@babel/helper-plugin-utils": "^7.0.0" } }, "@babel/plugin-syntax-top-level-await": { - "version": "7.7.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-top-level-await/-/plugin-syntax-top-level-await-7.7.0.tgz", - "integrity": "sha512-hi8FUNiFIY1fnUI2n1ViB1DR0R4QeK4iHcTlW6aJkrPoTdb8Rf1EMQ6GT3f67DDkYyWgew9DFoOZ6gOoEsdzTA==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-top-level-await/-/plugin-syntax-top-level-await-7.7.4.tgz", + "integrity": "sha512-wdsOw0MvkL1UIgiQ/IFr3ETcfv1xb8RMM0H9wbiDyLaJFyiDg5oZvDLCXosIXmFeIlweML5iOBXAkqddkYNizg==", "dev": true, "requires": { "@babel/helper-plugin-utils": "^7.0.0" } }, "@babel/plugin-syntax-typescript": { - "version": "7.3.3", - "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-typescript/-/plugin-syntax-typescript-7.3.3.tgz", - "integrity": "sha512-dGwbSMA1YhVS8+31CnPR7LB4pcbrzcV99wQzby4uAfrkZPYZlQ7ImwdpzLqi6Z6IL02b8IAL379CaMwo0x5Lag==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-typescript/-/plugin-syntax-typescript-7.7.4.tgz", + "integrity": "sha512-77blgY18Hud4NM1ggTA8xVT/dBENQf17OpiToSa2jSmEY3fWXD2jwrdVlO4kq5yzUTeF15WSQ6b4fByNvJcjpQ==", "dev": true, "requires": { "@babel/helper-plugin-utils": "^7.0.0" } }, "@babel/plugin-transform-arrow-functions": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-arrow-functions/-/plugin-transform-arrow-functions-7.2.0.tgz", - "integrity": "sha512-ER77Cax1+8/8jCB9fo4Ud161OZzWN5qawi4GusDuRLcDbDG+bIGYY20zb2dfAFdTRGzrfq2xZPvF0R64EHnimg==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-arrow-functions/-/plugin-transform-arrow-functions-7.7.4.tgz", + "integrity": "sha512-zUXy3e8jBNPiffmqkHRNDdZM2r8DWhCB7HhcoyZjiK1TxYEluLHAvQuYnTT+ARqRpabWqy/NHkO6e3MsYB5YfA==", "dev": true, "requires": { "@babel/helper-plugin-utils": "^7.0.0" } }, "@babel/plugin-transform-async-to-generator": { - "version": "7.7.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-async-to-generator/-/plugin-transform-async-to-generator-7.7.0.tgz", - "integrity": "sha512-vLI2EFLVvRBL3d8roAMqtVY0Bm9C1QzLkdS57hiKrjUBSqsQYrBsMCeOg/0KK7B0eK9V71J5mWcha9yyoI2tZw==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-async-to-generator/-/plugin-transform-async-to-generator-7.7.4.tgz", + "integrity": "sha512-zpUTZphp5nHokuy8yLlyafxCJ0rSlFoSHypTUWgpdwoDXWQcseaect7cJ8Ppk6nunOM6+5rPMkod4OYKPR5MUg==", "dev": true, "requires": { - "@babel/helper-module-imports": "^7.7.0", + "@babel/helper-module-imports": "^7.7.4", "@babel/helper-plugin-utils": "^7.0.0", - "@babel/helper-remap-async-to-generator": "^7.7.0" + "@babel/helper-remap-async-to-generator": "^7.7.4" } }, "@babel/plugin-transform-block-scoped-functions": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-block-scoped-functions/-/plugin-transform-block-scoped-functions-7.2.0.tgz", - "integrity": "sha512-ntQPR6q1/NKuphly49+QiQiTN0O63uOwjdD6dhIjSWBI5xlrbUFh720TIpzBhpnrLfv2tNH/BXvLIab1+BAI0w==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-block-scoped-functions/-/plugin-transform-block-scoped-functions-7.7.4.tgz", + "integrity": "sha512-kqtQzwtKcpPclHYjLK//3lH8OFsCDuDJBaFhVwf8kqdnF6MN4l618UDlcA7TfRs3FayrHj+svYnSX8MC9zmUyQ==", "dev": true, "requires": { "@babel/helper-plugin-utils": "^7.0.0" } }, "@babel/plugin-transform-block-scoping": { - "version": "7.6.3", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-block-scoping/-/plugin-transform-block-scoping-7.6.3.tgz", - "integrity": "sha512-7hvrg75dubcO3ZI2rjYTzUrEuh1E9IyDEhhB6qfcooxhDA33xx2MasuLVgdxzcP6R/lipAC6n9ub9maNW6RKdw==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-block-scoping/-/plugin-transform-block-scoping-7.7.4.tgz", + "integrity": "sha512-2VBe9u0G+fDt9B5OV5DQH4KBf5DoiNkwFKOz0TCvBWvdAN2rOykCTkrL+jTLxfCAm76l9Qo5OqL7HBOx2dWggg==", "dev": true, "requires": { "@babel/helper-plugin-utils": "^7.0.0", @@ -464,237 +1188,368 @@ } }, "@babel/plugin-transform-classes": { - "version": "7.7.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-classes/-/plugin-transform-classes-7.7.0.tgz", - "integrity": "sha512-/b3cKIZwGeUesZheU9jNYcwrEA7f/Bo4IdPmvp7oHgvks2majB5BoT5byAql44fiNQYOPzhk2w8DbgfuafkMoA==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-classes/-/plugin-transform-classes-7.7.4.tgz", + "integrity": "sha512-sK1mjWat7K+buWRuImEzjNf68qrKcrddtpQo3swi9j7dUcG6y6R6+Di039QN2bD1dykeswlagupEmpOatFHHUg==", "dev": true, "requires": { - "@babel/helper-annotate-as-pure": "^7.7.0", - "@babel/helper-define-map": "^7.7.0", - "@babel/helper-function-name": "^7.7.0", - "@babel/helper-optimise-call-expression": "^7.7.0", + "@babel/helper-annotate-as-pure": "^7.7.4", + "@babel/helper-define-map": "^7.7.4", + "@babel/helper-function-name": "^7.7.4", + "@babel/helper-optimise-call-expression": "^7.7.4", "@babel/helper-plugin-utils": "^7.0.0", - "@babel/helper-replace-supers": "^7.7.0", - "@babel/helper-split-export-declaration": "^7.7.0", + "@babel/helper-replace-supers": "^7.7.4", + "@babel/helper-split-export-declaration": "^7.7.4", "globals": "^11.1.0" + }, + "dependencies": { + "@babel/helper-function-name": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-function-name/-/helper-function-name-7.7.4.tgz", + "integrity": "sha512-AnkGIdiBhEuiwdoMnKm7jfPfqItZhgRaZfMg1XX3bS25INOnLPjPG1Ppnajh8eqgt5kPJnfqrRHqFqmjKDZLzQ==", + "dev": true, + "requires": { + "@babel/helper-get-function-arity": "^7.7.4", + "@babel/template": "^7.7.4", + "@babel/types": "^7.7.4" + } + }, + "@babel/helper-get-function-arity": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-get-function-arity/-/helper-get-function-arity-7.7.4.tgz", + "integrity": "sha512-QTGKEdCkjgzgfJ3bAyRwF4yyT3pg+vDgan8DSivq1eS0gwi+KGKE5x8kRcbeFTb/673mkO5SN1IZfmCfA5o+EA==", + "dev": true, + "requires": { + "@babel/types": "^7.7.4" + } + }, + "@babel/helper-split-export-declaration": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-split-export-declaration/-/helper-split-export-declaration-7.7.4.tgz", + "integrity": "sha512-guAg1SXFcVr04Guk9eq0S4/rWS++sbmyqosJzVs8+1fH5NI+ZcmkaSkc7dmtAFbHFva6yRJnjW3yAcGxjueDug==", + "dev": true, + "requires": { + "@babel/types": "^7.7.4" + } + }, + "@babel/parser": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.7.4.tgz", + "integrity": "sha512-jIwvLO0zCL+O/LmEJQjWA75MQTWwx3c3u2JOTDK5D3/9egrWRRA0/0hk9XXywYnXZVVpzrBYeIQTmhwUaePI9g==", + "dev": true + }, + "@babel/template": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/template/-/template-7.7.4.tgz", + "integrity": "sha512-qUzihgVPguAzXCK7WXw8pqs6cEwi54s3E+HrejlkuWO6ivMKx9hZl3Y2fSXp9i5HgyWmj7RKP+ulaYnKM4yYxw==", + "dev": true, + "requires": { + "@babel/code-frame": "^7.0.0", + "@babel/parser": "^7.7.4", + "@babel/types": "^7.7.4" + } + }, + "@babel/types": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.7.4.tgz", + "integrity": "sha512-cz5Ji23KCi4T+YIE/BolWosrJuSmoZeN1EFnRtBwF+KKLi8GG/Z2c2hOJJeCXPk4mwk4QFvTmwIodJowXgttRA==", + "dev": true, + "requires": { + "esutils": "^2.0.2", + "lodash": "^4.17.13", + "to-fast-properties": "^2.0.0" + } + } } }, "@babel/plugin-transform-computed-properties": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-computed-properties/-/plugin-transform-computed-properties-7.2.0.tgz", - "integrity": "sha512-kP/drqTxY6Xt3NNpKiMomfgkNn4o7+vKxK2DDKcBG9sHj51vHqMBGy8wbDS/J4lMxnqs153/T3+DmCEAkC5cpA==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-computed-properties/-/plugin-transform-computed-properties-7.7.4.tgz", + "integrity": "sha512-bSNsOsZnlpLLyQew35rl4Fma3yKWqK3ImWMSC/Nc+6nGjC9s5NFWAer1YQ899/6s9HxO2zQC1WoFNfkOqRkqRQ==", "dev": true, "requires": { "@babel/helper-plugin-utils": "^7.0.0" } }, "@babel/plugin-transform-destructuring": { - "version": "7.6.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-destructuring/-/plugin-transform-destructuring-7.6.0.tgz", - "integrity": "sha512-2bGIS5P1v4+sWTCnKNDZDxbGvEqi0ijeqM/YqHtVGrvG2y0ySgnEEhXErvE9dA0bnIzY9bIzdFK0jFA46ASIIQ==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-destructuring/-/plugin-transform-destructuring-7.7.4.tgz", + "integrity": "sha512-4jFMXI1Cu2aXbcXXl8Lr6YubCn6Oc7k9lLsu8v61TZh+1jny2BWmdtvY9zSUlLdGUvcy9DMAWyZEOqjsbeg/wA==", "dev": true, "requires": { "@babel/helper-plugin-utils": "^7.0.0" } }, "@babel/plugin-transform-dotall-regex": { - "version": "7.7.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-dotall-regex/-/plugin-transform-dotall-regex-7.7.0.tgz", - "integrity": "sha512-3QQlF7hSBnSuM1hQ0pS3pmAbWLax/uGNCbPBND9y+oJ4Y776jsyujG2k0Sn2Aj2a0QwVOiOFL5QVPA7spjvzSA==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-dotall-regex/-/plugin-transform-dotall-regex-7.7.4.tgz", + "integrity": "sha512-mk0cH1zyMa/XHeb6LOTXTbG7uIJ8Rrjlzu91pUx/KS3JpcgaTDwMS8kM+ar8SLOvlL2Lofi4CGBAjCo3a2x+lw==", "dev": true, "requires": { - "@babel/helper-create-regexp-features-plugin": "^7.7.0", + "@babel/helper-create-regexp-features-plugin": "^7.7.4", "@babel/helper-plugin-utils": "^7.0.0" } }, "@babel/plugin-transform-duplicate-keys": { - "version": "7.5.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-duplicate-keys/-/plugin-transform-duplicate-keys-7.5.0.tgz", - "integrity": "sha512-igcziksHizyQPlX9gfSjHkE2wmoCH3evvD2qR5w29/Dk0SMKE/eOI7f1HhBdNhR/zxJDqrgpoDTq5YSLH/XMsQ==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-duplicate-keys/-/plugin-transform-duplicate-keys-7.7.4.tgz", + "integrity": "sha512-g1y4/G6xGWMD85Tlft5XedGaZBCIVN+/P0bs6eabmcPP9egFleMAo65OOjlhcz1njpwagyY3t0nsQC9oTFegJA==", "dev": true, "requires": { "@babel/helper-plugin-utils": "^7.0.0" } }, "@babel/plugin-transform-exponentiation-operator": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-exponentiation-operator/-/plugin-transform-exponentiation-operator-7.2.0.tgz", - "integrity": "sha512-umh4hR6N7mu4Elq9GG8TOu9M0bakvlsREEC+ialrQN6ABS4oDQ69qJv1VtR3uxlKMCQMCvzk7vr17RHKcjx68A==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-exponentiation-operator/-/plugin-transform-exponentiation-operator-7.7.4.tgz", + "integrity": "sha512-MCqiLfCKm6KEA1dglf6Uqq1ElDIZwFuzz1WH5mTf8k2uQSxEJMbOIEh7IZv7uichr7PMfi5YVSrr1vz+ipp7AQ==", "dev": true, "requires": { - "@babel/helper-builder-binary-assignment-operator-visitor": "^7.1.0", + "@babel/helper-builder-binary-assignment-operator-visitor": "^7.7.4", "@babel/helper-plugin-utils": "^7.0.0" } }, "@babel/plugin-transform-for-of": { - "version": "7.4.4", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-for-of/-/plugin-transform-for-of-7.4.4.tgz", - "integrity": "sha512-9T/5Dlr14Z9TIEXLXkt8T1DU7F24cbhwhMNUziN3hB1AXoZcdzPcTiKGRn/6iOymDqtTKWnr/BtRKN9JwbKtdQ==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-for-of/-/plugin-transform-for-of-7.7.4.tgz", + "integrity": "sha512-zZ1fD1B8keYtEcKF+M1TROfeHTKnijcVQm0yO/Yu1f7qoDoxEIc/+GX6Go430Bg84eM/xwPFp0+h4EbZg7epAA==", "dev": true, "requires": { "@babel/helper-plugin-utils": "^7.0.0" } }, "@babel/plugin-transform-function-name": { - "version": "7.7.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-function-name/-/plugin-transform-function-name-7.7.0.tgz", - "integrity": "sha512-P5HKu0d9+CzZxP5jcrWdpe7ZlFDe24bmqP6a6X8BHEBl/eizAsY8K6LX8LASZL0Jxdjm5eEfzp+FIrxCm/p8bA==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-function-name/-/plugin-transform-function-name-7.7.4.tgz", + "integrity": "sha512-E/x09TvjHNhsULs2IusN+aJNRV5zKwxu1cpirZyRPw+FyyIKEHPXTsadj48bVpc1R5Qq1B5ZkzumuFLytnbT6g==", "dev": true, "requires": { - "@babel/helper-function-name": "^7.7.0", + "@babel/helper-function-name": "^7.7.4", "@babel/helper-plugin-utils": "^7.0.0" + }, + "dependencies": { + "@babel/helper-function-name": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-function-name/-/helper-function-name-7.7.4.tgz", + "integrity": "sha512-AnkGIdiBhEuiwdoMnKm7jfPfqItZhgRaZfMg1XX3bS25INOnLPjPG1Ppnajh8eqgt5kPJnfqrRHqFqmjKDZLzQ==", + "dev": true, + "requires": { + "@babel/helper-get-function-arity": "^7.7.4", + "@babel/template": "^7.7.4", + "@babel/types": "^7.7.4" + } + }, + "@babel/helper-get-function-arity": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-get-function-arity/-/helper-get-function-arity-7.7.4.tgz", + "integrity": "sha512-QTGKEdCkjgzgfJ3bAyRwF4yyT3pg+vDgan8DSivq1eS0gwi+KGKE5x8kRcbeFTb/673mkO5SN1IZfmCfA5o+EA==", + "dev": true, + "requires": { + "@babel/types": "^7.7.4" + } + }, + "@babel/parser": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.7.4.tgz", + "integrity": "sha512-jIwvLO0zCL+O/LmEJQjWA75MQTWwx3c3u2JOTDK5D3/9egrWRRA0/0hk9XXywYnXZVVpzrBYeIQTmhwUaePI9g==", + "dev": true + }, + "@babel/template": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/template/-/template-7.7.4.tgz", + "integrity": "sha512-qUzihgVPguAzXCK7WXw8pqs6cEwi54s3E+HrejlkuWO6ivMKx9hZl3Y2fSXp9i5HgyWmj7RKP+ulaYnKM4yYxw==", + "dev": true, + "requires": { + "@babel/code-frame": "^7.0.0", + "@babel/parser": "^7.7.4", + "@babel/types": "^7.7.4" + } + }, + "@babel/types": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.7.4.tgz", + "integrity": "sha512-cz5Ji23KCi4T+YIE/BolWosrJuSmoZeN1EFnRtBwF+KKLi8GG/Z2c2hOJJeCXPk4mwk4QFvTmwIodJowXgttRA==", + "dev": true, + "requires": { + "esutils": "^2.0.2", + "lodash": "^4.17.13", + "to-fast-properties": "^2.0.0" + } + } } }, "@babel/plugin-transform-literals": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-literals/-/plugin-transform-literals-7.2.0.tgz", - "integrity": "sha512-2ThDhm4lI4oV7fVQ6pNNK+sx+c/GM5/SaML0w/r4ZB7sAneD/piDJtwdKlNckXeyGK7wlwg2E2w33C/Hh+VFCg==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-literals/-/plugin-transform-literals-7.7.4.tgz", + "integrity": "sha512-X2MSV7LfJFm4aZfxd0yLVFrEXAgPqYoDG53Br/tCKiKYfX0MjVjQeWPIhPHHsCqzwQANq+FLN786fF5rgLS+gw==", "dev": true, "requires": { "@babel/helper-plugin-utils": "^7.0.0" } }, "@babel/plugin-transform-member-expression-literals": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-member-expression-literals/-/plugin-transform-member-expression-literals-7.2.0.tgz", - "integrity": "sha512-HiU3zKkSU6scTidmnFJ0bMX8hz5ixC93b4MHMiYebmk2lUVNGOboPsqQvx5LzooihijUoLR/v7Nc1rbBtnc7FA==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-member-expression-literals/-/plugin-transform-member-expression-literals-7.7.4.tgz", + "integrity": "sha512-9VMwMO7i69LHTesL0RdGy93JU6a+qOPuvB4F4d0kR0zyVjJRVJRaoaGjhtki6SzQUu8yen/vxPKN6CWnCUw6bA==", "dev": true, "requires": { "@babel/helper-plugin-utils": "^7.0.0" } }, "@babel/plugin-transform-modules-amd": { - "version": "7.5.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-amd/-/plugin-transform-modules-amd-7.5.0.tgz", - "integrity": "sha512-n20UsQMKnWrltocZZm24cRURxQnWIvsABPJlw/fvoy9c6AgHZzoelAIzajDHAQrDpuKFFPPcFGd7ChsYuIUMpg==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-amd/-/plugin-transform-modules-amd-7.7.4.tgz", + "integrity": "sha512-/542/5LNA18YDtg1F+QHvvUSlxdvjZoD/aldQwkq+E3WCkbEjNSN9zdrOXaSlfg3IfGi22ijzecklF/A7kVZFQ==", "dev": true, "requires": { - "@babel/helper-module-transforms": "^7.1.0", + "@babel/helper-module-transforms": "^7.7.4", "@babel/helper-plugin-utils": "^7.0.0", "babel-plugin-dynamic-import-node": "^2.3.0" } }, "@babel/plugin-transform-modules-commonjs": { - "version": "7.7.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-commonjs/-/plugin-transform-modules-commonjs-7.7.0.tgz", - "integrity": "sha512-KEMyWNNWnjOom8vR/1+d+Ocz/mILZG/eyHHO06OuBQ2aNhxT62fr4y6fGOplRx+CxCSp3IFwesL8WdINfY/3kg==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-commonjs/-/plugin-transform-modules-commonjs-7.7.4.tgz", + "integrity": "sha512-k8iVS7Jhc367IcNF53KCwIXtKAH7czev866ThsTgy8CwlXjnKZna2VHwChglzLleYrcHz1eQEIJlGRQxB53nqA==", "dev": true, "requires": { - "@babel/helper-module-transforms": "^7.7.0", + "@babel/helper-module-transforms": "^7.7.4", "@babel/helper-plugin-utils": "^7.0.0", - "@babel/helper-simple-access": "^7.7.0", + "@babel/helper-simple-access": "^7.7.4", "babel-plugin-dynamic-import-node": "^2.3.0" } }, "@babel/plugin-transform-modules-systemjs": { - "version": "7.7.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-systemjs/-/plugin-transform-modules-systemjs-7.7.0.tgz", - "integrity": "sha512-ZAuFgYjJzDNv77AjXRqzQGlQl4HdUM6j296ee4fwKVZfhDR9LAGxfvXjBkb06gNETPnN0sLqRm9Gxg4wZH6dXg==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-systemjs/-/plugin-transform-modules-systemjs-7.7.4.tgz", + "integrity": "sha512-y2c96hmcsUi6LrMqvmNDPBBiGCiQu0aYqpHatVVu6kD4mFEXKjyNxd/drc18XXAf9dv7UXjrZwBVmTTGaGP8iw==", "dev": true, "requires": { - "@babel/helper-hoist-variables": "^7.7.0", + "@babel/helper-hoist-variables": "^7.7.4", "@babel/helper-plugin-utils": "^7.0.0", "babel-plugin-dynamic-import-node": "^2.3.0" } }, "@babel/plugin-transform-modules-umd": { - "version": "7.7.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-umd/-/plugin-transform-modules-umd-7.7.0.tgz", - "integrity": "sha512-u7eBA03zmUswQ9LQ7Qw0/ieC1pcAkbp5OQatbWUzY1PaBccvuJXUkYzoN1g7cqp7dbTu6Dp9bXyalBvD04AANA==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-modules-umd/-/plugin-transform-modules-umd-7.7.4.tgz", + "integrity": "sha512-u2B8TIi0qZI4j8q4C51ktfO7E3cQ0qnaXFI1/OXITordD40tt17g/sXqgNNCcMTcBFKrUPcGDx+TBJuZxLx7tw==", "dev": true, "requires": { - "@babel/helper-module-transforms": "^7.7.0", + "@babel/helper-module-transforms": "^7.7.4", "@babel/helper-plugin-utils": "^7.0.0" } }, "@babel/plugin-transform-named-capturing-groups-regex": { - "version": "7.7.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-named-capturing-groups-regex/-/plugin-transform-named-capturing-groups-regex-7.7.0.tgz", - "integrity": "sha512-+SicSJoKouPctL+j1pqktRVCgy+xAch1hWWTMy13j0IflnyNjaoskj+DwRQFimHbLqO3sq2oN2CXMvXq3Bgapg==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-named-capturing-groups-regex/-/plugin-transform-named-capturing-groups-regex-7.7.4.tgz", + "integrity": "sha512-jBUkiqLKvUWpv9GLSuHUFYdmHg0ujC1JEYoZUfeOOfNydZXp1sXObgyPatpcwjWgsdBGsagWW0cdJpX/DO2jMw==", "dev": true, "requires": { - "@babel/helper-create-regexp-features-plugin": "^7.7.0" + "@babel/helper-create-regexp-features-plugin": "^7.7.4" } }, "@babel/plugin-transform-new-target": { - "version": "7.4.4", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-new-target/-/plugin-transform-new-target-7.4.4.tgz", - "integrity": "sha512-r1z3T2DNGQwwe2vPGZMBNjioT2scgWzK9BCnDEh+46z8EEwXBq24uRzd65I7pjtugzPSj921aM15RpESgzsSuA==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-new-target/-/plugin-transform-new-target-7.7.4.tgz", + "integrity": "sha512-CnPRiNtOG1vRodnsyGX37bHQleHE14B9dnnlgSeEs3ek3fHN1A1SScglTCg1sfbe7sRQ2BUcpgpTpWSfMKz3gg==", "dev": true, "requires": { "@babel/helper-plugin-utils": "^7.0.0" } }, "@babel/plugin-transform-object-super": { - "version": "7.5.5", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-object-super/-/plugin-transform-object-super-7.5.5.tgz", - "integrity": "sha512-un1zJQAhSosGFBduPgN/YFNvWVpRuHKU7IHBglLoLZsGmruJPOo6pbInneflUdmq7YvSVqhpPs5zdBvLnteltQ==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-object-super/-/plugin-transform-object-super-7.7.4.tgz", + "integrity": "sha512-ho+dAEhC2aRnff2JCA0SAK7V2R62zJd/7dmtoe7MHcso4C2mS+vZjn1Pb1pCVZvJs1mgsvv5+7sT+m3Bysb6eg==", "dev": true, "requires": { "@babel/helper-plugin-utils": "^7.0.0", - "@babel/helper-replace-supers": "^7.5.5" + "@babel/helper-replace-supers": "^7.7.4" } }, "@babel/plugin-transform-parameters": { - "version": "7.4.4", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-parameters/-/plugin-transform-parameters-7.4.4.tgz", - "integrity": "sha512-oMh5DUO1V63nZcu/ZVLQFqiihBGo4OpxJxR1otF50GMeCLiRx5nUdtokd+u9SuVJrvvuIh9OosRFPP4pIPnwmw==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-parameters/-/plugin-transform-parameters-7.7.4.tgz", + "integrity": "sha512-VJwhVePWPa0DqE9vcfptaJSzNDKrWU/4FbYCjZERtmqEs05g3UMXnYMZoXja7JAJ7Y7sPZipwm/pGApZt7wHlw==", "dev": true, "requires": { - "@babel/helper-call-delegate": "^7.4.4", - "@babel/helper-get-function-arity": "^7.0.0", + "@babel/helper-call-delegate": "^7.7.4", + "@babel/helper-get-function-arity": "^7.7.4", "@babel/helper-plugin-utils": "^7.0.0" + }, + "dependencies": { + "@babel/helper-get-function-arity": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/helper-get-function-arity/-/helper-get-function-arity-7.7.4.tgz", + "integrity": "sha512-QTGKEdCkjgzgfJ3bAyRwF4yyT3pg+vDgan8DSivq1eS0gwi+KGKE5x8kRcbeFTb/673mkO5SN1IZfmCfA5o+EA==", + "dev": true, + "requires": { + "@babel/types": "^7.7.4" + } + }, + "@babel/types": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.7.4.tgz", + "integrity": "sha512-cz5Ji23KCi4T+YIE/BolWosrJuSmoZeN1EFnRtBwF+KKLi8GG/Z2c2hOJJeCXPk4mwk4QFvTmwIodJowXgttRA==", + "dev": true, + "requires": { + "esutils": "^2.0.2", + "lodash": "^4.17.13", + "to-fast-properties": "^2.0.0" + } + } } }, "@babel/plugin-transform-property-literals": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-property-literals/-/plugin-transform-property-literals-7.2.0.tgz", - "integrity": "sha512-9q7Dbk4RhgcLp8ebduOpCbtjh7C0itoLYHXd9ueASKAG/is5PQtMR5VJGka9NKqGhYEGn5ITahd4h9QeBMylWQ==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-property-literals/-/plugin-transform-property-literals-7.7.4.tgz", + "integrity": "sha512-MatJhlC4iHsIskWYyawl53KuHrt+kALSADLQQ/HkhTjX954fkxIEh4q5slL4oRAnsm/eDoZ4q0CIZpcqBuxhJQ==", "dev": true, "requires": { "@babel/helper-plugin-utils": "^7.0.0" } }, "@babel/plugin-transform-regenerator": { - "version": "7.7.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-regenerator/-/plugin-transform-regenerator-7.7.0.tgz", - "integrity": "sha512-AXmvnC+0wuj/cFkkS/HFHIojxH3ffSXE+ttulrqWjZZRaUOonfJc60e1wSNT4rV8tIunvu/R3wCp71/tLAa9xg==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-regenerator/-/plugin-transform-regenerator-7.7.4.tgz", + "integrity": "sha512-e7MWl5UJvmPEwFJTwkBlPmqixCtr9yAASBqff4ggXTNicZiwbF8Eefzm6NVgfiBp7JdAGItecnctKTgH44q2Jw==", "dev": true, "requires": { "regenerator-transform": "^0.14.0" } }, "@babel/plugin-transform-reserved-words": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-reserved-words/-/plugin-transform-reserved-words-7.2.0.tgz", - "integrity": "sha512-fz43fqW8E1tAB3DKF19/vxbpib1fuyCwSPE418ge5ZxILnBhWyhtPgz8eh1RCGGJlwvksHkyxMxh0eenFi+kFw==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-reserved-words/-/plugin-transform-reserved-words-7.7.4.tgz", + "integrity": "sha512-OrPiUB5s5XvkCO1lS7D8ZtHcswIC57j62acAnJZKqGGnHP+TIc/ljQSrgdX/QyOTdEK5COAhuc820Hi1q2UgLQ==", "dev": true, "requires": { "@babel/helper-plugin-utils": "^7.0.0" } }, "@babel/plugin-transform-shorthand-properties": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-shorthand-properties/-/plugin-transform-shorthand-properties-7.2.0.tgz", - "integrity": "sha512-QP4eUM83ha9zmYtpbnyjTLAGKQritA5XW/iG9cjtuOI8s1RuL/3V6a3DeSHfKutJQ+ayUfeZJPcnCYEQzaPQqg==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-shorthand-properties/-/plugin-transform-shorthand-properties-7.7.4.tgz", + "integrity": "sha512-q+suddWRfIcnyG5YiDP58sT65AJDZSUhXQDZE3r04AuqD6d/XLaQPPXSBzP2zGerkgBivqtQm9XKGLuHqBID6Q==", "dev": true, "requires": { "@babel/helper-plugin-utils": "^7.0.0" } }, "@babel/plugin-transform-spread": { - "version": "7.6.2", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-spread/-/plugin-transform-spread-7.6.2.tgz", - "integrity": "sha512-DpSvPFryKdK1x+EDJYCy28nmAaIMdxmhot62jAXF/o99iA33Zj2Lmcp3vDmz+MUh0LNYVPvfj5iC3feb3/+PFg==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-spread/-/plugin-transform-spread-7.7.4.tgz", + "integrity": "sha512-8OSs0FLe5/80cndziPlg4R0K6HcWSM0zyNhHhLsmw/Nc5MaA49cAsnoJ/t/YZf8qkG7fD+UjTRaApVDB526d7Q==", "dev": true, "requires": { "@babel/helper-plugin-utils": "^7.0.0" } }, "@babel/plugin-transform-sticky-regex": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-sticky-regex/-/plugin-transform-sticky-regex-7.2.0.tgz", - "integrity": "sha512-KKYCoGaRAf+ckH8gEL3JHUaFVyNHKe3ASNsZ+AlktgHevvxGigoIttrEJb8iKN03Q7Eazlv1s6cx2B2cQ3Jabw==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-sticky-regex/-/plugin-transform-sticky-regex-7.7.4.tgz", + "integrity": "sha512-Ls2NASyL6qtVe1H1hXts9yuEeONV2TJZmplLONkMPUG158CtmnrzW5Q5teibM5UVOFjG0D3IC5mzXR6pPpUY7A==", "dev": true, "requires": { "@babel/helper-plugin-utils": "^7.0.0", @@ -702,112 +1557,134 @@ } }, "@babel/plugin-transform-template-literals": { - "version": "7.4.4", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-template-literals/-/plugin-transform-template-literals-7.4.4.tgz", - "integrity": "sha512-mQrEC4TWkhLN0z8ygIvEL9ZEToPhG5K7KDW3pzGqOfIGZ28Jb0POUkeWcoz8HnHvhFy6dwAT1j8OzqN8s804+g==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-template-literals/-/plugin-transform-template-literals-7.7.4.tgz", + "integrity": "sha512-sA+KxLwF3QwGj5abMHkHgshp9+rRz+oY9uoRil4CyLtgEuE/88dpkeWgNk5qKVsJE9iSfly3nvHapdRiIS2wnQ==", "dev": true, "requires": { - "@babel/helper-annotate-as-pure": "^7.0.0", + "@babel/helper-annotate-as-pure": "^7.7.4", "@babel/helper-plugin-utils": "^7.0.0" } }, "@babel/plugin-transform-typeof-symbol": { - "version": "7.2.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-typeof-symbol/-/plugin-transform-typeof-symbol-7.2.0.tgz", - "integrity": "sha512-2LNhETWYxiYysBtrBTqL8+La0jIoQQnIScUJc74OYvUGRmkskNY4EzLCnjHBzdmb38wqtTaixpo1NctEcvMDZw==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-typeof-symbol/-/plugin-transform-typeof-symbol-7.7.4.tgz", + "integrity": "sha512-KQPUQ/7mqe2m0B8VecdyaW5XcQYaePyl9R7IsKd+irzj6jvbhoGnRE+M0aNkyAzI07VfUQ9266L5xMARitV3wg==", "dev": true, "requires": { "@babel/helper-plugin-utils": "^7.0.0" } }, "@babel/plugin-transform-typescript": { - "version": "7.7.2", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-typescript/-/plugin-transform-typescript-7.7.2.tgz", - "integrity": "sha512-UWhDaJRqdPUtdK1s0sKYdoRuqK0NepjZto2UZltvuCgMoMZmdjhgz5hcRokie/3aYEaSz3xvusyoayVaq4PjRg==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-typescript/-/plugin-transform-typescript-7.7.4.tgz", + "integrity": "sha512-X8e3tcPEKnwwPVG+vP/vSqEShkwODOEeyQGod82qrIuidwIrfnsGn11qPM1jBLF4MqguTXXYzm58d0dY+/wdpg==", "dev": true, "requires": { - "@babel/helper-create-class-features-plugin": "^7.7.0", + "@babel/helper-create-class-features-plugin": "^7.7.4", "@babel/helper-plugin-utils": "^7.0.0", - "@babel/plugin-syntax-typescript": "^7.2.0" + "@babel/plugin-syntax-typescript": "^7.7.4" } }, "@babel/plugin-transform-unicode-regex": { - "version": "7.7.0", - "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-regex/-/plugin-transform-unicode-regex-7.7.0.tgz", - "integrity": "sha512-RrThb0gdrNwFAqEAAx9OWgtx6ICK69x7i9tCnMdVrxQwSDp/Abu9DXFU5Hh16VP33Rmxh04+NGW28NsIkFvFKA==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-transform-unicode-regex/-/plugin-transform-unicode-regex-7.7.4.tgz", + "integrity": "sha512-N77UUIV+WCvE+5yHw+oks3m18/umd7y392Zv7mYTpFqHtkpcc+QUz+gLJNTWVlWROIWeLqY0f3OjZxV5TcXnRw==", "dev": true, "requires": { - "@babel/helper-create-regexp-features-plugin": "^7.7.0", + "@babel/helper-create-regexp-features-plugin": "^7.7.4", "@babel/helper-plugin-utils": "^7.0.0" } }, "@babel/preset-env": { - "version": "7.7.1", - "resolved": "https://registry.npmjs.org/@babel/preset-env/-/preset-env-7.7.1.tgz", - "integrity": "sha512-/93SWhi3PxcVTDpSqC+Dp4YxUu3qZ4m7I76k0w73wYfn7bGVuRIO4QUz95aJksbS+AD1/mT1Ie7rbkT0wSplaA==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/preset-env/-/preset-env-7.7.4.tgz", + "integrity": "sha512-Dg+ciGJjwvC1NIe/DGblMbcGq1HOtKbw8RLl4nIjlfcILKEOkWT/vRqPpumswABEBVudii6dnVwrBtzD7ibm4g==", "dev": true, "requires": { - "@babel/helper-module-imports": "^7.7.0", + "@babel/helper-module-imports": "^7.7.4", "@babel/helper-plugin-utils": "^7.0.0", - "@babel/plugin-proposal-async-generator-functions": "^7.7.0", - "@babel/plugin-proposal-dynamic-import": "^7.7.0", - "@babel/plugin-proposal-json-strings": "^7.2.0", - "@babel/plugin-proposal-object-rest-spread": "^7.6.2", - "@babel/plugin-proposal-optional-catch-binding": "^7.2.0", - "@babel/plugin-proposal-unicode-property-regex": "^7.7.0", - "@babel/plugin-syntax-async-generators": "^7.2.0", - "@babel/plugin-syntax-dynamic-import": "^7.2.0", - "@babel/plugin-syntax-json-strings": "^7.2.0", - "@babel/plugin-syntax-object-rest-spread": "^7.2.0", - "@babel/plugin-syntax-optional-catch-binding": "^7.2.0", - "@babel/plugin-syntax-top-level-await": "^7.7.0", - "@babel/plugin-transform-arrow-functions": "^7.2.0", - "@babel/plugin-transform-async-to-generator": "^7.7.0", - "@babel/plugin-transform-block-scoped-functions": "^7.2.0", - "@babel/plugin-transform-block-scoping": "^7.6.3", - "@babel/plugin-transform-classes": "^7.7.0", - "@babel/plugin-transform-computed-properties": "^7.2.0", - "@babel/plugin-transform-destructuring": "^7.6.0", - "@babel/plugin-transform-dotall-regex": "^7.7.0", - "@babel/plugin-transform-duplicate-keys": "^7.5.0", - "@babel/plugin-transform-exponentiation-operator": "^7.2.0", - "@babel/plugin-transform-for-of": "^7.4.4", - "@babel/plugin-transform-function-name": "^7.7.0", - "@babel/plugin-transform-literals": "^7.2.0", - "@babel/plugin-transform-member-expression-literals": "^7.2.0", - "@babel/plugin-transform-modules-amd": "^7.5.0", - "@babel/plugin-transform-modules-commonjs": "^7.7.0", - "@babel/plugin-transform-modules-systemjs": "^7.7.0", - "@babel/plugin-transform-modules-umd": "^7.7.0", - "@babel/plugin-transform-named-capturing-groups-regex": "^7.7.0", - "@babel/plugin-transform-new-target": "^7.4.4", - "@babel/plugin-transform-object-super": "^7.5.5", - "@babel/plugin-transform-parameters": "^7.4.4", - "@babel/plugin-transform-property-literals": "^7.2.0", - "@babel/plugin-transform-regenerator": "^7.7.0", - "@babel/plugin-transform-reserved-words": "^7.2.0", - "@babel/plugin-transform-shorthand-properties": "^7.2.0", - "@babel/plugin-transform-spread": "^7.6.2", - "@babel/plugin-transform-sticky-regex": "^7.2.0", - "@babel/plugin-transform-template-literals": "^7.4.4", - "@babel/plugin-transform-typeof-symbol": "^7.2.0", - "@babel/plugin-transform-unicode-regex": "^7.7.0", - "@babel/types": "^7.7.1", + "@babel/plugin-proposal-async-generator-functions": "^7.7.4", + "@babel/plugin-proposal-dynamic-import": "^7.7.4", + "@babel/plugin-proposal-json-strings": "^7.7.4", + "@babel/plugin-proposal-object-rest-spread": "^7.7.4", + "@babel/plugin-proposal-optional-catch-binding": "^7.7.4", + "@babel/plugin-proposal-unicode-property-regex": "^7.7.4", + "@babel/plugin-syntax-async-generators": "^7.7.4", + "@babel/plugin-syntax-dynamic-import": "^7.7.4", + "@babel/plugin-syntax-json-strings": "^7.7.4", + "@babel/plugin-syntax-object-rest-spread": "^7.7.4", + "@babel/plugin-syntax-optional-catch-binding": "^7.7.4", + "@babel/plugin-syntax-top-level-await": "^7.7.4", + "@babel/plugin-transform-arrow-functions": "^7.7.4", + "@babel/plugin-transform-async-to-generator": "^7.7.4", + "@babel/plugin-transform-block-scoped-functions": "^7.7.4", + "@babel/plugin-transform-block-scoping": "^7.7.4", + "@babel/plugin-transform-classes": "^7.7.4", + "@babel/plugin-transform-computed-properties": "^7.7.4", + "@babel/plugin-transform-destructuring": "^7.7.4", + "@babel/plugin-transform-dotall-regex": "^7.7.4", + "@babel/plugin-transform-duplicate-keys": "^7.7.4", + "@babel/plugin-transform-exponentiation-operator": "^7.7.4", + "@babel/plugin-transform-for-of": "^7.7.4", + "@babel/plugin-transform-function-name": "^7.7.4", + "@babel/plugin-transform-literals": "^7.7.4", + "@babel/plugin-transform-member-expression-literals": "^7.7.4", + "@babel/plugin-transform-modules-amd": "^7.7.4", + "@babel/plugin-transform-modules-commonjs": "^7.7.4", + "@babel/plugin-transform-modules-systemjs": "^7.7.4", + "@babel/plugin-transform-modules-umd": "^7.7.4", + "@babel/plugin-transform-named-capturing-groups-regex": "^7.7.4", + "@babel/plugin-transform-new-target": "^7.7.4", + "@babel/plugin-transform-object-super": "^7.7.4", + "@babel/plugin-transform-parameters": "^7.7.4", + "@babel/plugin-transform-property-literals": "^7.7.4", + "@babel/plugin-transform-regenerator": "^7.7.4", + "@babel/plugin-transform-reserved-words": "^7.7.4", + "@babel/plugin-transform-shorthand-properties": "^7.7.4", + "@babel/plugin-transform-spread": "^7.7.4", + "@babel/plugin-transform-sticky-regex": "^7.7.4", + "@babel/plugin-transform-template-literals": "^7.7.4", + "@babel/plugin-transform-typeof-symbol": "^7.7.4", + "@babel/plugin-transform-unicode-regex": "^7.7.4", + "@babel/types": "^7.7.4", "browserslist": "^4.6.0", "core-js-compat": "^3.1.1", "invariant": "^2.2.2", "js-levenshtein": "^1.1.3", "semver": "^5.5.0" + }, + "dependencies": { + "@babel/plugin-syntax-object-rest-spread": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/plugin-syntax-object-rest-spread/-/plugin-syntax-object-rest-spread-7.7.4.tgz", + "integrity": "sha512-mObR+r+KZq0XhRVS2BrBKBpr5jqrqzlPvS9C9vuOf5ilSwzloAl7RPWLrgKdWS6IreaVrjHxTjtyqFiOisaCwg==", + "dev": true, + "requires": { + "@babel/helper-plugin-utils": "^7.0.0" + } + }, + "@babel/types": { + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.7.4.tgz", + "integrity": "sha512-cz5Ji23KCi4T+YIE/BolWosrJuSmoZeN1EFnRtBwF+KKLi8GG/Z2c2hOJJeCXPk4mwk4QFvTmwIodJowXgttRA==", + "dev": true, + "requires": { + "esutils": "^2.0.2", + "lodash": "^4.17.13", + "to-fast-properties": "^2.0.0" + } + } } }, "@babel/preset-typescript": { - "version": "7.7.2", - "resolved": "https://registry.npmjs.org/@babel/preset-typescript/-/preset-typescript-7.7.2.tgz", - "integrity": "sha512-1B4HthAelaLGfNRyrWqJtBEjXX1ulThCrLQ5B2VOtEAznWFIFXFJahgXImqppy66lx/Oh+cOSCQdJzZqh2Jh5g==", + "version": "7.7.4", + "resolved": "https://registry.npmjs.org/@babel/preset-typescript/-/preset-typescript-7.7.4.tgz", + "integrity": "sha512-rqrjxfdiHPsnuPur0jKrIIGQCIgoTWMTjlbWE69G4QJ6TIOVnnRnIJhUxNTL/VwDmEAVX08Tq3B1nirer5341w==", "dev": true, "requires": { "@babel/helper-plugin-utils": "^7.0.0", - "@babel/plugin-transform-typescript": "^7.7.2" + "@babel/plugin-transform-typescript": "^7.7.4" } }, "@babel/runtime": { @@ -858,6 +1735,12 @@ "to-fast-properties": "^2.0.0" } }, + "@bcoe/v8-coverage": { + "version": "0.2.3", + "resolved": "https://registry.npmjs.org/@bcoe/v8-coverage/-/v8-coverage-0.2.3.tgz", + "integrity": "sha512-0hYQ8SB4Db5zvZB4axdMHGwEaQjkZzFjQiN9LVYvIFB2nSUHW9tYpxWriPrWDASIxiaXax83REcLxuSdnGPZtw==", + "dev": true + }, "@cnakazawa/watch": { "version": "1.0.3", "resolved": "https://registry.npmjs.org/@cnakazawa/watch/-/watch-1.0.3.tgz", @@ -886,286 +1769,724 @@ "prettier": "^1.13.7" } }, - "@jest/console": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/@jest/console/-/console-24.9.0.tgz", - "integrity": "sha512-Zuj6b8TnKXi3q4ymac8EQfc3ea/uhLeCGThFqXeC8H9/raaH8ARPUTdId+XyGd03Z4In0/VjD2OYFcBF09fNLQ==", - "dev": true, - "requires": { - "@jest/source-map": "^24.9.0", - "chalk": "^2.0.1", - "slash": "^2.0.0" - } - }, - "@jest/core": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/@jest/core/-/core-24.9.0.tgz", - "integrity": "sha512-Fogg3s4wlAr1VX7q+rhV9RVnUv5tD7VuWfYy1+whMiWUrvl7U3QJSJyWcDio9Lq2prqYsZaeTv2Rz24pWGkJ2A==", + "@istanbuljs/load-nyc-config": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/@istanbuljs/load-nyc-config/-/load-nyc-config-1.0.0.tgz", + "integrity": "sha512-ZR0rq/f/E4f4XcgnDvtMWXCUJpi8eO0rssVhmztsZqLIEFA9UUP9zmpE0VxlM+kv/E1ul2I876Fwil2ayptDVg==", "dev": true, "requires": { - "@jest/console": "^24.7.1", - "@jest/reporters": "^24.9.0", - "@jest/test-result": "^24.9.0", - "@jest/transform": "^24.9.0", - "@jest/types": "^24.9.0", - "ansi-escapes": "^3.0.0", - "chalk": "^2.0.1", - "exit": "^0.1.2", - "graceful-fs": "^4.1.15", - "jest-changed-files": "^24.9.0", - "jest-config": "^24.9.0", - "jest-haste-map": "^24.9.0", - "jest-message-util": "^24.9.0", - "jest-regex-util": "^24.3.0", - "jest-resolve": "^24.9.0", - "jest-resolve-dependencies": "^24.9.0", - "jest-runner": "^24.9.0", - "jest-runtime": "^24.9.0", - "jest-snapshot": "^24.9.0", - "jest-util": "^24.9.0", - "jest-validate": "^24.9.0", - "jest-watcher": "^24.9.0", - "micromatch": "^3.1.10", - "p-each-series": "^1.0.0", - "realpath-native": "^1.1.0", - "rimraf": "^2.5.4", - "slash": "^2.0.0", - "strip-ansi": "^5.0.0" + "camelcase": "^5.3.1", + "find-up": "^4.1.0", + "js-yaml": "^3.13.1", + "resolve-from": "^5.0.0" }, "dependencies": { - "ansi-escapes": { - "version": "3.2.0", - "resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-3.2.0.tgz", - "integrity": "sha512-cBhpre4ma+U0T1oM5fXg7Dy1Jw7zzwv7lt/GoCpr+hDQJoYnKVPLL4dCvSEFMmQurOQvSrwT7SL/DAlhBI97RQ==", - "dev": true - } - } - }, - "@jest/environment": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/@jest/environment/-/environment-24.9.0.tgz", - "integrity": "sha512-5A1QluTPhvdIPFYnO3sZC3smkNeXPVELz7ikPbhUj0bQjB07EoE9qtLrem14ZUYWdVayYbsjVwIiL4WBIMV4aQ==", - "dev": true, - "requires": { - "@jest/fake-timers": "^24.9.0", - "@jest/transform": "^24.9.0", - "@jest/types": "^24.9.0", - "jest-mock": "^24.9.0" - } - }, - "@jest/fake-timers": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/@jest/fake-timers/-/fake-timers-24.9.0.tgz", - "integrity": "sha512-eWQcNa2YSwzXWIMC5KufBh3oWRIijrQFROsIqt6v/NS9Io/gknw1jsAC9c+ih/RQX4A3O7SeWAhQeN0goKhT9A==", - "dev": true, - "requires": { - "@jest/types": "^24.9.0", - "jest-message-util": "^24.9.0", - "jest-mock": "^24.9.0" + "find-up": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-4.1.0.tgz", + "integrity": "sha512-PpOwAdQ/YlXQ2vj8a3h8IipDuYRi3wceVQQGYWxNINccq40Anw7BlsEXCMbt1Zt+OLA6Fq9suIpIWD0OsnISlw==", + "dev": true, + "requires": { + "locate-path": "^5.0.0", + "path-exists": "^4.0.0" + } + }, + "locate-path": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-5.0.0.tgz", + "integrity": "sha512-t7hw9pI+WvuwNJXwk5zVHpyhIqzg2qTlklJOf0mVxGSbe3Fp2VieZcduNYjaLDoy6p9uGpQEGWG87WpMKlNq8g==", + "dev": true, + "requires": { + "p-locate": "^4.1.0" + } + }, + "p-limit": { + "version": "2.2.2", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.2.2.tgz", + "integrity": "sha512-WGR+xHecKTr7EbUEhyLSh5Dube9JtdiG78ufaeLxTgpudf/20KqyMioIUZJAezlTIi6evxuoUs9YXc11cU+yzQ==", + "dev": true, + "requires": { + "p-try": "^2.0.0" + } + }, + "p-locate": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-4.1.0.tgz", + "integrity": "sha512-R79ZZ/0wAxKGu3oYMlz8jy/kbhsNrS7SKZ7PxEHBgJ5+F2mtFW2fK2cOtBh1cHYkQsbzFV7I+EoRKe6Yt0oK7A==", + "dev": true, + "requires": { + "p-limit": "^2.2.0" + } + }, + "p-try": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", + "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==", + "dev": true + }, + "path-exists": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-4.0.0.tgz", + "integrity": "sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w==", + "dev": true + } } }, - "@jest/reporters": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/@jest/reporters/-/reporters-24.9.0.tgz", - "integrity": "sha512-mu4X0yjaHrffOsWmVLzitKmmmWSQ3GGuefgNscUSWNiUNcEOSEQk9k3pERKEQVBb0Cnn88+UESIsZEMH3o88Gw==", + "@istanbuljs/schema": { + "version": "0.1.2", + "resolved": "https://registry.npmjs.org/@istanbuljs/schema/-/schema-0.1.2.tgz", + "integrity": "sha512-tsAQNx32a8CoFhjhijUIhI4kccIAgmGhy8LZMZgGfmXcpMbPRUqn5LWmgRttILi6yeGmBJd2xsPkFMs0PzgPCw==", + "dev": true + }, + "@jest/console": { + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/@jest/console/-/console-25.1.0.tgz", + "integrity": "sha512-3P1DpqAMK/L07ag/Y9/Jup5iDEG9P4pRAuZiMQnU0JB3UOvCyYCjCoxr7sIA80SeyUCUKrr24fKAxVpmBgQonA==", "dev": true, "requires": { - "@jest/environment": "^24.9.0", - "@jest/test-result": "^24.9.0", - "@jest/transform": "^24.9.0", - "@jest/types": "^24.9.0", - "chalk": "^2.0.1", - "exit": "^0.1.2", - "glob": "^7.1.2", - "istanbul-lib-coverage": "^2.0.2", - "istanbul-lib-instrument": "^3.0.1", - "istanbul-lib-report": "^2.0.4", - "istanbul-lib-source-maps": "^3.0.1", - "istanbul-reports": "^2.2.6", - "jest-haste-map": "^24.9.0", - "jest-resolve": "^24.9.0", - "jest-runtime": "^24.9.0", - "jest-util": "^24.9.0", - "jest-worker": "^24.6.0", - "node-notifier": "^5.4.2", - "slash": "^2.0.0", - "source-map": "^0.6.0", - "string-length": "^2.0.0" + "@jest/source-map": "^25.1.0", + "chalk": "^3.0.0", + "jest-util": "^25.1.0", + "slash": "^3.0.0" }, "dependencies": { - "source-map": { - "version": "0.6.1", - "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", - "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "ansi-styles": { + "version": "4.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.2.1.tgz", + "integrity": "sha512-9VGjrMsG1vePxcSweQsN20KY/c4zN0h9fLjqAbwbPfahM3t+NL+M9HC8xeXG2I8pX5NoamTGNuomEUFI7fcUjA==", + "dev": true, + "requires": { + "@types/color-name": "^1.1.1", + "color-convert": "^2.0.1" + } + }, + "chalk": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-3.0.0.tgz", + "integrity": "sha512-4D3B6Wf41KOYRFdszmDqMCGq5VV/uMAB273JILmO+3jAlh8X4qDtdtgCR3fxtbLEMzSx22QdhnDcJvu2u1fVwg==", + "dev": true, + "requires": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + } + }, + "color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "requires": { + "color-name": "~1.1.4" + } + }, + "color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + }, + "has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", "dev": true + }, + "supports-color": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.1.0.tgz", + "integrity": "sha512-oRSIpR8pxT1Wr2FquTNnGet79b3BWljqOuoW/h4oBhxJ/HUbX5nX6JSruTkvXDCFMwDPvsaTTbvMLKZWSy0R5g==", + "dev": true, + "requires": { + "has-flag": "^4.0.0" + } } } }, - "@jest/source-map": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/@jest/source-map/-/source-map-24.9.0.tgz", - "integrity": "sha512-/Xw7xGlsZb4MJzNDgB7PW5crou5JqWiBQaz6xyPd3ArOg2nfn/PunV8+olXbbEZzNl591o5rWKE9BRDaFAuIBg==", + "@jest/core": { + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/@jest/core/-/core-25.1.0.tgz", + "integrity": "sha512-iz05+NmwCmZRzMXvMo6KFipW7nzhbpEawrKrkkdJzgytavPse0biEnCNr2wRlyCsp3SmKaEY+SGv7YWYQnIdig==", "dev": true, "requires": { - "callsites": "^3.0.0", - "graceful-fs": "^4.1.15", - "source-map": "^0.6.0" + "@jest/console": "^25.1.0", + "@jest/reporters": "^25.1.0", + "@jest/test-result": "^25.1.0", + "@jest/transform": "^25.1.0", + "@jest/types": "^25.1.0", + "ansi-escapes": "^4.2.1", + "chalk": "^3.0.0", + "exit": "^0.1.2", + "graceful-fs": "^4.2.3", + "jest-changed-files": "^25.1.0", + "jest-config": "^25.1.0", + "jest-haste-map": "^25.1.0", + "jest-message-util": "^25.1.0", + "jest-regex-util": "^25.1.0", + "jest-resolve": "^25.1.0", + "jest-resolve-dependencies": "^25.1.0", + "jest-runner": "^25.1.0", + "jest-runtime": "^25.1.0", + "jest-snapshot": "^25.1.0", + "jest-util": "^25.1.0", + "jest-validate": "^25.1.0", + "jest-watcher": "^25.1.0", + "micromatch": "^4.0.2", + "p-each-series": "^2.1.0", + "realpath-native": "^1.1.0", + "rimraf": "^3.0.0", + "slash": "^3.0.0", + "strip-ansi": "^6.0.0" }, "dependencies": { - "callsites": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz", - "integrity": "sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==", + "ansi-regex": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.0.tgz", + "integrity": "sha512-bY6fj56OUQ0hU1KjFNDQuJFezqKdrAyFdIevADiqrWHwSlbmBNMHp5ak2f40Pm8JTFyM2mqxkG6ngkHO11f/lg==", "dev": true }, - "source-map": { - "version": "0.6.1", - "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", - "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "ansi-styles": { + "version": "4.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.2.1.tgz", + "integrity": "sha512-9VGjrMsG1vePxcSweQsN20KY/c4zN0h9fLjqAbwbPfahM3t+NL+M9HC8xeXG2I8pX5NoamTGNuomEUFI7fcUjA==", + "dev": true, + "requires": { + "@types/color-name": "^1.1.1", + "color-convert": "^2.0.1" + } + }, + "braces": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz", + "integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==", + "dev": true, + "requires": { + "fill-range": "^7.0.1" + } + }, + "chalk": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-3.0.0.tgz", + "integrity": "sha512-4D3B6Wf41KOYRFdszmDqMCGq5VV/uMAB273JILmO+3jAlh8X4qDtdtgCR3fxtbLEMzSx22QdhnDcJvu2u1fVwg==", + "dev": true, + "requires": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + } + }, + "color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "requires": { + "color-name": "~1.1.4" + } + }, + "color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + }, + "fill-range": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz", + "integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==", + "dev": true, + "requires": { + "to-regex-range": "^5.0.1" + } + }, + "has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", "dev": true + }, + "is-number": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", + "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", + "dev": true + }, + "micromatch": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.2.tgz", + "integrity": "sha512-y7FpHSbMUMoyPbYUSzO6PaZ6FyRnQOpHuKwbo1G+Knck95XVU4QAiKdGEnj5wwoS7PlOgthX/09u5iFJ+aYf5Q==", + "dev": true, + "requires": { + "braces": "^3.0.1", + "picomatch": "^2.0.5" + } + }, + "rimraf": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-3.0.1.tgz", + "integrity": "sha512-IQ4ikL8SjBiEDZfk+DFVwqRK8md24RWMEJkdSlgNLkyyAImcjf8SWvU1qFMDOb4igBClbTQ/ugPqXcRwdFTxZw==", + "dev": true, + "requires": { + "glob": "^7.1.3" + } + }, + "strip-ansi": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.0.tgz", + "integrity": "sha512-AuvKTrTfQNYNIctbR1K/YGTR1756GycPsg7b9bdV9Duqur4gv6aKqHXah67Z8ImS7WEz5QVcOtlfW2rZEugt6w==", + "dev": true, + "requires": { + "ansi-regex": "^5.0.0" + } + }, + "supports-color": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.1.0.tgz", + "integrity": "sha512-oRSIpR8pxT1Wr2FquTNnGet79b3BWljqOuoW/h4oBhxJ/HUbX5nX6JSruTkvXDCFMwDPvsaTTbvMLKZWSy0R5g==", + "dev": true, + "requires": { + "has-flag": "^4.0.0" + } + }, + "to-regex-range": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", + "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", + "dev": true, + "requires": { + "is-number": "^7.0.0" + } } } }, - "@jest/test-result": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/@jest/test-result/-/test-result-24.9.0.tgz", - "integrity": "sha512-XEFrHbBonBJ8dGp2JmF8kP/nQI/ImPpygKHwQ/SY+es59Z3L5PI4Qb9TQQMAEeYsThG1xF0k6tmG0tIKATNiiA==", + "@jest/environment": { + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/@jest/environment/-/environment-25.1.0.tgz", + "integrity": "sha512-cTpUtsjU4cum53VqBDlcW0E4KbQF03Cn0jckGPW/5rrE9tb+porD3+hhLtHAwhthsqfyF+bizyodTlsRA++sHg==", "dev": true, "requires": { - "@jest/console": "^24.9.0", - "@jest/types": "^24.9.0", - "@types/istanbul-lib-coverage": "^2.0.0" + "@jest/fake-timers": "^25.1.0", + "@jest/types": "^25.1.0", + "jest-mock": "^25.1.0" } }, - "@jest/test-sequencer": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/@jest/test-sequencer/-/test-sequencer-24.9.0.tgz", - "integrity": "sha512-6qqsU4o0kW1dvA95qfNog8v8gkRN9ph6Lz7r96IvZpHdNipP2cBcb07J1Z45mz/VIS01OHJ3pY8T5fUY38tg4A==", + "@jest/fake-timers": { + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/@jest/fake-timers/-/fake-timers-25.1.0.tgz", + "integrity": "sha512-Eu3dysBzSAO1lD7cylZd/CVKdZZ1/43SF35iYBNV1Lvvn2Undp3Grwsv8PrzvbLhqwRzDd4zxrY4gsiHc+wygQ==", "dev": true, "requires": { - "@jest/test-result": "^24.9.0", - "jest-haste-map": "^24.9.0", - "jest-runner": "^24.9.0", - "jest-runtime": "^24.9.0" + "@jest/types": "^25.1.0", + "jest-message-util": "^25.1.0", + "jest-mock": "^25.1.0", + "jest-util": "^25.1.0", + "lolex": "^5.0.0" } }, - "@jest/transform": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/@jest/transform/-/transform-24.9.0.tgz", - "integrity": "sha512-TcQUmyNRxV94S0QpMOnZl0++6RMiqpbH/ZMccFB/amku6Uwvyb1cjYX7xkp5nGNkbX4QPH/FcB6q1HBTHynLmQ==", - "dev": true, - "requires": { - "@babel/core": "^7.1.0", - "@jest/types": "^24.9.0", - "babel-plugin-istanbul": "^5.1.0", - "chalk": "^2.0.1", - "convert-source-map": "^1.4.0", - "fast-json-stable-stringify": "^2.0.0", - "graceful-fs": "^4.1.15", - "jest-haste-map": "^24.9.0", - "jest-regex-util": "^24.9.0", - "jest-util": "^24.9.0", - "micromatch": "^3.1.10", - "pirates": "^4.0.1", - "realpath-native": "^1.1.0", - "slash": "^2.0.0", - "source-map": "^0.6.1", - "write-file-atomic": "2.4.1" + "@jest/reporters": { + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/@jest/reporters/-/reporters-25.1.0.tgz", + "integrity": "sha512-ORLT7hq2acJQa8N+NKfs68ZtHFnJPxsGqmofxW7v7urVhzJvpKZG9M7FAcgh9Ee1ZbCteMrirHA3m5JfBtAaDg==", + "dev": true, + "requires": { + "@bcoe/v8-coverage": "^0.2.3", + "@jest/console": "^25.1.0", + "@jest/environment": "^25.1.0", + "@jest/test-result": "^25.1.0", + "@jest/transform": "^25.1.0", + "@jest/types": "^25.1.0", + "chalk": "^3.0.0", + "collect-v8-coverage": "^1.0.0", + "exit": "^0.1.2", + "glob": "^7.1.2", + "istanbul-lib-coverage": "^3.0.0", + "istanbul-lib-instrument": "^4.0.0", + "istanbul-lib-report": "^3.0.0", + "istanbul-lib-source-maps": "^4.0.0", + "istanbul-reports": "^3.0.0", + "jest-haste-map": "^25.1.0", + "jest-resolve": "^25.1.0", + "jest-runtime": "^25.1.0", + "jest-util": "^25.1.0", + "jest-worker": "^25.1.0", + "node-notifier": "^6.0.0", + "slash": "^3.0.0", + "source-map": "^0.6.0", + "string-length": "^3.1.0", + "terminal-link": "^2.0.0", + "v8-to-istanbul": "^4.0.1" }, "dependencies": { + "ansi-styles": { + "version": "4.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.2.1.tgz", + "integrity": "sha512-9VGjrMsG1vePxcSweQsN20KY/c4zN0h9fLjqAbwbPfahM3t+NL+M9HC8xeXG2I8pX5NoamTGNuomEUFI7fcUjA==", + "dev": true, + "requires": { + "@types/color-name": "^1.1.1", + "color-convert": "^2.0.1" + } + }, + "chalk": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-3.0.0.tgz", + "integrity": "sha512-4D3B6Wf41KOYRFdszmDqMCGq5VV/uMAB273JILmO+3jAlh8X4qDtdtgCR3fxtbLEMzSx22QdhnDcJvu2u1fVwg==", + "dev": true, + "requires": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + } + }, + "color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "requires": { + "color-name": "~1.1.4" + } + }, + "color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + }, + "has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true + }, "source-map": { "version": "0.6.1", "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", "dev": true }, - "write-file-atomic": { - "version": "2.4.1", - "resolved": "https://registry.npmjs.org/write-file-atomic/-/write-file-atomic-2.4.1.tgz", - "integrity": "sha512-TGHFeZEZMnv+gBFRfjAcxL5bPHrsGKtnb4qsFAws7/vlh+QfwAaySIw4AXP9ZskTTh5GWu3FLuJhsWVdiJPGvg==", + "supports-color": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.1.0.tgz", + "integrity": "sha512-oRSIpR8pxT1Wr2FquTNnGet79b3BWljqOuoW/h4oBhxJ/HUbX5nX6JSruTkvXDCFMwDPvsaTTbvMLKZWSy0R5g==", "dev": true, "requires": { - "graceful-fs": "^4.1.11", - "imurmurhash": "^0.1.4", - "signal-exit": "^3.0.2" + "has-flag": "^4.0.0" } } } }, - "@jest/types": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/@jest/types/-/types-24.9.0.tgz", - "integrity": "sha512-XKK7ze1apu5JWQ5eZjHITP66AX+QsLlbaJRBGYr8pNzwcAE2JVkwnf0yqjHTsDRcjR0mujy/NmZMXw5kl+kGBw==", - "dev": true, - "requires": { - "@types/istanbul-lib-coverage": "^2.0.0", - "@types/istanbul-reports": "^1.1.1", - "@types/yargs": "^13.0.0" - } - }, - "@nodelib/fs.scandir": { - "version": "2.1.3", - "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.3.tgz", - "integrity": "sha512-eGmwYQn3gxo4r7jdQnkrrN6bY478C3P+a/y72IJukF8LjB6ZHeB3c+Ehacj3sYeSmUXGlnA67/PmbM9CVwL7Dw==", + "@jest/source-map": { + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/@jest/source-map/-/source-map-25.1.0.tgz", + "integrity": "sha512-ohf2iKT0xnLWcIUhL6U6QN+CwFWf9XnrM2a6ybL9NXxJjgYijjLSitkYHIdzkd8wFliH73qj/+epIpTiWjRtAA==", "dev": true, "requires": { - "@nodelib/fs.stat": "2.0.3", - "run-parallel": "^1.1.9" + "callsites": "^3.0.0", + "graceful-fs": "^4.2.3", + "source-map": "^0.6.0" + }, + "dependencies": { + "callsites": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz", + "integrity": "sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==", + "dev": true + }, + "source-map": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", + "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "dev": true + } } }, - "@nodelib/fs.stat": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.3.tgz", - "integrity": "sha512-bQBFruR2TAwoevBEd/NWMoAAtNGzTRgdrqnYCc7dhzfoNvqPzLyqlEQnzZ3kVnNrSp25iyxE00/3h2fqGAGArA==", - "dev": true - }, - "@nodelib/fs.walk": { - "version": "1.2.4", - "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.4.tgz", - "integrity": "sha512-1V9XOY4rDW0rehzbrcqAmHnz8e7SKvX27gh8Gt2WgB0+pdzdiLV83p72kZPU+jvMbS1qU5mauP2iOvO8rhmurQ==", + "@jest/test-result": { + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/@jest/test-result/-/test-result-25.1.0.tgz", + "integrity": "sha512-FZzSo36h++U93vNWZ0KgvlNuZ9pnDnztvaM7P/UcTx87aPDotG18bXifkf1Ji44B7k/eIatmMzkBapnAzjkJkg==", "dev": true, "requires": { - "@nodelib/fs.scandir": "2.1.3", - "fastq": "^1.6.0" + "@jest/console": "^25.1.0", + "@jest/transform": "^25.1.0", + "@jest/types": "^25.1.0", + "@types/istanbul-lib-coverage": "^2.0.0", + "collect-v8-coverage": "^1.0.0" } }, - "@octokit/auth-token": { - "version": "2.4.0", - "resolved": "https://registry.npmjs.org/@octokit/auth-token/-/auth-token-2.4.0.tgz", - "integrity": "sha512-eoOVMjILna7FVQf96iWc3+ZtE/ZT6y8ob8ZzcqKY1ibSQCnu4O/B7pJvzMx5cyZ/RjAff6DAdEb0O0Cjcxidkg==", + "@jest/test-sequencer": { + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/@jest/test-sequencer/-/test-sequencer-25.1.0.tgz", + "integrity": "sha512-WgZLRgVr2b4l/7ED1J1RJQBOharxS11EFhmwDqknpknE0Pm87HLZVS2Asuuw+HQdfQvm2aXL2FvvBLxOD1D0iw==", "dev": true, "requires": { - "@octokit/types": "^2.0.0" + "@jest/test-result": "^25.1.0", + "jest-haste-map": "^25.1.0", + "jest-runner": "^25.1.0", + "jest-runtime": "^25.1.0" } }, - "@octokit/core": { - "version": "2.1.2", - "resolved": "https://registry.npmjs.org/@octokit/core/-/core-2.1.2.tgz", - "integrity": "sha512-cMKjowQkNOHN9d6SmZsdjbuHarBmmvl7OeFv+6VDp0hTObuEqO6N/lh8buOD6wwK04RcvJ9sq5bEvF47oWeJIQ==", + "@jest/transform": { + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/@jest/transform/-/transform-25.1.0.tgz", + "integrity": "sha512-4ktrQ2TPREVeM+KxB4zskAT84SnmG1vaz4S+51aTefyqn3zocZUnliLLm5Fsl85I3p/kFPN4CRp1RElIfXGegQ==", "dev": true, "requires": { - "@octokit/auth-token": "^2.4.0", - "@octokit/graphql": "^4.3.1", - "@octokit/request": "^5.3.1", - "@octokit/types": "^2.0.0", - "before-after-hook": "^2.1.0", - "universal-user-agent": "^4.0.0" + "@babel/core": "^7.1.0", + "@jest/types": "^25.1.0", + "babel-plugin-istanbul": "^6.0.0", + "chalk": "^3.0.0", + "convert-source-map": "^1.4.0", + "fast-json-stable-stringify": "^2.0.0", + "graceful-fs": "^4.2.3", + "jest-haste-map": "^25.1.0", + "jest-regex-util": "^25.1.0", + "jest-util": "^25.1.0", + "micromatch": "^4.0.2", + "pirates": "^4.0.1", + "realpath-native": "^1.1.0", + "slash": "^3.0.0", + "source-map": "^0.6.1", + "write-file-atomic": "^3.0.0" + }, + "dependencies": { + "ansi-styles": { + "version": "4.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.2.1.tgz", + "integrity": "sha512-9VGjrMsG1vePxcSweQsN20KY/c4zN0h9fLjqAbwbPfahM3t+NL+M9HC8xeXG2I8pX5NoamTGNuomEUFI7fcUjA==", + "dev": true, + "requires": { + "@types/color-name": "^1.1.1", + "color-convert": "^2.0.1" + } + }, + "braces": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz", + "integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==", + "dev": true, + "requires": { + "fill-range": "^7.0.1" + } + }, + "chalk": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-3.0.0.tgz", + "integrity": "sha512-4D3B6Wf41KOYRFdszmDqMCGq5VV/uMAB273JILmO+3jAlh8X4qDtdtgCR3fxtbLEMzSx22QdhnDcJvu2u1fVwg==", + "dev": true, + "requires": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + } + }, + "color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "requires": { + "color-name": "~1.1.4" + } + }, + "color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + }, + "fill-range": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz", + "integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==", + "dev": true, + "requires": { + "to-regex-range": "^5.0.1" + } + }, + "has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true + }, + "is-number": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", + "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", + "dev": true + }, + "micromatch": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.2.tgz", + "integrity": "sha512-y7FpHSbMUMoyPbYUSzO6PaZ6FyRnQOpHuKwbo1G+Knck95XVU4QAiKdGEnj5wwoS7PlOgthX/09u5iFJ+aYf5Q==", + "dev": true, + "requires": { + "braces": "^3.0.1", + "picomatch": "^2.0.5" + } + }, + "source-map": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", + "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "dev": true + }, + "supports-color": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.1.0.tgz", + "integrity": "sha512-oRSIpR8pxT1Wr2FquTNnGet79b3BWljqOuoW/h4oBhxJ/HUbX5nX6JSruTkvXDCFMwDPvsaTTbvMLKZWSy0R5g==", + "dev": true, + "requires": { + "has-flag": "^4.0.0" + } + }, + "to-regex-range": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", + "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", + "dev": true, + "requires": { + "is-number": "^7.0.0" + } + }, + "write-file-atomic": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/write-file-atomic/-/write-file-atomic-3.0.1.tgz", + "integrity": "sha512-JPStrIyyVJ6oCSz/691fAjFtefZ6q+fP6tm+OS4Qw6o+TGQxNp1ziY2PgS+X/m0V8OWhZiO/m4xSj+Pr4RrZvw==", + "dev": true, + "requires": { + "imurmurhash": "^0.1.4", + "is-typedarray": "^1.0.0", + "signal-exit": "^3.0.2", + "typedarray-to-buffer": "^3.1.5" + } + } } }, - "@octokit/endpoint": { - "version": "5.5.1", - "resolved": "https://registry.npmjs.org/@octokit/endpoint/-/endpoint-5.5.1.tgz", - "integrity": "sha512-nBFhRUb5YzVTCX/iAK1MgQ4uWo89Gu0TH00qQHoYRCsE12dWcG1OiLd7v2EIo2+tpUKPMOQ62QFy9hy9Vg2ULg==", + "@jest/types": { + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/@jest/types/-/types-25.1.0.tgz", + "integrity": "sha512-VpOtt7tCrgvamWZh1reVsGADujKigBUFTi19mlRjqEGsE8qH4r3s+skY33dNdXOwyZIvuftZ5tqdF1IgsMejMA==", "dev": true, "requires": { - "@octokit/types": "^2.0.0", - "is-plain-object": "^3.0.0", - "universal-user-agent": "^4.0.0" - } - }, - "@octokit/graphql": { - "version": "4.3.1", - "resolved": "https://registry.npmjs.org/@octokit/graphql/-/graphql-4.3.1.tgz", + "@types/istanbul-lib-coverage": "^2.0.0", + "@types/istanbul-reports": "^1.1.1", + "@types/yargs": "^15.0.0", + "chalk": "^3.0.0" + }, + "dependencies": { + "ansi-styles": { + "version": "4.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.2.1.tgz", + "integrity": "sha512-9VGjrMsG1vePxcSweQsN20KY/c4zN0h9fLjqAbwbPfahM3t+NL+M9HC8xeXG2I8pX5NoamTGNuomEUFI7fcUjA==", + "dev": true, + "requires": { + "@types/color-name": "^1.1.1", + "color-convert": "^2.0.1" + } + }, + "chalk": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-3.0.0.tgz", + "integrity": "sha512-4D3B6Wf41KOYRFdszmDqMCGq5VV/uMAB273JILmO+3jAlh8X4qDtdtgCR3fxtbLEMzSx22QdhnDcJvu2u1fVwg==", + "dev": true, + "requires": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + } + }, + "color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "requires": { + "color-name": "~1.1.4" + } + }, + "color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + }, + "has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true + }, + "supports-color": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.1.0.tgz", + "integrity": "sha512-oRSIpR8pxT1Wr2FquTNnGet79b3BWljqOuoW/h4oBhxJ/HUbX5nX6JSruTkvXDCFMwDPvsaTTbvMLKZWSy0R5g==", + "dev": true, + "requires": { + "has-flag": "^4.0.0" + } + } + } + }, + "@nodelib/fs.scandir": { + "version": "2.1.3", + "resolved": "https://registry.npmjs.org/@nodelib/fs.scandir/-/fs.scandir-2.1.3.tgz", + "integrity": "sha512-eGmwYQn3gxo4r7jdQnkrrN6bY478C3P+a/y72IJukF8LjB6ZHeB3c+Ehacj3sYeSmUXGlnA67/PmbM9CVwL7Dw==", + "dev": true, + "requires": { + "@nodelib/fs.stat": "2.0.3", + "run-parallel": "^1.1.9" + } + }, + "@nodelib/fs.stat": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/@nodelib/fs.stat/-/fs.stat-2.0.3.tgz", + "integrity": "sha512-bQBFruR2TAwoevBEd/NWMoAAtNGzTRgdrqnYCc7dhzfoNvqPzLyqlEQnzZ3kVnNrSp25iyxE00/3h2fqGAGArA==", + "dev": true + }, + "@nodelib/fs.walk": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/@nodelib/fs.walk/-/fs.walk-1.2.4.tgz", + "integrity": "sha512-1V9XOY4rDW0rehzbrcqAmHnz8e7SKvX27gh8Gt2WgB0+pdzdiLV83p72kZPU+jvMbS1qU5mauP2iOvO8rhmurQ==", + "dev": true, + "requires": { + "@nodelib/fs.scandir": "2.1.3", + "fastq": "^1.6.0" + } + }, + "@octokit/auth-token": { + "version": "2.4.0", + "resolved": "https://registry.npmjs.org/@octokit/auth-token/-/auth-token-2.4.0.tgz", + "integrity": "sha512-eoOVMjILna7FVQf96iWc3+ZtE/ZT6y8ob8ZzcqKY1ibSQCnu4O/B7pJvzMx5cyZ/RjAff6DAdEb0O0Cjcxidkg==", + "dev": true, + "requires": { + "@octokit/types": "^2.0.0" + } + }, + "@octokit/core": { + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/@octokit/core/-/core-2.1.2.tgz", + "integrity": "sha512-cMKjowQkNOHN9d6SmZsdjbuHarBmmvl7OeFv+6VDp0hTObuEqO6N/lh8buOD6wwK04RcvJ9sq5bEvF47oWeJIQ==", + "dev": true, + "requires": { + "@octokit/auth-token": "^2.4.0", + "@octokit/graphql": "^4.3.1", + "@octokit/request": "^5.3.1", + "@octokit/types": "^2.0.0", + "before-after-hook": "^2.1.0", + "universal-user-agent": "^4.0.0" + } + }, + "@octokit/endpoint": { + "version": "5.5.1", + "resolved": "https://registry.npmjs.org/@octokit/endpoint/-/endpoint-5.5.1.tgz", + "integrity": "sha512-nBFhRUb5YzVTCX/iAK1MgQ4uWo89Gu0TH00qQHoYRCsE12dWcG1OiLd7v2EIo2+tpUKPMOQ62QFy9hy9Vg2ULg==", + "dev": true, + "requires": { + "@octokit/types": "^2.0.0", + "is-plain-object": "^3.0.0", + "universal-user-agent": "^4.0.0" + } + }, + "@octokit/graphql": { + "version": "4.3.1", + "resolved": "https://registry.npmjs.org/@octokit/graphql/-/graphql-4.3.1.tgz", "integrity": "sha512-hCdTjfvrK+ilU2keAdqNBWOk+gm1kai1ZcdjRfB30oA3/T6n53UVJb7w0L5cR3/rhU91xT3HSqCd+qbvH06yxA==", "dev": true, "requires": { @@ -1394,16 +2715,16 @@ } }, "@pika/plugin-build-node": { - "version": "0.7.1", - "resolved": "https://registry.npmjs.org/@pika/plugin-build-node/-/plugin-build-node-0.7.1.tgz", - "integrity": "sha512-fDwixkXex5StJ7quYWQ3kCHThjmcYFi1/gqay+D6YGbGCEnMmSNKZRWHagcoEUGnkRmRnrybxOMD+xKGzam/dg==", + "version": "0.8.1", + "resolved": "https://registry.npmjs.org/@pika/plugin-build-node/-/plugin-build-node-0.8.1.tgz", + "integrity": "sha512-PzdxyJJZZPUAtUjWgO3c4EuHZmAFz5Jvvr6RU8Fflr1qqvfnvNLNlE9yhXvot3l7xMQORp+7/Fw0ZW84XMpzZA==", "dev": true, "requires": { "@babel/core": "^7.0.0", "@babel/plugin-syntax-dynamic-import": "^7.2.0", "@babel/plugin-syntax-import-meta": "^7.2.0", "@babel/preset-env": "^7.2.3", - "@pika/types": "^0.7.1", + "@pika/types": "^0.8.1", "babel-plugin-dynamic-import-node-babel-7": "^2.0.7", "builtin-modules": "^3.0.0", "rollup": "^1.1.0", @@ -1411,28 +2732,28 @@ }, "dependencies": { "@pika/types": { - "version": "0.7.1", - "resolved": "https://registry.npmjs.org/@pika/types/-/types-0.7.1.tgz", - "integrity": "sha512-K4jnvnPAXbW1XqUQN4wsAt0H73gbgsRCESWF/Y2ceM1eBA13BS0fxc4ph2yRFXZfvwm+NrLojO14USqwF6gmeA==", + "version": "0.8.1", + "resolved": "https://registry.npmjs.org/@pika/types/-/types-0.8.1.tgz", + "integrity": "sha512-xQNGUA9CAHmbI6tO9weu088pX3PbrRgYZs68FXAqkJXodNyEy7Ju8LU191MZOS6MZreA1PElPd2evsgQ6Wl/cA==", "dev": true } } }, "@pika/plugin-build-web": { - "version": "0.7.1", - "resolved": "https://registry.npmjs.org/@pika/plugin-build-web/-/plugin-build-web-0.7.1.tgz", - "integrity": "sha512-jF7BzBqJjE2BDdSqrs6dV/Gn7JdtU6k2cXcuBMte/tY92nC30ZwvOnPSD7p3UR3kCgTvuF7CcTM/i4LOOW8r+Q==", + "version": "0.8.1", + "resolved": "https://registry.npmjs.org/@pika/plugin-build-web/-/plugin-build-web-0.8.1.tgz", + "integrity": "sha512-mRs3kquDb2DS8y7URvMefsZUlz+uhO0n4ykutGmZ+6EslvW1ZjGefOiaQ0qiDDFHF4ir4jg4od7Vo3TU32DGcg==", "dev": true, "requires": { - "@pika/types": "^0.7.1", + "@pika/types": "^0.8.1", "@types/node": "^10.12.18", "rollup": "^1.1.0" }, "dependencies": { "@pika/types": { - "version": "0.7.1", - "resolved": "https://registry.npmjs.org/@pika/types/-/types-0.7.1.tgz", - "integrity": "sha512-K4jnvnPAXbW1XqUQN4wsAt0H73gbgsRCESWF/Y2ceM1eBA13BS0fxc4ph2yRFXZfvwm+NrLojO14USqwF6gmeA==", + "version": "0.8.1", + "resolved": "https://registry.npmjs.org/@pika/types/-/types-0.8.1.tgz", + "integrity": "sha512-xQNGUA9CAHmbI6tO9weu088pX3PbrRgYZs68FXAqkJXodNyEy7Ju8LU191MZOS6MZreA1PElPd2evsgQ6Wl/cA==", "dev": true }, "@types/node": { @@ -1444,20 +2765,20 @@ } }, "@pika/plugin-ts-standard-pkg": { - "version": "0.7.1", - "resolved": "https://registry.npmjs.org/@pika/plugin-ts-standard-pkg/-/plugin-ts-standard-pkg-0.7.1.tgz", - "integrity": "sha512-xIeY1xw89/s0WQ3oskdXcuaCOQt1ECQ+IwYtv1cgVwJeWQXChTTXYO46Eoi3lTYQ2AZQ6bQN+VtrHy5Rd/YxbQ==", + "version": "0.8.1", + "resolved": "https://registry.npmjs.org/@pika/plugin-ts-standard-pkg/-/plugin-ts-standard-pkg-0.8.1.tgz", + "integrity": "sha512-5uTdQECX4hlxDEx1O8po9oReGfgfYxNRnZixaeVkiSlTMMRXvoiumI2T28YKRc6V0qGecaHe96hcbkoSp6Tbbg==", "dev": true, "requires": { - "@pika/types": "^0.7.1", + "@pika/types": "^0.8.1", "execa": "^2.0.0", "standard-pkg": "^0.5.0" }, "dependencies": { "@pika/types": { - "version": "0.7.1", - "resolved": "https://registry.npmjs.org/@pika/types/-/types-0.7.1.tgz", - "integrity": "sha512-K4jnvnPAXbW1XqUQN4wsAt0H73gbgsRCESWF/Y2ceM1eBA13BS0fxc4ph2yRFXZfvwm+NrLojO14USqwF6gmeA==", + "version": "0.8.1", + "resolved": "https://registry.npmjs.org/@pika/types/-/types-0.8.1.tgz", + "integrity": "sha512-xQNGUA9CAHmbI6tO9weu088pX3PbrRgYZs68FXAqkJXodNyEy7Ju8LU191MZOS6MZreA1PElPd2evsgQ6Wl/cA==", "dev": true }, "cross-spawn": { @@ -1519,9 +2840,9 @@ "dev": true }, "path-key": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.0.tgz", - "integrity": "sha512-8cChqz0RP6SHJkMt48FW0A7+qUOn+OsnOsVtzI59tZ8m+5bCSk7hzwET0pulwOM2YMn9J1efb07KB9l9f30SGg==", + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", + "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", "dev": true }, "shebang-command": { @@ -1540,9 +2861,9 @@ "dev": true }, "which": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/which/-/which-2.0.1.tgz", - "integrity": "sha512-N7GBZOTswtB9lkQBZA4+zAXrjEIWAUOB93AvzUiudRzRxhUdLURQ7D/gAIMY1gatT/LTbmbcv8SiYazy3eYB7w==", + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", + "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", "dev": true, "requires": { "isexe": "^2.0.0" @@ -1922,6 +3243,15 @@ "integrity": "sha512-9NET910DNaIPngYnLLPeg+Ogzqsi9uM4mSboU5y6p8S5DzMTVEsJZrawi+BoDNUVBa2DhJqQYUFvMDfgU062LQ==", "dev": true }, + "@sinonjs/commons": { + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/@sinonjs/commons/-/commons-1.7.0.tgz", + "integrity": "sha512-qbk9AP+cZUsKdW1GJsBpxPKFmCJ0T8swwzVje3qFd+AkQb74Q/tiuzrdfFg8AD2g5HH/XbE/I8Uc1KYHVYWfhg==", + "dev": true, + "requires": { + "type-detect": "4.0.8" + } + }, "@szmarczak/http-timer": { "version": "1.1.2", "resolved": "https://registry.npmjs.org/@szmarczak/http-timer/-/http-timer-1.1.2.tgz", @@ -1945,9 +3275,9 @@ } }, "@types/babel__generator": { - "version": "7.6.0", - "resolved": "https://registry.npmjs.org/@types/babel__generator/-/babel__generator-7.6.0.tgz", - "integrity": "sha512-c1mZUu4up5cp9KROs/QAw0gTeHrw/x7m52LcnvMxxOZ03DmLwPV0MlGmlgzV3cnSdjhJOZsj7E7FHeioai+egw==", + "version": "7.6.1", + "resolved": "https://registry.npmjs.org/@types/babel__generator/-/babel__generator-7.6.1.tgz", + "integrity": "sha512-bBKm+2VPJcMRVwNhxKu8W+5/zT7pwNEqeokFOmbvVSqGzFneNxYcEBro9Ac7/N9tlsaPYnZLK8J1LWKkMsLAew==", "dev": true, "requires": { "@babel/types": "^7.0.0" @@ -1964,9 +3294,9 @@ } }, "@types/babel__traverse": { - "version": "7.0.7", - "resolved": "https://registry.npmjs.org/@types/babel__traverse/-/babel__traverse-7.0.7.tgz", - "integrity": "sha512-CeBpmX1J8kWLcDEnI3Cl2Eo6RfbGvzUctA+CjZUhOKDFbLfcr7fc4usEqLNWetrlJd7RhAkyYe2czXop4fICpw==", + "version": "7.0.8", + "resolved": "https://registry.npmjs.org/@types/babel__traverse/-/babel__traverse-7.0.8.tgz", + "integrity": "sha512-yGeB2dHEdvxjP0y4UbRtQaSkXJ9649fYCmIdRoul5kfAoGCwxuCbMhag0k3RPfnuh9kPGm8x89btcfDEXdVWGw==", "dev": true, "requires": { "@babel/types": "^7.3.0" @@ -2204,9 +3534,9 @@ "dev": true }, "@types/yargs": { - "version": "13.0.3", - "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-13.0.3.tgz", - "integrity": "sha512-K8/LfZq2duW33XW/tFwEAfnZlqIfVsoyRB3kfXdPXYhl0nfM8mmh7GS0jg7WrX2Dgq/0Ha/pR1PaR+BvmWwjiQ==", + "version": "15.0.2", + "resolved": "https://registry.npmjs.org/@types/yargs/-/yargs-15.0.2.tgz", + "integrity": "sha512-hFkuAp58M2xOc1QgJhkFrLMnqa8KWTFRTnzrI1zlEcOfg3DZ0eH3aPAo/N6QlVVu8E4KS4xD1jtEG3rdQYFmIg==", "dev": true, "requires": { "@types/yargs-parser": "*" @@ -2229,9 +3559,9 @@ } }, "abab": { - "version": "2.0.2", - "resolved": "https://registry.npmjs.org/abab/-/abab-2.0.2.tgz", - "integrity": "sha512-2scffjvioEmNz0OyDSLGWDfKCVwaKc6l9Pm9kOIREU13ClXZvHpg/nRL5xyjSSSLhOnXqft2HpsAzNEEA8cFFg==", + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/abab/-/abab-2.0.3.tgz", + "integrity": "sha512-tsFzPpcttalNjFBCFMqsKYQcWxxen1pgJR56by//QwvJc4/OUS3kPOOttx2tSIfjsylB0pYu7f5D3K1RCxUnUg==", "dev": true }, "acorn": { @@ -2251,9 +3581,9 @@ }, "dependencies": { "acorn": { - "version": "6.3.0", - "resolved": "https://registry.npmjs.org/acorn/-/acorn-6.3.0.tgz", - "integrity": "sha512-/czfa8BwS88b9gWQVhc8eknunSA2DoJpJyTQkhheIf5E48u1N0R4q/YxxsAeqRrmK9TQ/uYfgLDfZo91UlANIA==", + "version": "6.4.0", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-6.4.0.tgz", + "integrity": "sha512-gac8OEcQ2Li1dxIEWGZzsp2BitJxwkwcOm0zHAJLcPJaVvm58FRnk6RkuLRpU1EujipU2ZFODv2P9DLMfnV8mw==", "dev": true } } @@ -2292,12 +3622,12 @@ } }, "ajv": { - "version": "6.10.2", - "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.10.2.tgz", - "integrity": "sha512-TXtUUEYHuaTEbLZWIKUr5pmBuhDLy+8KYtPYdcV8qC+pOZL+NKqYwvWSRrVXHn+ZmRRAu8vJTAznH7Oag6RVRw==", + "version": "6.11.0", + "resolved": "https://registry.npmjs.org/ajv/-/ajv-6.11.0.tgz", + "integrity": "sha512-nCprB/0syFYy9fVYU1ox1l2KN8S9I+tziH8D4zdZuLT3N6RMlGSGt5FSTpAiHB/Whv8Qs1cWHma1aMKZyaHRKA==", "dev": true, "requires": { - "fast-deep-equal": "^2.0.1", + "fast-deep-equal": "^3.1.1", "fast-json-stable-stringify": "^2.0.0", "json-schema-traverse": "^0.4.1", "uri-js": "^4.2.2" @@ -2374,13 +3704,13 @@ "dev": true }, "anymatch": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/anymatch/-/anymatch-2.0.0.tgz", - "integrity": "sha512-5teOsQWABXHHBFP9y3skS5P3d/WfWXpv3FUpy+LorMrNYaT9pI4oLMQX7jzQ2KklNpGpWHzdCXTDT2Y3XGlZBw==", + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/anymatch/-/anymatch-3.1.1.tgz", + "integrity": "sha512-mM8522psRCqzV+6LhomX5wgp25YVibjh8Wj23I5RPkPppSVSjyKD2A2mBJmWGa+KN7f2D6LNh9jkBCeyLktzjg==", "dev": true, "requires": { - "micromatch": "^3.1.4", - "normalize-path": "^2.1.1" + "normalize-path": "^3.0.0", + "picomatch": "^2.0.4" } }, "argparse": { @@ -2494,12 +3824,6 @@ "integrity": "sha512-NW2cX8m1Q7KPA7a5M2ULQeZ2wR5qI5PAbw5L0UOMxdioVk9PMZ0h1TmyZEkPYrCvYjDlFICusOu1dlEKAAeXBw==", "dev": true }, - "async-limiter": { - "version": "1.0.1", - "resolved": "https://registry.npmjs.org/async-limiter/-/async-limiter-1.0.1.tgz", - "integrity": "sha512-csOlWGAcRFJaI6m+F2WKdnMKr4HhdhFVBk0H/QbJFMCr+uO2kwohwXQPxw/9OCxp05r5ghVBFSyioixx3gfkNQ==", - "dev": true - }, "asynckit": { "version": "0.4.0", "resolved": "https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz", @@ -2525,24 +3849,76 @@ "dev": true }, "aws4": { - "version": "1.8.0", - "resolved": "https://registry.npmjs.org/aws4/-/aws4-1.8.0.tgz", - "integrity": "sha512-ReZxvNHIOv88FlT7rxcXIIC0fPt4KZqZbOlivyWtXLt8ESx84zd3kMC6iK5jVeS2qt+g7ftS7ye4fi06X5rtRQ==", + "version": "1.9.1", + "resolved": "https://registry.npmjs.org/aws4/-/aws4-1.9.1.tgz", + "integrity": "sha512-wMHVg2EOHaMRxbzgFJ9gtjOOCrI80OHLG14rxi28XwOW8ux6IiEbRCGGGqCtdAIg4FQCbW20k9RsT4y3gJlFug==", "dev": true }, "babel-jest": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/babel-jest/-/babel-jest-24.9.0.tgz", - "integrity": "sha512-ntuddfyiN+EhMw58PTNL1ph4C9rECiQXjI4nMMBKBaNjXvqLdkXpPRcMSr4iyBrJg/+wz9brFUD6RhOAT6r4Iw==", + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/babel-jest/-/babel-jest-25.1.0.tgz", + "integrity": "sha512-tz0VxUhhOE2y+g8R2oFrO/2VtVjA1lkJeavlhExuRBg3LdNJY9gwQ+Vcvqt9+cqy71MCTJhewvTB7Qtnnr9SWg==", "dev": true, "requires": { - "@jest/transform": "^24.9.0", - "@jest/types": "^24.9.0", + "@jest/transform": "^25.1.0", + "@jest/types": "^25.1.0", "@types/babel__core": "^7.1.0", - "babel-plugin-istanbul": "^5.1.0", - "babel-preset-jest": "^24.9.0", - "chalk": "^2.4.2", - "slash": "^2.0.0" + "babel-plugin-istanbul": "^6.0.0", + "babel-preset-jest": "^25.1.0", + "chalk": "^3.0.0", + "slash": "^3.0.0" + }, + "dependencies": { + "ansi-styles": { + "version": "4.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.2.1.tgz", + "integrity": "sha512-9VGjrMsG1vePxcSweQsN20KY/c4zN0h9fLjqAbwbPfahM3t+NL+M9HC8xeXG2I8pX5NoamTGNuomEUFI7fcUjA==", + "dev": true, + "requires": { + "@types/color-name": "^1.1.1", + "color-convert": "^2.0.1" + } + }, + "chalk": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-3.0.0.tgz", + "integrity": "sha512-4D3B6Wf41KOYRFdszmDqMCGq5VV/uMAB273JILmO+3jAlh8X4qDtdtgCR3fxtbLEMzSx22QdhnDcJvu2u1fVwg==", + "dev": true, + "requires": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + } + }, + "color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "requires": { + "color-name": "~1.1.4" + } + }, + "color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + }, + "has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true + }, + "supports-color": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.1.0.tgz", + "integrity": "sha512-oRSIpR8pxT1Wr2FquTNnGet79b3BWljqOuoW/h4oBhxJ/HUbX5nX6JSruTkvXDCFMwDPvsaTTbvMLKZWSy0R5g==", + "dev": true, + "requires": { + "has-flag": "^4.0.0" + } + } } }, "babel-plugin-dynamic-import-node": { @@ -2564,79 +3940,36 @@ } }, "babel-plugin-istanbul": { - "version": "5.2.0", - "resolved": "https://registry.npmjs.org/babel-plugin-istanbul/-/babel-plugin-istanbul-5.2.0.tgz", - "integrity": "sha512-5LphC0USA8t4i1zCtjbbNb6jJj/9+X6P37Qfirc/70EQ34xKlMW+a1RHGwxGI+SwWpNwZ27HqvzAobeqaXwiZw==", + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/babel-plugin-istanbul/-/babel-plugin-istanbul-6.0.0.tgz", + "integrity": "sha512-AF55rZXpe7trmEylbaE1Gv54wn6rwU03aptvRoVIGP8YykoSxqdVLV1TfwflBCE/QtHmqtP8SWlTENqbK8GCSQ==", "dev": true, "requires": { "@babel/helper-plugin-utils": "^7.0.0", - "find-up": "^3.0.0", - "istanbul-lib-instrument": "^3.3.0", - "test-exclude": "^5.2.3" - }, - "dependencies": { - "find-up": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/find-up/-/find-up-3.0.0.tgz", - "integrity": "sha512-1yD6RmLI1XBfxugvORwlck6f75tYL+iR0jqwsOrOxMZyGYqUuDhJ0l4AXdO1iX/FTs9cBAMEk1gWSEx1kSbylg==", - "dev": true, - "requires": { - "locate-path": "^3.0.0" - } - }, - "locate-path": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-3.0.0.tgz", - "integrity": "sha512-7AO748wWnIhNqAuaty2ZWHkQHRSNfPVIsPIfwEOWO22AmaoVrWavlOcMR5nzTLNYvp36X220/maaRsrec1G65A==", - "dev": true, - "requires": { - "p-locate": "^3.0.0", - "path-exists": "^3.0.0" - } - }, - "p-limit": { - "version": "2.2.1", - "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.2.1.tgz", - "integrity": "sha512-85Tk+90UCVWvbDavCLKPOLC9vvY8OwEX/RtKF+/1OADJMVlFfEHOiMTPVyxg7mk/dKa+ipdHm0OUkTvCpMTuwg==", - "dev": true, - "requires": { - "p-try": "^2.0.0" - } - }, - "p-locate": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-3.0.0.tgz", - "integrity": "sha512-x+12w/To+4GFfgJhBEpiDcLozRJGegY+Ei7/z0tSLkMmxGZNybVMSfWj9aJn8Z5Fc7dBUNJOOVgPv2H7IwulSQ==", - "dev": true, - "requires": { - "p-limit": "^2.0.0" - } - }, - "p-try": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", - "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==", - "dev": true - } + "@istanbuljs/load-nyc-config": "^1.0.0", + "@istanbuljs/schema": "^0.1.2", + "istanbul-lib-instrument": "^4.0.0", + "test-exclude": "^6.0.0" } }, "babel-plugin-jest-hoist": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/babel-plugin-jest-hoist/-/babel-plugin-jest-hoist-24.9.0.tgz", - "integrity": "sha512-2EMA2P8Vp7lG0RAzr4HXqtYwacfMErOuv1U3wrvxHX6rD1sV6xS3WXG3r8TRQ2r6w8OhvSdWt+z41hQNwNm3Xw==", + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/babel-plugin-jest-hoist/-/babel-plugin-jest-hoist-25.1.0.tgz", + "integrity": "sha512-oIsopO41vW4YFZ9yNYoLQATnnN46lp+MZ6H4VvPKFkcc2/fkl3CfE/NZZSmnEIEsJRmJAgkVEK0R7Zbl50CpTw==", "dev": true, "requires": { "@types/babel__traverse": "^7.0.6" } }, "babel-preset-jest": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/babel-preset-jest/-/babel-preset-jest-24.9.0.tgz", - "integrity": "sha512-izTUuhE4TMfTRPF92fFwD2QfdXaZW08qvWTFCI51V8rW5x00UuPgc3ajRoWofXOuxjfcOM5zzSYsQS3H8KGCAg==", + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/babel-preset-jest/-/babel-preset-jest-25.1.0.tgz", + "integrity": "sha512-eCGn64olaqwUMaugXsTtGAM2I0QTahjEtnRu0ql8Ie+gDWAc1N6wqN0k2NilnyTunM69Pad7gJY7LOtwLimoFQ==", "dev": true, "requires": { + "@babel/plugin-syntax-bigint": "^7.0.0", "@babel/plugin-syntax-object-rest-spread": "^7.0.0", - "babel-plugin-jest-hoist": "^24.9.0" + "babel-plugin-jest-hoist": "^25.1.0" } }, "babel-runtime": { @@ -2867,14 +4200,14 @@ } }, "browserslist": { - "version": "4.7.2", - "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.7.2.tgz", - "integrity": "sha512-uZavT/gZXJd2UTi9Ov7/Z340WOSQ3+m1iBVRUknf+okKxonL9P83S3ctiBDtuRmRu8PiCHjqyueqQ9HYlJhxiw==", + "version": "4.7.3", + "resolved": "https://registry.npmjs.org/browserslist/-/browserslist-4.7.3.tgz", + "integrity": "sha512-jWvmhqYpx+9EZm/FxcZSbUZyDEvDTLDi3nSAKbzEkyWvtI0mNSmUosey+5awDW1RUlrgXbQb5A6qY1xQH9U6MQ==", "dev": true, "requires": { - "caniuse-lite": "^1.0.30001004", - "electron-to-chromium": "^1.3.295", - "node-releases": "^1.1.38" + "caniuse-lite": "^1.0.30001010", + "electron-to-chromium": "^1.3.306", + "node-releases": "^1.1.40" } }, "bs-logger": { @@ -3026,9 +4359,9 @@ } }, "caniuse-lite": { - "version": "1.0.30001008", - "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001008.tgz", - "integrity": "sha512-b8DJyb+VVXZGRgJUa30cbk8gKHZ3LOZTBLaUEEVr2P4xpmFigOCc62CO4uzquW641Ouq1Rm9N+rWLWdSYDaDIw==", + "version": "1.0.30001012", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001012.tgz", + "integrity": "sha512-7RR4Uh04t9K1uYRWzOJmzplgEOAXbfK72oVNokCdMzA67trrhPzy93ahKk1AWHiA0c58tD2P+NHqxrA8FZ+Trg==", "dev": true }, "capture-exit": { @@ -3192,48 +4525,76 @@ "dev": true }, "cliui": { - "version": "5.0.0", - "resolved": "https://registry.npmjs.org/cliui/-/cliui-5.0.0.tgz", - "integrity": "sha512-PYeGSEmmHM6zvoef2w8TPzlrnNpXIjTipYK780YswmIP9vjxmd6Y2a3CB2Ks6/AU8NHjZugXvo8w3oWM2qnwXA==", + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/cliui/-/cliui-6.0.0.tgz", + "integrity": "sha512-t6wbgtoCXvAzst7QgXxJYqPt0usEfbgQdftEPbLL/cvv6HPE5VgvqCuAIDR0NgU52ds6rFwqrgakNLrHEjCbrQ==", "dev": true, "requires": { - "string-width": "^3.1.0", - "strip-ansi": "^5.2.0", - "wrap-ansi": "^5.1.0" + "string-width": "^4.2.0", + "strip-ansi": "^6.0.0", + "wrap-ansi": "^6.2.0" }, "dependencies": { - "emoji-regex": { - "version": "7.0.3", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-7.0.3.tgz", - "integrity": "sha512-CwBLREIQ7LvYFB0WyRvwhq5N5qPhc6PMjD6bYggFlI5YyDgl+0vxq5VHbMOFqLg7hfWzmu8T5Z1QofhmTIhItA==", + "ansi-regex": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.0.tgz", + "integrity": "sha512-bY6fj56OUQ0hU1KjFNDQuJFezqKdrAyFdIevADiqrWHwSlbmBNMHp5ak2f40Pm8JTFyM2mqxkG6ngkHO11f/lg==", "dev": true }, - "is-fullwidth-code-point": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-2.0.0.tgz", - "integrity": "sha1-o7MKXE8ZkYMWeqq5O+764937ZU8=", + "ansi-styles": { + "version": "4.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.2.1.tgz", + "integrity": "sha512-9VGjrMsG1vePxcSweQsN20KY/c4zN0h9fLjqAbwbPfahM3t+NL+M9HC8xeXG2I8pX5NoamTGNuomEUFI7fcUjA==", + "dev": true, + "requires": { + "@types/color-name": "^1.1.1", + "color-convert": "^2.0.1" + } + }, + "color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "requires": { + "color-name": "~1.1.4" + } + }, + "color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", "dev": true }, "string-width": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-3.1.0.tgz", - "integrity": "sha512-vafcv6KjVZKSgz06oM/H6GDBrAtz8vdhQakGjFIvNrHA6y3HCF1CInLy+QLq8dTJPQ1b+KDUqDFctkdRW44e1w==", + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.0.tgz", + "integrity": "sha512-zUz5JD+tgqtuDjMhwIg5uFVV3dtqZ9yQJlZVfq4I01/K5Paj5UHj7VyrQOJvzawSVlKpObApbfD0Ed6yJc+1eg==", "dev": true, "requires": { - "emoji-regex": "^7.0.1", - "is-fullwidth-code-point": "^2.0.0", - "strip-ansi": "^5.1.0" + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.0" + } + }, + "strip-ansi": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.0.tgz", + "integrity": "sha512-AuvKTrTfQNYNIctbR1K/YGTR1756GycPsg7b9bdV9Duqur4gv6aKqHXah67Z8ImS7WEz5QVcOtlfW2rZEugt6w==", + "dev": true, + "requires": { + "ansi-regex": "^5.0.0" } }, "wrap-ansi": { - "version": "5.1.0", - "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-5.1.0.tgz", - "integrity": "sha512-QC1/iN/2/RPVJ5jYK8BGttj5z83LmSKmvbvrXPNCLZSEb32KKVDJDl/MOt2N01qU2H/FkzEa9PKto1BqDjtd7Q==", + "version": "6.2.0", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-6.2.0.tgz", + "integrity": "sha512-r6lPcBGxZXlIcymEu7InxDMhdW0KDxpLgoFLcguasxCaJ/SOIZwINatK9KY/tf+ZrlywOKU0UDj3ATXUBfxJXA==", "dev": true, "requires": { - "ansi-styles": "^3.2.0", - "string-width": "^3.0.0", - "strip-ansi": "^5.0.0" + "ansi-styles": "^4.0.0", + "string-width": "^4.1.0", + "strip-ansi": "^6.0.0" } } } @@ -3259,6 +4620,12 @@ "integrity": "sha1-DQcLTQQ6W+ozovGkDi7bPZpMz3c=", "dev": true }, + "collect-v8-coverage": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/collect-v8-coverage/-/collect-v8-coverage-1.0.0.tgz", + "integrity": "sha512-VKIhJgvk8E1W28m5avZ2Gv2Ruv5YiF56ug2oclvaG9md69BuZImMG2sk9g7QNKLUbtYAKQjXjYxbYZVUlMMKmQ==", + "dev": true + }, "collection-visit": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/collection-visit/-/collection-visit-1.0.0.tgz", @@ -3443,12 +4810,12 @@ "dev": true }, "core-js-compat": { - "version": "3.4.0", - "resolved": "https://registry.npmjs.org/core-js-compat/-/core-js-compat-3.4.0.tgz", - "integrity": "sha512-pgQUcgT2+v9/yxHgMynYjNj7nmxLRXv3UC39rjCjDwpe63ev2rioQTju1PKLYUBbPCQQvZNWvQC8tBJd65q11g==", + "version": "3.4.2", + "resolved": "https://registry.npmjs.org/core-js-compat/-/core-js-compat-3.4.2.tgz", + "integrity": "sha512-W0Aj+LM3EAxxjD0Kp2o4be8UlnxIZHNupBv2znqrheR4aY2nOn91794k/xoSp+SxqqriiZpTsSwBtZr60cbkwQ==", "dev": true, "requires": { - "browserslist": "^4.7.2", + "browserslist": "^4.7.3", "semver": "^6.3.0" }, "dependencies": { @@ -3498,18 +4865,26 @@ "dev": true }, "cssom": { - "version": "0.3.8", - "resolved": "https://registry.npmjs.org/cssom/-/cssom-0.3.8.tgz", - "integrity": "sha512-b0tGHbfegbhPJpxpiBPU2sCkigAqtM9O121le6bbOlgyV+NyGyCmVfJ6QW9eRjz8CpNfWEOYBIMIGRYkLwsIYg==", + "version": "0.4.4", + "resolved": "https://registry.npmjs.org/cssom/-/cssom-0.4.4.tgz", + "integrity": "sha512-p3pvU7r1MyyqbTk+WbNJIgJjG2VmTIaB10rI93LzVPrmDJKkzKYMtxxyAvQXR/NS6otuzveI7+7BBq3SjBS2mw==", "dev": true }, "cssstyle": { - "version": "1.4.0", - "resolved": "https://registry.npmjs.org/cssstyle/-/cssstyle-1.4.0.tgz", - "integrity": "sha512-GBrLZYZ4X4x6/QEoBnIrqb8B/f5l4+8me2dkom/j1Gtbxy0kBv6OGzKuAsGM75bkGwGAFkt56Iwg28S3XTZgSA==", + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/cssstyle/-/cssstyle-2.2.0.tgz", + "integrity": "sha512-sEb3XFPx3jNnCAMtqrXPDeSgQr+jojtCeNf8cvMNMh1cG970+lljssvQDzPq6lmmJu2Vhqood/gtEomBiHOGnA==", "dev": true, "requires": { - "cssom": "0.3.x" + "cssom": "~0.3.6" + }, + "dependencies": { + "cssom": { + "version": "0.3.8", + "resolved": "https://registry.npmjs.org/cssom/-/cssom-0.3.8.tgz", + "integrity": "sha512-b0tGHbfegbhPJpxpiBPU2sCkigAqtM9O121le6bbOlgyV+NyGyCmVfJ6QW9eRjz8CpNfWEOYBIMIGRYkLwsIYg==", + "dev": true + } } }, "currently-unhandled": { @@ -3721,15 +5096,15 @@ "dev": true }, "detect-newline": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/detect-newline/-/detect-newline-2.1.0.tgz", - "integrity": "sha1-9B8cEL5LAOh7XxPaaAdZ8sW/0+I=", + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/detect-newline/-/detect-newline-3.1.0.tgz", + "integrity": "sha512-TLz+x/vEXm/Y7P7wn1EJFNLxYpUD4TgMosxY6fAVJUnJMbupHBOncxyWUG9OpTaH9EBD7uFI5LfEgmMOc54DsA==", "dev": true }, "diff-sequences": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/diff-sequences/-/diff-sequences-24.9.0.tgz", - "integrity": "sha512-Dj6Wk3tWyTE+Fo1rW8v0Xhwk80um6yFYKbuAxc9c3EZxIHFDYwbi34Uk42u1CdnIiVorvt4RmlSDjIPyzGC2ew==", + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/diff-sequences/-/diff-sequences-25.1.0.tgz", + "integrity": "sha512-nFIfVk5B/NStCsJ+zaPO4vYuLjlzQ6uFvPxzYyHlejNZ/UGa7G/n7peOXVrVNvRuyfstt+mZQYGpjxg9Z6N8Kw==", "dev": true }, "dir-glob": { @@ -3793,9 +5168,9 @@ } }, "electron-to-chromium": { - "version": "1.3.306", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.3.306.tgz", - "integrity": "sha512-frDqXvrIROoYvikSKTIKbHbzO6M3/qC6kCIt/1FOa9kALe++c4VAJnwjSFvf1tYLEUsP2n9XZ4XSCyqc3l7A/A==", + "version": "1.3.314", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.3.314.tgz", + "integrity": "sha512-IKDR/xCxKFhPts7h+VaSXS02Z1mznP3fli1BbXWXeN89i2gCzKraU8qLpEid8YzKcmZdZD3Mly3cn5/lY9xsBQ==", "dev": true }, "elegant-spinner": { @@ -3958,24 +5333,18 @@ "dev": true }, "escodegen": { - "version": "1.12.0", - "resolved": "https://registry.npmjs.org/escodegen/-/escodegen-1.12.0.tgz", - "integrity": "sha512-TuA+EhsanGcme5T3R0L80u4t8CpbXQjegRmf7+FPTJrtCTErXFeelblRgHQa1FofEzqYYJmJ/OqjTwREp9qgmg==", + "version": "1.13.0", + "resolved": "https://registry.npmjs.org/escodegen/-/escodegen-1.13.0.tgz", + "integrity": "sha512-eYk2dCkxR07DsHA/X2hRBj0CFAZeri/LyDMc0C8JT1Hqi6JnVpMhJ7XFITbb0+yZS3lVkaPL2oCkZ3AVmeVbMw==", "dev": true, "requires": { - "esprima": "^3.1.3", + "esprima": "^4.0.1", "estraverse": "^4.2.0", "esutils": "^2.0.2", "optionator": "^0.8.1", "source-map": "~0.6.1" }, "dependencies": { - "esprima": { - "version": "3.1.3", - "resolved": "https://registry.npmjs.org/esprima/-/esprima-3.1.3.tgz", - "integrity": "sha1-/cpRzuYTOJXjyI1TXOSdv/YqRjM=", - "dev": true - }, "source-map": { "version": "0.6.1", "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", @@ -4087,17 +5456,44 @@ } }, "expect": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/expect/-/expect-24.9.0.tgz", - "integrity": "sha512-wvVAx8XIol3Z5m9zvZXiyZOQ+sRJqNTIm6sGjdWlaZIeupQGO3WbYI+15D/AmEwZywL6wtJkbAbJtzkOfBuR0Q==", + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/expect/-/expect-25.1.0.tgz", + "integrity": "sha512-wqHzuoapQkhc3OKPlrpetsfueuEiMf3iWh0R8+duCu9PIjXoP7HgD5aeypwTnXUAjC8aMsiVDaWwlbJ1RlQ38g==", "dev": true, "requires": { - "@jest/types": "^24.9.0", - "ansi-styles": "^3.2.0", - "jest-get-type": "^24.9.0", - "jest-matcher-utils": "^24.9.0", - "jest-message-util": "^24.9.0", - "jest-regex-util": "^24.9.0" + "@jest/types": "^25.1.0", + "ansi-styles": "^4.0.0", + "jest-get-type": "^25.1.0", + "jest-matcher-utils": "^25.1.0", + "jest-message-util": "^25.1.0", + "jest-regex-util": "^25.1.0" + }, + "dependencies": { + "ansi-styles": { + "version": "4.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.2.1.tgz", + "integrity": "sha512-9VGjrMsG1vePxcSweQsN20KY/c4zN0h9fLjqAbwbPfahM3t+NL+M9HC8xeXG2I8pX5NoamTGNuomEUFI7fcUjA==", + "dev": true, + "requires": { + "@types/color-name": "^1.1.1", + "color-convert": "^2.0.1" + } + }, + "color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "requires": { + "color-name": "~1.1.4" + } + }, + "color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + } } }, "extend": { @@ -4225,9 +5621,9 @@ "dev": true }, "fast-deep-equal": { - "version": "2.0.1", - "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-2.0.1.tgz", - "integrity": "sha1-ewUhjd+WZ79/Nwv3/bLLFf3Qqkk=", + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/fast-deep-equal/-/fast-deep-equal-3.1.1.tgz", + "integrity": "sha512-8UEa58QDLauDNfpbrX55Q9jrGHThw2ZMdOky5Gl1CDtVeJDPVrG4Jxx1N8jw2gkWaff5UUuX1KJd+9zGe2B+ZA==", "dev": true }, "fast-glob": { @@ -4310,12 +5706,12 @@ } }, "fb-watchman": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/fb-watchman/-/fb-watchman-2.0.0.tgz", - "integrity": "sha1-VOmr99+i8mzZsWNsWIwa/AXeXVg=", + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/fb-watchman/-/fb-watchman-2.0.1.tgz", + "integrity": "sha512-DkPJKQeY6kKwmuMretBhr7G6Vodr7bFwDYTXIkfG1gjvNpaxBTQV3PbXg6bR1c1UP4jPOX0jHUbbHANL9vRjVg==", "dev": true, "requires": { - "bser": "^2.0.0" + "bser": "2.1.1" } }, "fetch-mock": { @@ -4449,620 +5845,85 @@ "dev": true }, "fsevents": { - "version": "1.2.9", - "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-1.2.9.tgz", - "integrity": "sha512-oeyj2H3EjjonWcFjD5NvZNE9Rqe4UW+nQBU2HNeKw0koVLEFIhtyETyAakeAM3de7Z/SW5kcA+fZUait9EApnw==", + "version": "2.1.2", + "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.1.2.tgz", + "integrity": "sha512-R4wDiBwZ0KzpgOWetKDug1FZcYhqYnUYKtfZYt4mD5SBz76q0KR4Q9o7GIPamsVPGmW3EYPPJ0dOOjvx32ldZA==", + "dev": true, + "optional": true + }, + "function-bind": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.1.tgz", + "integrity": "sha512-yIovAzMX49sF8Yl58fSCWJ5svSLuaibPxXQJFLmBObTuCr0Mf1KiPopGM9NiFjiYBCbfaa2Fh6breQ6ANVTI0A==", + "dev": true + }, + "gensync": { + "version": "1.0.0-beta.1", + "resolved": "https://registry.npmjs.org/gensync/-/gensync-1.0.0-beta.1.tgz", + "integrity": "sha512-r8EC6NO1sngH/zdD9fiRDLdcgnbayXah+mLgManTaIZJqEC1MZstmnox8KpnI2/fxQwrp5OpCOYWLp4rBl4Jcg==", + "dev": true + }, + "get-caller-file": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-2.0.5.tgz", + "integrity": "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==", + "dev": true + }, + "get-stream": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-4.1.0.tgz", + "integrity": "sha512-GMat4EJ5161kIy2HevLlr4luNjBgvmj413KaQA7jt4V8B4RDsfpHk7WQ9GVqfYyyx8OS/L66Kox+rJRNklLK7w==", + "dev": true, + "requires": { + "pump": "^3.0.0" + } + }, + "get-value": { + "version": "2.0.6", + "resolved": "https://registry.npmjs.org/get-value/-/get-value-2.0.6.tgz", + "integrity": "sha1-3BXKHGcjh8p2vTesCjlbogQqLCg=", + "dev": true + }, + "getpass": { + "version": "0.1.7", + "resolved": "https://registry.npmjs.org/getpass/-/getpass-0.1.7.tgz", + "integrity": "sha1-Xv+OPmhNVprkyysSgmBOi6YhSfo=", + "dev": true, + "requires": { + "assert-plus": "^1.0.0" + } + }, + "git-log-parser": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/git-log-parser/-/git-log-parser-1.2.0.tgz", + "integrity": "sha1-LmpMGxP8AAKCB7p5WnrDFme5/Uo=", "dev": true, - "optional": true, "requires": { - "nan": "^2.12.1", - "node-pre-gyp": "^0.12.0" + "argv-formatter": "~1.0.0", + "spawn-error-forwarder": "~1.0.0", + "split2": "~1.0.0", + "stream-combiner2": "~1.1.1", + "through2": "~2.0.0", + "traverse": "~0.6.6" }, "dependencies": { - "abbrev": { - "version": "1.1.1", - "bundled": true, - "dev": true, - "optional": true - }, - "ansi-regex": { - "version": "2.1.1", - "bundled": true, - "dev": true, - "optional": true - }, - "aproba": { - "version": "1.2.0", - "bundled": true, - "dev": true, - "optional": true - }, - "are-we-there-yet": { - "version": "1.1.5", - "bundled": true, - "dev": true, - "optional": true, - "requires": { - "delegates": "^1.0.0", - "readable-stream": "^2.0.6" - } - }, - "balanced-match": { + "split2": { "version": "1.0.0", - "bundled": true, - "dev": true, - "optional": true - }, - "brace-expansion": { - "version": "1.1.11", - "bundled": true, + "resolved": "https://registry.npmjs.org/split2/-/split2-1.0.0.tgz", + "integrity": "sha1-UuLiIdiMdfmnP5BVbiY/+WdysxQ=", "dev": true, - "optional": true, "requires": { - "balanced-match": "^1.0.0", - "concat-map": "0.0.1" + "through2": "~2.0.0" } }, - "chownr": { - "version": "1.1.1", - "bundled": true, - "dev": true, - "optional": true - }, - "code-point-at": { - "version": "1.1.0", - "bundled": true, - "dev": true, - "optional": true - }, - "concat-map": { - "version": "0.0.1", - "bundled": true, - "dev": true, - "optional": true - }, - "console-control-strings": { - "version": "1.1.0", - "bundled": true, - "dev": true, - "optional": true - }, - "core-util-is": { - "version": "1.0.2", - "bundled": true, - "dev": true, - "optional": true - }, - "debug": { - "version": "4.1.1", - "bundled": true, + "through2": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/through2/-/through2-2.0.5.tgz", + "integrity": "sha512-/mrRod8xqpA+IHSLyGCQ2s8SPHiCDEeQJSep1jqLYeEUClOFG2Qsh+4FU6G9VeqpZnGW/Su8LQGc4YKni5rYSQ==", "dev": true, - "optional": true, "requires": { - "ms": "^2.1.1" - } - }, - "deep-extend": { - "version": "0.6.0", - "bundled": true, - "dev": true, - "optional": true - }, - "delegates": { - "version": "1.0.0", - "bundled": true, - "dev": true, - "optional": true - }, - "detect-libc": { - "version": "1.0.3", - "bundled": true, - "dev": true, - "optional": true - }, - "fs-minipass": { - "version": "1.2.5", - "bundled": true, - "dev": true, - "optional": true, - "requires": { - "minipass": "^2.2.1" - } - }, - "fs.realpath": { - "version": "1.0.0", - "bundled": true, - "dev": true, - "optional": true - }, - "gauge": { - "version": "2.7.4", - "bundled": true, - "dev": true, - "optional": true, - "requires": { - "aproba": "^1.0.3", - "console-control-strings": "^1.0.0", - "has-unicode": "^2.0.0", - "object-assign": "^4.1.0", - "signal-exit": "^3.0.0", - "string-width": "^1.0.1", - "strip-ansi": "^3.0.1", - "wide-align": "^1.1.0" - } - }, - "glob": { - "version": "7.1.3", - "bundled": true, - "dev": true, - "optional": true, - "requires": { - "fs.realpath": "^1.0.0", - "inflight": "^1.0.4", - "inherits": "2", - "minimatch": "^3.0.4", - "once": "^1.3.0", - "path-is-absolute": "^1.0.0" - } - }, - "has-unicode": { - "version": "2.0.1", - "bundled": true, - "dev": true, - "optional": true - }, - "iconv-lite": { - "version": "0.4.24", - "bundled": true, - "dev": true, - "optional": true, - "requires": { - "safer-buffer": ">= 2.1.2 < 3" - } - }, - "ignore-walk": { - "version": "3.0.1", - "bundled": true, - "dev": true, - "optional": true, - "requires": { - "minimatch": "^3.0.4" - } - }, - "inflight": { - "version": "1.0.6", - "bundled": true, - "dev": true, - "optional": true, - "requires": { - "once": "^1.3.0", - "wrappy": "1" - } - }, - "inherits": { - "version": "2.0.3", - "bundled": true, - "dev": true, - "optional": true - }, - "ini": { - "version": "1.3.5", - "bundled": true, - "dev": true, - "optional": true - }, - "is-fullwidth-code-point": { - "version": "1.0.0", - "bundled": true, - "dev": true, - "optional": true, - "requires": { - "number-is-nan": "^1.0.0" - } - }, - "isarray": { - "version": "1.0.0", - "bundled": true, - "dev": true, - "optional": true - }, - "minimatch": { - "version": "3.0.4", - "bundled": true, - "dev": true, - "optional": true, - "requires": { - "brace-expansion": "^1.1.7" - } - }, - "minimist": { - "version": "0.0.8", - "bundled": true, - "dev": true, - "optional": true - }, - "minipass": { - "version": "2.3.5", - "bundled": true, - "dev": true, - "optional": true, - "requires": { - "safe-buffer": "^5.1.2", - "yallist": "^3.0.0" - } - }, - "minizlib": { - "version": "1.2.1", - "bundled": true, - "dev": true, - "optional": true, - "requires": { - "minipass": "^2.2.1" - } - }, - "mkdirp": { - "version": "0.5.1", - "bundled": true, - "dev": true, - "optional": true, - "requires": { - "minimist": "0.0.8" - } - }, - "ms": { - "version": "2.1.1", - "bundled": true, - "dev": true, - "optional": true - }, - "needle": { - "version": "2.3.0", - "bundled": true, - "dev": true, - "optional": true, - "requires": { - "debug": "^4.1.0", - "iconv-lite": "^0.4.4", - "sax": "^1.2.4" - } - }, - "node-pre-gyp": { - "version": "0.12.0", - "bundled": true, - "dev": true, - "optional": true, - "requires": { - "detect-libc": "^1.0.2", - "mkdirp": "^0.5.1", - "needle": "^2.2.1", - "nopt": "^4.0.1", - "npm-packlist": "^1.1.6", - "npmlog": "^4.0.2", - "rc": "^1.2.7", - "rimraf": "^2.6.1", - "semver": "^5.3.0", - "tar": "^4" - } - }, - "nopt": { - "version": "4.0.1", - "bundled": true, - "dev": true, - "optional": true, - "requires": { - "abbrev": "1", - "osenv": "^0.1.4" - } - }, - "npm-bundled": { - "version": "1.0.6", - "bundled": true, - "dev": true, - "optional": true - }, - "npm-packlist": { - "version": "1.4.1", - "bundled": true, - "dev": true, - "optional": true, - "requires": { - "ignore-walk": "^3.0.1", - "npm-bundled": "^1.0.1" - } - }, - "npmlog": { - "version": "4.1.2", - "bundled": true, - "dev": true, - "optional": true, - "requires": { - "are-we-there-yet": "~1.1.2", - "console-control-strings": "~1.1.0", - "gauge": "~2.7.3", - "set-blocking": "~2.0.0" - } - }, - "number-is-nan": { - "version": "1.0.1", - "bundled": true, - "dev": true, - "optional": true - }, - "object-assign": { - "version": "4.1.1", - "bundled": true, - "dev": true, - "optional": true - }, - "once": { - "version": "1.4.0", - "bundled": true, - "dev": true, - "optional": true, - "requires": { - "wrappy": "1" - } - }, - "os-homedir": { - "version": "1.0.2", - "bundled": true, - "dev": true, - "optional": true - }, - "os-tmpdir": { - "version": "1.0.2", - "bundled": true, - "dev": true, - "optional": true - }, - "osenv": { - "version": "0.1.5", - "bundled": true, - "dev": true, - "optional": true, - "requires": { - "os-homedir": "^1.0.0", - "os-tmpdir": "^1.0.0" - } - }, - "path-is-absolute": { - "version": "1.0.1", - "bundled": true, - "dev": true, - "optional": true - }, - "process-nextick-args": { - "version": "2.0.0", - "bundled": true, - "dev": true, - "optional": true - }, - "rc": { - "version": "1.2.8", - "bundled": true, - "dev": true, - "optional": true, - "requires": { - "deep-extend": "^0.6.0", - "ini": "~1.3.0", - "minimist": "^1.2.0", - "strip-json-comments": "~2.0.1" - }, - "dependencies": { - "minimist": { - "version": "1.2.0", - "bundled": true, - "dev": true, - "optional": true - } - } - }, - "readable-stream": { - "version": "2.3.6", - "bundled": true, - "dev": true, - "optional": true, - "requires": { - "core-util-is": "~1.0.0", - "inherits": "~2.0.3", - "isarray": "~1.0.0", - "process-nextick-args": "~2.0.0", - "safe-buffer": "~5.1.1", - "string_decoder": "~1.1.1", - "util-deprecate": "~1.0.1" - } - }, - "rimraf": { - "version": "2.6.3", - "bundled": true, - "dev": true, - "optional": true, - "requires": { - "glob": "^7.1.3" - } - }, - "safe-buffer": { - "version": "5.1.2", - "bundled": true, - "dev": true, - "optional": true - }, - "safer-buffer": { - "version": "2.1.2", - "bundled": true, - "dev": true, - "optional": true - }, - "sax": { - "version": "1.2.4", - "bundled": true, - "dev": true, - "optional": true - }, - "semver": { - "version": "5.7.0", - "bundled": true, - "dev": true, - "optional": true - }, - "set-blocking": { - "version": "2.0.0", - "bundled": true, - "dev": true, - "optional": true - }, - "signal-exit": { - "version": "3.0.2", - "bundled": true, - "dev": true, - "optional": true - }, - "string-width": { - "version": "1.0.2", - "bundled": true, - "dev": true, - "optional": true, - "requires": { - "code-point-at": "^1.0.0", - "is-fullwidth-code-point": "^1.0.0", - "strip-ansi": "^3.0.0" - } - }, - "string_decoder": { - "version": "1.1.1", - "bundled": true, - "dev": true, - "optional": true, - "requires": { - "safe-buffer": "~5.1.0" - } - }, - "strip-ansi": { - "version": "3.0.1", - "bundled": true, - "dev": true, - "optional": true, - "requires": { - "ansi-regex": "^2.0.0" - } - }, - "strip-json-comments": { - "version": "2.0.1", - "bundled": true, - "dev": true, - "optional": true - }, - "tar": { - "version": "4.4.8", - "bundled": true, - "dev": true, - "optional": true, - "requires": { - "chownr": "^1.1.1", - "fs-minipass": "^1.2.5", - "minipass": "^2.3.4", - "minizlib": "^1.1.1", - "mkdirp": "^0.5.0", - "safe-buffer": "^5.1.2", - "yallist": "^3.0.2" - } - }, - "util-deprecate": { - "version": "1.0.2", - "bundled": true, - "dev": true, - "optional": true - }, - "wide-align": { - "version": "1.1.3", - "bundled": true, - "dev": true, - "optional": true, - "requires": { - "string-width": "^1.0.2 || 2" - } - }, - "wrappy": { - "version": "1.0.2", - "bundled": true, - "dev": true, - "optional": true - }, - "yallist": { - "version": "3.0.3", - "bundled": true, - "dev": true, - "optional": true - } - } - }, - "function-bind": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.1.tgz", - "integrity": "sha512-yIovAzMX49sF8Yl58fSCWJ5svSLuaibPxXQJFLmBObTuCr0Mf1KiPopGM9NiFjiYBCbfaa2Fh6breQ6ANVTI0A==", - "dev": true - }, - "get-caller-file": { - "version": "2.0.5", - "resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-2.0.5.tgz", - "integrity": "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==", - "dev": true - }, - "get-stream": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-4.1.0.tgz", - "integrity": "sha512-GMat4EJ5161kIy2HevLlr4luNjBgvmj413KaQA7jt4V8B4RDsfpHk7WQ9GVqfYyyx8OS/L66Kox+rJRNklLK7w==", - "dev": true, - "requires": { - "pump": "^3.0.0" - } - }, - "get-value": { - "version": "2.0.6", - "resolved": "https://registry.npmjs.org/get-value/-/get-value-2.0.6.tgz", - "integrity": "sha1-3BXKHGcjh8p2vTesCjlbogQqLCg=", - "dev": true - }, - "getpass": { - "version": "0.1.7", - "resolved": "https://registry.npmjs.org/getpass/-/getpass-0.1.7.tgz", - "integrity": "sha1-Xv+OPmhNVprkyysSgmBOi6YhSfo=", - "dev": true, - "requires": { - "assert-plus": "^1.0.0" - } - }, - "git-log-parser": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/git-log-parser/-/git-log-parser-1.2.0.tgz", - "integrity": "sha1-LmpMGxP8AAKCB7p5WnrDFme5/Uo=", - "dev": true, - "requires": { - "argv-formatter": "~1.0.0", - "spawn-error-forwarder": "~1.0.0", - "split2": "~1.0.0", - "stream-combiner2": "~1.1.1", - "through2": "~2.0.0", - "traverse": "~0.6.6" - }, - "dependencies": { - "split2": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/split2/-/split2-1.0.0.tgz", - "integrity": "sha1-UuLiIdiMdfmnP5BVbiY/+WdysxQ=", - "dev": true, - "requires": { - "through2": "~2.0.0" - } - }, - "through2": { - "version": "2.0.5", - "resolved": "https://registry.npmjs.org/through2/-/through2-2.0.5.tgz", - "integrity": "sha512-/mrRod8xqpA+IHSLyGCQ2s8SPHiCDEeQJSep1jqLYeEUClOFG2Qsh+4FU6G9VeqpZnGW/Su8LQGc4YKni5rYSQ==", - "dev": true, - "requires": { - "readable-stream": "~2.3.6", - "xtend": "~4.0.1" + "readable-stream": "~2.3.6", + "xtend": "~4.0.1" } } } @@ -5167,7 +6028,8 @@ "version": "1.3.0", "resolved": "https://registry.npmjs.org/growly/-/growly-1.3.0.tgz", "integrity": "sha1-8QdIy+dq+WS3yWyTxrzCivEgwIE=", - "dev": true + "dev": true, + "optional": true }, "handlebars": { "version": "4.5.1", @@ -5313,6 +6175,12 @@ "whatwg-encoding": "^1.0.1" } }, + "html-escaper": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/html-escaper/-/html-escaper-2.0.0.tgz", + "integrity": "sha512-a4u9BeERWGu/S8JiWEAQcdrg9v4QArtP9keViQjGMdff20fBdd8waotXaNmODqBe6uZ3Nafi7K/ho4gCQHV3Ig==", + "dev": true + }, "http-cache-semantics": { "version": "4.0.3", "resolved": "https://registry.npmjs.org/http-cache-semantics/-/http-cache-semantics-4.0.3.tgz", @@ -5413,67 +6281,13 @@ "dev": true }, "import-local": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/import-local/-/import-local-2.0.0.tgz", - "integrity": "sha512-b6s04m3O+s3CGSbqDIyP4R6aAwAeYlVq9+WUWep6iHa8ETRf9yei1U48C5MmfJmV9AiLYYBKPMq/W+/WRpQmCQ==", + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/import-local/-/import-local-3.0.2.tgz", + "integrity": "sha512-vjL3+w0oulAVZ0hBHnxa/Nm5TAurf9YLQJDhqRZyqb+VKGOB6LU8t9H1Nr5CIo16vh9XfJTOoHwU0B71S557gA==", "dev": true, "requires": { - "pkg-dir": "^3.0.0", - "resolve-cwd": "^2.0.0" - }, - "dependencies": { - "find-up": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/find-up/-/find-up-3.0.0.tgz", - "integrity": "sha512-1yD6RmLI1XBfxugvORwlck6f75tYL+iR0jqwsOrOxMZyGYqUuDhJ0l4AXdO1iX/FTs9cBAMEk1gWSEx1kSbylg==", - "dev": true, - "requires": { - "locate-path": "^3.0.0" - } - }, - "locate-path": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-3.0.0.tgz", - "integrity": "sha512-7AO748wWnIhNqAuaty2ZWHkQHRSNfPVIsPIfwEOWO22AmaoVrWavlOcMR5nzTLNYvp36X220/maaRsrec1G65A==", - "dev": true, - "requires": { - "p-locate": "^3.0.0", - "path-exists": "^3.0.0" - } - }, - "p-limit": { - "version": "2.2.1", - "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.2.1.tgz", - "integrity": "sha512-85Tk+90UCVWvbDavCLKPOLC9vvY8OwEX/RtKF+/1OADJMVlFfEHOiMTPVyxg7mk/dKa+ipdHm0OUkTvCpMTuwg==", - "dev": true, - "requires": { - "p-try": "^2.0.0" - } - }, - "p-locate": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-3.0.0.tgz", - "integrity": "sha512-x+12w/To+4GFfgJhBEpiDcLozRJGegY+Ei7/z0tSLkMmxGZNybVMSfWj9aJn8Z5Fc7dBUNJOOVgPv2H7IwulSQ==", - "dev": true, - "requires": { - "p-limit": "^2.0.0" - } - }, - "p-try": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", - "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==", - "dev": true - }, - "pkg-dir": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/pkg-dir/-/pkg-dir-3.0.0.tgz", - "integrity": "sha512-/E57AYkoeQ25qkxMj5PBOVgF8Kiu/h7cYS30Z5+R7WaiCCBfLq58ZI/dSeaEKb9WVJV5n/03QwrN3IeWIFllvw==", - "dev": true, - "requires": { - "find-up": "^3.0.0" - } - } + "pkg-dir": "^4.2.0", + "resolve-cwd": "^3.0.0" } }, "imurmurhash": { @@ -5913,351 +6727,1084 @@ "integrity": "sha512-zKa/Dxq2lGsBIXQ7CUZWTHfvxPC2ej0KfO7fIPqLlHB9J2hJ7rGhZ5rilhuufylr4RXYPzJUeFjKxz305OsNlA==", "dev": true, "requires": { - "lodash.capitalize": "^4.2.1", - "lodash.escaperegexp": "^4.1.2", - "lodash.isplainobject": "^4.0.6", - "lodash.isstring": "^4.0.1", - "lodash.uniqby": "^4.7.0" + "lodash.capitalize": "^4.2.1", + "lodash.escaperegexp": "^4.1.2", + "lodash.isplainobject": "^4.0.6", + "lodash.isstring": "^4.0.1", + "lodash.uniqby": "^4.7.0" + } + }, + "issue-regex": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/issue-regex/-/issue-regex-2.0.0.tgz", + "integrity": "sha512-flaQ/45dMqCYSMzBQI/h3bcto6T70uN7kjNnI8n3gQU6no5p+QcnMWBNXkraED0YvbUymxKaqdvgPa09RZQM5A==", + "dev": true + }, + "istanbul-lib-coverage": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/istanbul-lib-coverage/-/istanbul-lib-coverage-3.0.0.tgz", + "integrity": "sha512-UiUIqxMgRDET6eR+o5HbfRYP1l0hqkWOs7vNxC/mggutCMUIhWMm8gAHb8tHlyfD3/l6rlgNA5cKdDzEAf6hEg==", + "dev": true + }, + "istanbul-lib-instrument": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/istanbul-lib-instrument/-/istanbul-lib-instrument-4.0.0.tgz", + "integrity": "sha512-Nm4wVHdo7ZXSG30KjZ2Wl5SU/Bw7bDx1PdaiIFzEStdjs0H12mOTncn1GVYuqQSaZxpg87VGBRsVRPGD2cD1AQ==", + "dev": true, + "requires": { + "@babel/core": "^7.7.5", + "@babel/parser": "^7.7.5", + "@babel/template": "^7.7.4", + "@babel/traverse": "^7.7.4", + "@istanbuljs/schema": "^0.1.2", + "istanbul-lib-coverage": "^3.0.0", + "semver": "^6.3.0" + }, + "dependencies": { + "@babel/code-frame": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.8.3.tgz", + "integrity": "sha512-a9gxpmdXtZEInkCSHUJDLHZVBgb1QS0jhss4cPP93EW7s+uC5bikET2twEF3KV+7rDblJcmNvTR7VJejqd2C2g==", + "dev": true, + "requires": { + "@babel/highlight": "^7.8.3" + } + }, + "@babel/core": { + "version": "7.8.4", + "resolved": "https://registry.npmjs.org/@babel/core/-/core-7.8.4.tgz", + "integrity": "sha512-0LiLrB2PwrVI+a2/IEskBopDYSd8BCb3rOvH7D5tzoWd696TBEduBvuLVm4Nx6rltrLZqvI3MCalB2K2aVzQjA==", + "dev": true, + "requires": { + "@babel/code-frame": "^7.8.3", + "@babel/generator": "^7.8.4", + "@babel/helpers": "^7.8.4", + "@babel/parser": "^7.8.4", + "@babel/template": "^7.8.3", + "@babel/traverse": "^7.8.4", + "@babel/types": "^7.8.3", + "convert-source-map": "^1.7.0", + "debug": "^4.1.0", + "gensync": "^1.0.0-beta.1", + "json5": "^2.1.0", + "lodash": "^4.17.13", + "resolve": "^1.3.2", + "semver": "^5.4.1", + "source-map": "^0.5.0" + }, + "dependencies": { + "semver": { + "version": "5.7.1", + "resolved": "https://registry.npmjs.org/semver/-/semver-5.7.1.tgz", + "integrity": "sha512-sauaDf/PZdVgrLTNYHRtpXa1iRiKcaebiKQ1BJdpQlWH2lCvexQdX55snPFyK7QzpudqbCI0qXFfOasHdyNDGQ==", + "dev": true + } + } + }, + "@babel/generator": { + "version": "7.8.4", + "resolved": "https://registry.npmjs.org/@babel/generator/-/generator-7.8.4.tgz", + "integrity": "sha512-PwhclGdRpNAf3IxZb0YVuITPZmmrXz9zf6fH8lT4XbrmfQKr6ryBzhv593P5C6poJRciFCL/eHGW2NuGrgEyxA==", + "dev": true, + "requires": { + "@babel/types": "^7.8.3", + "jsesc": "^2.5.1", + "lodash": "^4.17.13", + "source-map": "^0.5.0" + } + }, + "@babel/helper-function-name": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/helper-function-name/-/helper-function-name-7.8.3.tgz", + "integrity": "sha512-BCxgX1BC2hD/oBlIFUgOCQDOPV8nSINxCwM3o93xP4P9Fq6aV5sgv2cOOITDMtCfQ+3PvHp3l689XZvAM9QyOA==", + "dev": true, + "requires": { + "@babel/helper-get-function-arity": "^7.8.3", + "@babel/template": "^7.8.3", + "@babel/types": "^7.8.3" + } + }, + "@babel/helper-get-function-arity": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/helper-get-function-arity/-/helper-get-function-arity-7.8.3.tgz", + "integrity": "sha512-FVDR+Gd9iLjUMY1fzE2SR0IuaJToR4RkCDARVfsBBPSP53GEqSFjD8gNyxg246VUyc/ALRxFaAK8rVG7UT7xRA==", + "dev": true, + "requires": { + "@babel/types": "^7.8.3" + } + }, + "@babel/helper-split-export-declaration": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/helper-split-export-declaration/-/helper-split-export-declaration-7.8.3.tgz", + "integrity": "sha512-3x3yOeyBhW851hroze7ElzdkeRXQYQbFIb7gLK1WQYsw2GWDay5gAJNw1sWJ0VFP6z5J1whqeXH/WCdCjZv6dA==", + "dev": true, + "requires": { + "@babel/types": "^7.8.3" + } + }, + "@babel/helpers": { + "version": "7.8.4", + "resolved": "https://registry.npmjs.org/@babel/helpers/-/helpers-7.8.4.tgz", + "integrity": "sha512-VPbe7wcQ4chu4TDQjimHv/5tj73qz88o12EPkO2ValS2QiQS/1F2SsjyIGNnAD0vF/nZS6Cf9i+vW6HIlnaR8w==", + "dev": true, + "requires": { + "@babel/template": "^7.8.3", + "@babel/traverse": "^7.8.4", + "@babel/types": "^7.8.3" + } + }, + "@babel/highlight": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/highlight/-/highlight-7.8.3.tgz", + "integrity": "sha512-PX4y5xQUvy0fnEVHrYOarRPXVWafSjTW9T0Hab8gVIawpl2Sj0ORyrygANq+KjcNlSSTw0YCLSNA8OyZ1I4yEg==", + "dev": true, + "requires": { + "chalk": "^2.0.0", + "esutils": "^2.0.2", + "js-tokens": "^4.0.0" + } + }, + "@babel/parser": { + "version": "7.8.4", + "resolved": "https://registry.npmjs.org/@babel/parser/-/parser-7.8.4.tgz", + "integrity": "sha512-0fKu/QqildpXmPVaRBoXOlyBb3MC+J0A66x97qEfLOMkn3u6nfY5esWogQwi/K0BjASYy4DbnsEWnpNL6qT5Mw==", + "dev": true + }, + "@babel/template": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/template/-/template-7.8.3.tgz", + "integrity": "sha512-04m87AcQgAFdvuoyiQ2kgELr2tV8B4fP/xJAVUL3Yb3bkNdMedD3d0rlSQr3PegP0cms3eHjl1F7PWlvWbU8FQ==", + "dev": true, + "requires": { + "@babel/code-frame": "^7.8.3", + "@babel/parser": "^7.8.3", + "@babel/types": "^7.8.3" + } + }, + "@babel/traverse": { + "version": "7.8.4", + "resolved": "https://registry.npmjs.org/@babel/traverse/-/traverse-7.8.4.tgz", + "integrity": "sha512-NGLJPZwnVEyBPLI+bl9y9aSnxMhsKz42so7ApAv9D+b4vAFPpY013FTS9LdKxcABoIYFU52HcYga1pPlx454mg==", + "dev": true, + "requires": { + "@babel/code-frame": "^7.8.3", + "@babel/generator": "^7.8.4", + "@babel/helper-function-name": "^7.8.3", + "@babel/helper-split-export-declaration": "^7.8.3", + "@babel/parser": "^7.8.4", + "@babel/types": "^7.8.3", + "debug": "^4.1.0", + "globals": "^11.1.0", + "lodash": "^4.17.13" + } + }, + "@babel/types": { + "version": "7.8.3", + "resolved": "https://registry.npmjs.org/@babel/types/-/types-7.8.3.tgz", + "integrity": "sha512-jBD+G8+LWpMBBWvVcdr4QysjUE4mU/syrhN17o1u3gx0/WzJB1kwiVZAXRtWbsIPOwW8pF/YJV5+nmetPzepXg==", + "dev": true, + "requires": { + "esutils": "^2.0.2", + "lodash": "^4.17.13", + "to-fast-properties": "^2.0.0" + } + }, + "semver": { + "version": "6.3.0", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.0.tgz", + "integrity": "sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw==", + "dev": true + } + } + }, + "istanbul-lib-report": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/istanbul-lib-report/-/istanbul-lib-report-3.0.0.tgz", + "integrity": "sha512-wcdi+uAKzfiGT2abPpKZ0hSU1rGQjUQnLvtY5MpQ7QCTahD3VODhcu4wcfY1YtkGaDD5yuydOLINXsfbus9ROw==", + "dev": true, + "requires": { + "istanbul-lib-coverage": "^3.0.0", + "make-dir": "^3.0.0", + "supports-color": "^7.1.0" + }, + "dependencies": { + "has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true + }, + "make-dir": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/make-dir/-/make-dir-3.0.0.tgz", + "integrity": "sha512-grNJDhb8b1Jm1qeqW5R/O63wUo4UXo2v2HMic6YT9i/HBlF93S8jkMgH7yugvY9ABDShH4VZMn8I+U8+fCNegw==", + "dev": true, + "requires": { + "semver": "^6.0.0" + } + }, + "semver": { + "version": "6.3.0", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.0.tgz", + "integrity": "sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw==", + "dev": true + }, + "supports-color": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.1.0.tgz", + "integrity": "sha512-oRSIpR8pxT1Wr2FquTNnGet79b3BWljqOuoW/h4oBhxJ/HUbX5nX6JSruTkvXDCFMwDPvsaTTbvMLKZWSy0R5g==", + "dev": true, + "requires": { + "has-flag": "^4.0.0" + } + } + } + }, + "istanbul-lib-source-maps": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/istanbul-lib-source-maps/-/istanbul-lib-source-maps-4.0.0.tgz", + "integrity": "sha512-c16LpFRkR8vQXyHZ5nLpY35JZtzj1PQY1iZmesUbf1FZHbIupcWfjgOXBY9YHkLEQ6puz1u4Dgj6qmU/DisrZg==", + "dev": true, + "requires": { + "debug": "^4.1.1", + "istanbul-lib-coverage": "^3.0.0", + "source-map": "^0.6.1" + }, + "dependencies": { + "source-map": { + "version": "0.6.1", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", + "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "dev": true + } + } + }, + "istanbul-reports": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/istanbul-reports/-/istanbul-reports-3.0.0.tgz", + "integrity": "sha512-2osTcC8zcOSUkImzN2EWQta3Vdi4WjjKw99P2yWx5mLnigAM0Rd5uYFn1cf2i/Ois45GkNjaoTqc5CxgMSX80A==", + "dev": true, + "requires": { + "html-escaper": "^2.0.0", + "istanbul-lib-report": "^3.0.0" } }, - "issue-regex": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/issue-regex/-/issue-regex-2.0.0.tgz", - "integrity": "sha512-flaQ/45dMqCYSMzBQI/h3bcto6T70uN7kjNnI8n3gQU6no5p+QcnMWBNXkraED0YvbUymxKaqdvgPa09RZQM5A==", + "java-properties": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/java-properties/-/java-properties-1.0.2.tgz", + "integrity": "sha512-qjdpeo2yKlYTH7nFdK0vbZWuTCesk4o63v5iVOlhMQPfuIZQfW/HI35SjfhA+4qpg36rnFSvUK5b1m+ckIblQQ==", "dev": true }, - "istanbul-lib-coverage": { - "version": "2.0.5", - "resolved": "https://registry.npmjs.org/istanbul-lib-coverage/-/istanbul-lib-coverage-2.0.5.tgz", - "integrity": "sha512-8aXznuEPCJvGnMSRft4udDRDtb1V3pkQkMMI5LI+6HuQz5oQ4J2UFn1H82raA3qJtyOLkkwVqICBQkjnGtn5mA==", - "dev": true + "jest": { + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/jest/-/jest-25.1.0.tgz", + "integrity": "sha512-FV6jEruneBhokkt9MQk0WUFoNTwnF76CLXtwNMfsc0um0TlB/LG2yxUd0KqaFjEJ9laQmVWQWS0sG/t2GsuI0w==", + "dev": true, + "requires": { + "@jest/core": "^25.1.0", + "import-local": "^3.0.2", + "jest-cli": "^25.1.0" + }, + "dependencies": { + "ansi-styles": { + "version": "4.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.2.1.tgz", + "integrity": "sha512-9VGjrMsG1vePxcSweQsN20KY/c4zN0h9fLjqAbwbPfahM3t+NL+M9HC8xeXG2I8pX5NoamTGNuomEUFI7fcUjA==", + "dev": true, + "requires": { + "@types/color-name": "^1.1.1", + "color-convert": "^2.0.1" + } + }, + "chalk": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-3.0.0.tgz", + "integrity": "sha512-4D3B6Wf41KOYRFdszmDqMCGq5VV/uMAB273JILmO+3jAlh8X4qDtdtgCR3fxtbLEMzSx22QdhnDcJvu2u1fVwg==", + "dev": true, + "requires": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + } + }, + "color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "requires": { + "color-name": "~1.1.4" + } + }, + "color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + }, + "has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true + }, + "jest-cli": { + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/jest-cli/-/jest-cli-25.1.0.tgz", + "integrity": "sha512-p+aOfczzzKdo3AsLJlhs8J5EW6ffVidfSZZxXedJ0mHPBOln1DccqFmGCoO8JWd4xRycfmwy1eoQkMsF8oekPg==", + "dev": true, + "requires": { + "@jest/core": "^25.1.0", + "@jest/test-result": "^25.1.0", + "@jest/types": "^25.1.0", + "chalk": "^3.0.0", + "exit": "^0.1.2", + "import-local": "^3.0.2", + "is-ci": "^2.0.0", + "jest-config": "^25.1.0", + "jest-util": "^25.1.0", + "jest-validate": "^25.1.0", + "prompts": "^2.0.1", + "realpath-native": "^1.1.0", + "yargs": "^15.0.0" + } + }, + "supports-color": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.1.0.tgz", + "integrity": "sha512-oRSIpR8pxT1Wr2FquTNnGet79b3BWljqOuoW/h4oBhxJ/HUbX5nX6JSruTkvXDCFMwDPvsaTTbvMLKZWSy0R5g==", + "dev": true, + "requires": { + "has-flag": "^4.0.0" + } + } + } }, - "istanbul-lib-instrument": { - "version": "3.3.0", - "resolved": "https://registry.npmjs.org/istanbul-lib-instrument/-/istanbul-lib-instrument-3.3.0.tgz", - "integrity": "sha512-5nnIN4vo5xQZHdXno/YDXJ0G+I3dAm4XgzfSVTPLQpj/zAV2dV6Juy0yaf10/zrJOJeHoN3fraFe+XRq2bFVZA==", + "jest-changed-files": { + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/jest-changed-files/-/jest-changed-files-25.1.0.tgz", + "integrity": "sha512-bdL1aHjIVy3HaBO3eEQeemGttsq1BDlHgWcOjEOIAcga7OOEGWHD2WSu8HhL7I1F0mFFyci8VKU4tRNk+qtwDA==", "dev": true, "requires": { - "@babel/generator": "^7.4.0", - "@babel/parser": "^7.4.3", - "@babel/template": "^7.4.0", - "@babel/traverse": "^7.4.3", - "@babel/types": "^7.4.0", - "istanbul-lib-coverage": "^2.0.5", - "semver": "^6.0.0" + "@jest/types": "^25.1.0", + "execa": "^3.2.0", + "throat": "^5.0.0" }, "dependencies": { - "semver": { - "version": "6.3.0", - "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.0.tgz", - "integrity": "sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw==", + "cross-spawn": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/cross-spawn/-/cross-spawn-7.0.1.tgz", + "integrity": "sha512-u7v4o84SwFpD32Z8IIcPZ6z1/ie24O6RU3RbtL5Y316l3KuHVPx9ItBgWQ6VlfAFnRnTtMUrsQ9MUUTuEZjogg==", + "dev": true, + "requires": { + "path-key": "^3.1.0", + "shebang-command": "^2.0.0", + "which": "^2.0.1" + } + }, + "execa": { + "version": "3.4.0", + "resolved": "https://registry.npmjs.org/execa/-/execa-3.4.0.tgz", + "integrity": "sha512-r9vdGQk4bmCuK1yKQu1KTwcT2zwfWdbdaXfCtAh+5nU/4fSX+JAb7vZGvI5naJrQlvONrEB20jeruESI69530g==", + "dev": true, + "requires": { + "cross-spawn": "^7.0.0", + "get-stream": "^5.0.0", + "human-signals": "^1.1.1", + "is-stream": "^2.0.0", + "merge-stream": "^2.0.0", + "npm-run-path": "^4.0.0", + "onetime": "^5.1.0", + "p-finally": "^2.0.0", + "signal-exit": "^3.0.2", + "strip-final-newline": "^2.0.0" + } + }, + "get-stream": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/get-stream/-/get-stream-5.1.0.tgz", + "integrity": "sha512-EXr1FOzrzTfGeL0gQdeFEvOMm2mzMOglyiOXSTpPC+iAjAKftbr3jpCMWynogwYnM+eSj9sHGc6wjIcDvYiygw==", + "dev": true, + "requires": { + "pump": "^3.0.0" + } + }, + "is-stream": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/is-stream/-/is-stream-2.0.0.tgz", + "integrity": "sha512-XCoy+WlUr7d1+Z8GgSuXmpuUFC9fOhRXglJMx+dwLKTkL44Cjd4W1Z5P+BQZpr+cR93aGP4S/s7Ftw6Nd/kiEw==", + "dev": true + }, + "npm-run-path": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-4.0.1.tgz", + "integrity": "sha512-S48WzZW777zhNIrn7gxOlISNAqi9ZC/uQFnRdbeIHhZhCA6UqpkOT8T1G7BvfdgP4Er8gF4sUbaS0i7QvIfCWw==", + "dev": true, + "requires": { + "path-key": "^3.0.0" + } + }, + "p-finally": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/p-finally/-/p-finally-2.0.1.tgz", + "integrity": "sha512-vpm09aKwq6H9phqRQzecoDpD8TmVyGw70qmWlyq5onxY7tqyTTFVvxMykxQSQKILBSFlbXpypIw2T1Ml7+DDtw==", + "dev": true + }, + "path-key": { + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/path-key/-/path-key-3.1.1.tgz", + "integrity": "sha512-ojmeN0qd+y0jszEtoY48r0Peq5dwMEkIlCOu6Q5f41lfkswXuKtYrhgoTpLnyIcHm24Uhqx+5Tqm2InSwLhE6Q==", + "dev": true + }, + "shebang-command": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/shebang-command/-/shebang-command-2.0.0.tgz", + "integrity": "sha512-kHxr2zZpYtdmrN1qDjrrX/Z1rR1kG8Dx+gkpK1G4eXmvXswmcE1hTWBWYUzlraYw1/yZp6YuDY77YtvbN0dmDA==", + "dev": true, + "requires": { + "shebang-regex": "^3.0.0" + } + }, + "shebang-regex": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/shebang-regex/-/shebang-regex-3.0.0.tgz", + "integrity": "sha512-7++dFhtcx3353uBaq8DDR4NuxBetBzC7ZQOhmTQInHEd6bSrXdiEyzCvG07Z44UYdLShWUyXt5M/yhz8ekcb1A==", + "dev": true + }, + "which": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", + "integrity": "sha512-BLI3Tl1TW3Pvl70l3yq3Y64i+awpwXqsGBYWkkqMtnbXgrMD+yj7rhW0kuEDxzJaYXGjEW5ogapKNMEKNMjibA==", + "dev": true, + "requires": { + "isexe": "^2.0.0" + } + } + } + }, + "jest-config": { + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/jest-config/-/jest-config-25.1.0.tgz", + "integrity": "sha512-tLmsg4SZ5H7tuhBC5bOja0HEblM0coS3Wy5LTCb2C8ZV6eWLewHyK+3qSq9Bi29zmWQ7ojdCd3pxpx4l4d2uGw==", + "dev": true, + "requires": { + "@babel/core": "^7.1.0", + "@jest/test-sequencer": "^25.1.0", + "@jest/types": "^25.1.0", + "babel-jest": "^25.1.0", + "chalk": "^3.0.0", + "glob": "^7.1.1", + "jest-environment-jsdom": "^25.1.0", + "jest-environment-node": "^25.1.0", + "jest-get-type": "^25.1.0", + "jest-jasmine2": "^25.1.0", + "jest-regex-util": "^25.1.0", + "jest-resolve": "^25.1.0", + "jest-util": "^25.1.0", + "jest-validate": "^25.1.0", + "micromatch": "^4.0.2", + "pretty-format": "^25.1.0", + "realpath-native": "^1.1.0" + }, + "dependencies": { + "ansi-styles": { + "version": "4.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.2.1.tgz", + "integrity": "sha512-9VGjrMsG1vePxcSweQsN20KY/c4zN0h9fLjqAbwbPfahM3t+NL+M9HC8xeXG2I8pX5NoamTGNuomEUFI7fcUjA==", + "dev": true, + "requires": { + "@types/color-name": "^1.1.1", + "color-convert": "^2.0.1" + } + }, + "braces": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz", + "integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==", + "dev": true, + "requires": { + "fill-range": "^7.0.1" + } + }, + "chalk": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-3.0.0.tgz", + "integrity": "sha512-4D3B6Wf41KOYRFdszmDqMCGq5VV/uMAB273JILmO+3jAlh8X4qDtdtgCR3fxtbLEMzSx22QdhnDcJvu2u1fVwg==", + "dev": true, + "requires": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + } + }, + "color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "requires": { + "color-name": "~1.1.4" + } + }, + "color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + }, + "fill-range": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz", + "integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==", + "dev": true, + "requires": { + "to-regex-range": "^5.0.1" + } + }, + "has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true + }, + "is-number": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", + "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", "dev": true - } - } - }, - "istanbul-lib-report": { - "version": "2.0.8", - "resolved": "https://registry.npmjs.org/istanbul-lib-report/-/istanbul-lib-report-2.0.8.tgz", - "integrity": "sha512-fHBeG573EIihhAblwgxrSenp0Dby6tJMFR/HvlerBsrCTD5bkUuoNtn3gVh29ZCS824cGGBPn7Sg7cNk+2xUsQ==", - "dev": true, - "requires": { - "istanbul-lib-coverage": "^2.0.5", - "make-dir": "^2.1.0", - "supports-color": "^6.1.0" - }, - "dependencies": { - "make-dir": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/make-dir/-/make-dir-2.1.0.tgz", - "integrity": "sha512-LS9X+dc8KLxXCb8dni79fLIIUA5VyZoyjSMCwTluaXA0o27cCK0bhXkpgw+sTXVpPy/lSO57ilRixqk0vDmtRA==", + }, + "micromatch": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.2.tgz", + "integrity": "sha512-y7FpHSbMUMoyPbYUSzO6PaZ6FyRnQOpHuKwbo1G+Knck95XVU4QAiKdGEnj5wwoS7PlOgthX/09u5iFJ+aYf5Q==", "dev": true, "requires": { - "pify": "^4.0.1", - "semver": "^5.6.0" + "braces": "^3.0.1", + "picomatch": "^2.0.5" } }, "supports-color": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-6.1.0.tgz", - "integrity": "sha512-qe1jfm1Mg7Nq/NSh6XE24gPXROEVsWHxC1LIx//XNlD9iw7YZQGjZNjYN7xGaEG6iKdA8EtNFW6R0gjnVXp+wQ==", + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.1.0.tgz", + "integrity": "sha512-oRSIpR8pxT1Wr2FquTNnGet79b3BWljqOuoW/h4oBhxJ/HUbX5nX6JSruTkvXDCFMwDPvsaTTbvMLKZWSy0R5g==", "dev": true, "requires": { - "has-flag": "^3.0.0" + "has-flag": "^4.0.0" + } + }, + "to-regex-range": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", + "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", + "dev": true, + "requires": { + "is-number": "^7.0.0" } } } }, - "istanbul-lib-source-maps": { - "version": "3.0.6", - "resolved": "https://registry.npmjs.org/istanbul-lib-source-maps/-/istanbul-lib-source-maps-3.0.6.tgz", - "integrity": "sha512-R47KzMtDJH6X4/YW9XTx+jrLnZnscW4VpNN+1PViSYTejLVPWv7oov+Duf8YQSPyVRUvueQqz1TcsC6mooZTXw==", + "jest-diff": { + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/jest-diff/-/jest-diff-25.1.0.tgz", + "integrity": "sha512-nepXgajT+h017APJTreSieh4zCqnSHEJ1iT8HDlewu630lSJ4Kjjr9KNzm+kzGwwcpsDE6Snx1GJGzzsefaEHw==", "dev": true, "requires": { - "debug": "^4.1.1", - "istanbul-lib-coverage": "^2.0.5", - "make-dir": "^2.1.0", - "rimraf": "^2.6.3", - "source-map": "^0.6.1" + "chalk": "^3.0.0", + "diff-sequences": "^25.1.0", + "jest-get-type": "^25.1.0", + "pretty-format": "^25.1.0" }, "dependencies": { - "make-dir": { - "version": "2.1.0", - "resolved": "https://registry.npmjs.org/make-dir/-/make-dir-2.1.0.tgz", - "integrity": "sha512-LS9X+dc8KLxXCb8dni79fLIIUA5VyZoyjSMCwTluaXA0o27cCK0bhXkpgw+sTXVpPy/lSO57ilRixqk0vDmtRA==", + "ansi-styles": { + "version": "4.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.2.1.tgz", + "integrity": "sha512-9VGjrMsG1vePxcSweQsN20KY/c4zN0h9fLjqAbwbPfahM3t+NL+M9HC8xeXG2I8pX5NoamTGNuomEUFI7fcUjA==", "dev": true, "requires": { - "pify": "^4.0.1", - "semver": "^5.6.0" + "@types/color-name": "^1.1.1", + "color-convert": "^2.0.1" } }, - "source-map": { - "version": "0.6.1", - "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", - "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "chalk": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-3.0.0.tgz", + "integrity": "sha512-4D3B6Wf41KOYRFdszmDqMCGq5VV/uMAB273JILmO+3jAlh8X4qDtdtgCR3fxtbLEMzSx22QdhnDcJvu2u1fVwg==", + "dev": true, + "requires": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + } + }, + "color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "requires": { + "color-name": "~1.1.4" + } + }, + "color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + }, + "has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", "dev": true + }, + "supports-color": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.1.0.tgz", + "integrity": "sha512-oRSIpR8pxT1Wr2FquTNnGet79b3BWljqOuoW/h4oBhxJ/HUbX5nX6JSruTkvXDCFMwDPvsaTTbvMLKZWSy0R5g==", + "dev": true, + "requires": { + "has-flag": "^4.0.0" + } } } }, - "istanbul-reports": { - "version": "2.2.6", - "resolved": "https://registry.npmjs.org/istanbul-reports/-/istanbul-reports-2.2.6.tgz", - "integrity": "sha512-SKi4rnMyLBKe0Jy2uUdx28h8oG7ph2PPuQPvIAh31d+Ci+lSiEu4C+h3oBPuJ9+mPKhOyW0M8gY4U5NM1WLeXA==", + "jest-docblock": { + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/jest-docblock/-/jest-docblock-25.1.0.tgz", + "integrity": "sha512-370P/mh1wzoef6hUKiaMcsPtIapY25suP6JqM70V9RJvdKLrV4GaGbfUseUVk4FZJw4oTZ1qSCJNdrClKt5JQA==", "dev": true, "requires": { - "handlebars": "^4.1.2" + "detect-newline": "^3.0.0" } }, - "java-properties": { - "version": "1.0.2", - "resolved": "https://registry.npmjs.org/java-properties/-/java-properties-1.0.2.tgz", - "integrity": "sha512-qjdpeo2yKlYTH7nFdK0vbZWuTCesk4o63v5iVOlhMQPfuIZQfW/HI35SjfhA+4qpg36rnFSvUK5b1m+ckIblQQ==", - "dev": true - }, - "jest": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/jest/-/jest-24.9.0.tgz", - "integrity": "sha512-YvkBL1Zm7d2B1+h5fHEOdyjCG+sGMz4f8D86/0HiqJ6MB4MnDc8FgP5vdWsGnemOQro7lnYo8UakZ3+5A0jxGw==", + "jest-each": { + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/jest-each/-/jest-each-25.1.0.tgz", + "integrity": "sha512-R9EL8xWzoPySJ5wa0DXFTj7NrzKpRD40Jy+zQDp3Qr/2QmevJgkN9GqioCGtAJ2bW9P/MQRznQHQQhoeAyra7A==", "dev": true, "requires": { - "import-local": "^2.0.0", - "jest-cli": "^24.9.0" + "@jest/types": "^25.1.0", + "chalk": "^3.0.0", + "jest-get-type": "^25.1.0", + "jest-util": "^25.1.0", + "pretty-format": "^25.1.0" }, "dependencies": { - "jest-cli": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/jest-cli/-/jest-cli-24.9.0.tgz", - "integrity": "sha512-+VLRKyitT3BWoMeSUIHRxV/2g8y9gw91Jh5z2UmXZzkZKpbC08CSehVxgHUwTpy+HwGcns/tqafQDJW7imYvGg==", + "ansi-styles": { + "version": "4.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.2.1.tgz", + "integrity": "sha512-9VGjrMsG1vePxcSweQsN20KY/c4zN0h9fLjqAbwbPfahM3t+NL+M9HC8xeXG2I8pX5NoamTGNuomEUFI7fcUjA==", "dev": true, "requires": { - "@jest/core": "^24.9.0", - "@jest/test-result": "^24.9.0", - "@jest/types": "^24.9.0", - "chalk": "^2.0.1", - "exit": "^0.1.2", - "import-local": "^2.0.0", - "is-ci": "^2.0.0", - "jest-config": "^24.9.0", - "jest-util": "^24.9.0", - "jest-validate": "^24.9.0", - "prompts": "^2.0.1", - "realpath-native": "^1.1.0", - "yargs": "^13.3.0" + "@types/color-name": "^1.1.1", + "color-convert": "^2.0.1" + } + }, + "chalk": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-3.0.0.tgz", + "integrity": "sha512-4D3B6Wf41KOYRFdszmDqMCGq5VV/uMAB273JILmO+3jAlh8X4qDtdtgCR3fxtbLEMzSx22QdhnDcJvu2u1fVwg==", + "dev": true, + "requires": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + } + }, + "color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "requires": { + "color-name": "~1.1.4" + } + }, + "color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + }, + "has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true + }, + "supports-color": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.1.0.tgz", + "integrity": "sha512-oRSIpR8pxT1Wr2FquTNnGet79b3BWljqOuoW/h4oBhxJ/HUbX5nX6JSruTkvXDCFMwDPvsaTTbvMLKZWSy0R5g==", + "dev": true, + "requires": { + "has-flag": "^4.0.0" } } } }, - "jest-changed-files": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/jest-changed-files/-/jest-changed-files-24.9.0.tgz", - "integrity": "sha512-6aTWpe2mHF0DhL28WjdkO8LyGjs3zItPET4bMSeXU6T3ub4FPMw+mcOcbdGXQOAfmLcxofD23/5Bl9Z4AkFwqg==", - "dev": true, - "requires": { - "@jest/types": "^24.9.0", - "execa": "^1.0.0", - "throat": "^4.0.0" - } - }, - "jest-config": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/jest-config/-/jest-config-24.9.0.tgz", - "integrity": "sha512-RATtQJtVYQrp7fvWg6f5y3pEFj9I+H8sWw4aKxnDZ96mob5i5SD6ZEGWgMLXQ4LE8UurrjbdlLWdUeo+28QpfQ==", - "dev": true, - "requires": { - "@babel/core": "^7.1.0", - "@jest/test-sequencer": "^24.9.0", - "@jest/types": "^24.9.0", - "babel-jest": "^24.9.0", - "chalk": "^2.0.1", - "glob": "^7.1.1", - "jest-environment-jsdom": "^24.9.0", - "jest-environment-node": "^24.9.0", - "jest-get-type": "^24.9.0", - "jest-jasmine2": "^24.9.0", - "jest-regex-util": "^24.3.0", - "jest-resolve": "^24.9.0", - "jest-util": "^24.9.0", - "jest-validate": "^24.9.0", - "micromatch": "^3.1.10", - "pretty-format": "^24.9.0", - "realpath-native": "^1.1.0" - } - }, - "jest-diff": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/jest-diff/-/jest-diff-24.9.0.tgz", - "integrity": "sha512-qMfrTs8AdJE2iqrTp0hzh7kTd2PQWrsFyj9tORoKmu32xjPjeE4NyjVRDz8ybYwqS2ik8N4hsIpiVTyFeo2lBQ==", - "dev": true, - "requires": { - "chalk": "^2.0.1", - "diff-sequences": "^24.9.0", - "jest-get-type": "^24.9.0", - "pretty-format": "^24.9.0" - } - }, - "jest-docblock": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/jest-docblock/-/jest-docblock-24.9.0.tgz", - "integrity": "sha512-F1DjdpDMJMA1cN6He0FNYNZlo3yYmOtRUnktrT9Q37njYzC5WEaDdmbynIgy0L/IvXvvgsG8OsqhLPXTpfmZAA==", - "dev": true, - "requires": { - "detect-newline": "^2.1.0" - } - }, - "jest-each": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/jest-each/-/jest-each-24.9.0.tgz", - "integrity": "sha512-ONi0R4BvW45cw8s2Lrx8YgbeXL1oCQ/wIDwmsM3CqM/nlblNCPmnC3IPQlMbRFZu3wKdQ2U8BqM6lh3LJ5Bsog==", - "dev": true, - "requires": { - "@jest/types": "^24.9.0", - "chalk": "^2.0.1", - "jest-get-type": "^24.9.0", - "jest-util": "^24.9.0", - "pretty-format": "^24.9.0" - } - }, "jest-environment-jsdom": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/jest-environment-jsdom/-/jest-environment-jsdom-24.9.0.tgz", - "integrity": "sha512-Zv9FV9NBRzLuALXjvRijO2351DRQeLYXtpD4xNvfoVFw21IOKNhZAEUKcbiEtjTkm2GsJ3boMVgkaR7rN8qetA==", + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/jest-environment-jsdom/-/jest-environment-jsdom-25.1.0.tgz", + "integrity": "sha512-ILb4wdrwPAOHX6W82GGDUiaXSSOE274ciuov0lztOIymTChKFtC02ddyicRRCdZlB5YSrv3vzr1Z5xjpEe1OHQ==", "dev": true, "requires": { - "@jest/environment": "^24.9.0", - "@jest/fake-timers": "^24.9.0", - "@jest/types": "^24.9.0", - "jest-mock": "^24.9.0", - "jest-util": "^24.9.0", - "jsdom": "^11.5.1" + "@jest/environment": "^25.1.0", + "@jest/fake-timers": "^25.1.0", + "@jest/types": "^25.1.0", + "jest-mock": "^25.1.0", + "jest-util": "^25.1.0", + "jsdom": "^15.1.1" } }, "jest-environment-node": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/jest-environment-node/-/jest-environment-node-24.9.0.tgz", - "integrity": "sha512-6d4V2f4nxzIzwendo27Tr0aFm+IXWa0XEUnaH6nU0FMaozxovt+sfRvh4J47wL1OvF83I3SSTu0XK+i4Bqe7uA==", + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/jest-environment-node/-/jest-environment-node-25.1.0.tgz", + "integrity": "sha512-U9kFWTtAPvhgYY5upnH9rq8qZkj6mYLup5l1caAjjx9uNnkLHN2xgZy5mo4SyLdmrh/EtB9UPpKFShvfQHD0Iw==", "dev": true, "requires": { - "@jest/environment": "^24.9.0", - "@jest/fake-timers": "^24.9.0", - "@jest/types": "^24.9.0", - "jest-mock": "^24.9.0", - "jest-util": "^24.9.0" + "@jest/environment": "^25.1.0", + "@jest/fake-timers": "^25.1.0", + "@jest/types": "^25.1.0", + "jest-mock": "^25.1.0", + "jest-util": "^25.1.0" } }, "jest-get-type": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/jest-get-type/-/jest-get-type-24.9.0.tgz", - "integrity": "sha512-lUseMzAley4LhIcpSP9Jf+fTrQ4a1yHQwLNeeVa2cEmbCGeoZAtYPOIv8JaxLD/sUpKxetKGP+gsHl8f8TSj8Q==", + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/jest-get-type/-/jest-get-type-25.1.0.tgz", + "integrity": "sha512-yWkBnT+5tMr8ANB6V+OjmrIJufHtCAqI5ic2H40v+tRqxDmE0PGnIiTyvRWFOMtmVHYpwRqyazDbTnhpjsGvLw==", "dev": true }, "jest-haste-map": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/jest-haste-map/-/jest-haste-map-24.9.0.tgz", - "integrity": "sha512-kfVFmsuWui2Sj1Rp1AJ4D9HqJwE4uwTlS/vO+eRUaMmd54BFpli2XhMQnPC2k4cHFVbB2Q2C+jtI1AGLgEnCjQ==", + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/jest-haste-map/-/jest-haste-map-25.1.0.tgz", + "integrity": "sha512-/2oYINIdnQZAqyWSn1GTku571aAfs8NxzSErGek65Iu5o8JYb+113bZysRMcC/pjE5v9w0Yz+ldbj9NxrFyPyw==", "dev": true, "requires": { - "@jest/types": "^24.9.0", - "anymatch": "^2.0.0", + "@jest/types": "^25.1.0", + "anymatch": "^3.0.3", "fb-watchman": "^2.0.0", - "fsevents": "^1.2.7", - "graceful-fs": "^4.1.15", - "invariant": "^2.2.4", - "jest-serializer": "^24.9.0", - "jest-util": "^24.9.0", - "jest-worker": "^24.9.0", - "micromatch": "^3.1.10", + "fsevents": "^2.1.2", + "graceful-fs": "^4.2.3", + "jest-serializer": "^25.1.0", + "jest-util": "^25.1.0", + "jest-worker": "^25.1.0", + "micromatch": "^4.0.2", "sane": "^4.0.3", "walker": "^1.0.7" + }, + "dependencies": { + "braces": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz", + "integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==", + "dev": true, + "requires": { + "fill-range": "^7.0.1" + } + }, + "fill-range": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz", + "integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==", + "dev": true, + "requires": { + "to-regex-range": "^5.0.1" + } + }, + "is-number": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", + "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", + "dev": true + }, + "micromatch": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.2.tgz", + "integrity": "sha512-y7FpHSbMUMoyPbYUSzO6PaZ6FyRnQOpHuKwbo1G+Knck95XVU4QAiKdGEnj5wwoS7PlOgthX/09u5iFJ+aYf5Q==", + "dev": true, + "requires": { + "braces": "^3.0.1", + "picomatch": "^2.0.5" + } + }, + "to-regex-range": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", + "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", + "dev": true, + "requires": { + "is-number": "^7.0.0" + } + } } }, "jest-jasmine2": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/jest-jasmine2/-/jest-jasmine2-24.9.0.tgz", - "integrity": "sha512-Cq7vkAgaYKp+PsX+2/JbTarrk0DmNhsEtqBXNwUHkdlbrTBLtMJINADf2mf5FkowNsq8evbPc07/qFO0AdKTzw==", + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/jest-jasmine2/-/jest-jasmine2-25.1.0.tgz", + "integrity": "sha512-GdncRq7jJ7sNIQ+dnXvpKO2MyP6j3naNK41DTTjEAhLEdpImaDA9zSAZwDhijjSF/D7cf4O5fdyUApGBZleaEg==", "dev": true, "requires": { "@babel/traverse": "^7.1.0", - "@jest/environment": "^24.9.0", - "@jest/test-result": "^24.9.0", - "@jest/types": "^24.9.0", - "chalk": "^2.0.1", + "@jest/environment": "^25.1.0", + "@jest/source-map": "^25.1.0", + "@jest/test-result": "^25.1.0", + "@jest/types": "^25.1.0", + "chalk": "^3.0.0", "co": "^4.6.0", - "expect": "^24.9.0", + "expect": "^25.1.0", "is-generator-fn": "^2.0.0", - "jest-each": "^24.9.0", - "jest-matcher-utils": "^24.9.0", - "jest-message-util": "^24.9.0", - "jest-runtime": "^24.9.0", - "jest-snapshot": "^24.9.0", - "jest-util": "^24.9.0", - "pretty-format": "^24.9.0", - "throat": "^4.0.0" + "jest-each": "^25.1.0", + "jest-matcher-utils": "^25.1.0", + "jest-message-util": "^25.1.0", + "jest-runtime": "^25.1.0", + "jest-snapshot": "^25.1.0", + "jest-util": "^25.1.0", + "pretty-format": "^25.1.0", + "throat": "^5.0.0" + }, + "dependencies": { + "ansi-styles": { + "version": "4.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.2.1.tgz", + "integrity": "sha512-9VGjrMsG1vePxcSweQsN20KY/c4zN0h9fLjqAbwbPfahM3t+NL+M9HC8xeXG2I8pX5NoamTGNuomEUFI7fcUjA==", + "dev": true, + "requires": { + "@types/color-name": "^1.1.1", + "color-convert": "^2.0.1" + } + }, + "chalk": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-3.0.0.tgz", + "integrity": "sha512-4D3B6Wf41KOYRFdszmDqMCGq5VV/uMAB273JILmO+3jAlh8X4qDtdtgCR3fxtbLEMzSx22QdhnDcJvu2u1fVwg==", + "dev": true, + "requires": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + } + }, + "color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "requires": { + "color-name": "~1.1.4" + } + }, + "color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + }, + "has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true + }, + "supports-color": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.1.0.tgz", + "integrity": "sha512-oRSIpR8pxT1Wr2FquTNnGet79b3BWljqOuoW/h4oBhxJ/HUbX5nX6JSruTkvXDCFMwDPvsaTTbvMLKZWSy0R5g==", + "dev": true, + "requires": { + "has-flag": "^4.0.0" + } + } } }, "jest-leak-detector": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/jest-leak-detector/-/jest-leak-detector-24.9.0.tgz", - "integrity": "sha512-tYkFIDsiKTGwb2FG1w8hX9V0aUb2ot8zY/2nFg087dUageonw1zrLMP4W6zsRO59dPkTSKie+D4rhMuP9nRmrA==", + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/jest-leak-detector/-/jest-leak-detector-25.1.0.tgz", + "integrity": "sha512-3xRI264dnhGaMHRvkFyEKpDeaRzcEBhyNrOG5oT8xPxOyUAblIAQnpiR3QXu4wDor47MDTiHbiFcbypdLcLW5w==", "dev": true, "requires": { - "jest-get-type": "^24.9.0", - "pretty-format": "^24.9.0" + "jest-get-type": "^25.1.0", + "pretty-format": "^25.1.0" } }, "jest-matcher-utils": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/jest-matcher-utils/-/jest-matcher-utils-24.9.0.tgz", - "integrity": "sha512-OZz2IXsu6eaiMAwe67c1T+5tUAtQyQx27/EMEkbFAGiw52tB9em+uGbzpcgYVpA8wl0hlxKPZxrly4CXU/GjHA==", + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/jest-matcher-utils/-/jest-matcher-utils-25.1.0.tgz", + "integrity": "sha512-KGOAFcSFbclXIFE7bS4C53iYobKI20ZWleAdAFun4W1Wz1Kkej8Ng6RRbhL8leaEvIOjGXhGf/a1JjO8bkxIWQ==", "dev": true, "requires": { - "chalk": "^2.0.1", - "jest-diff": "^24.9.0", - "jest-get-type": "^24.9.0", - "pretty-format": "^24.9.0" + "chalk": "^3.0.0", + "jest-diff": "^25.1.0", + "jest-get-type": "^25.1.0", + "pretty-format": "^25.1.0" + }, + "dependencies": { + "ansi-styles": { + "version": "4.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.2.1.tgz", + "integrity": "sha512-9VGjrMsG1vePxcSweQsN20KY/c4zN0h9fLjqAbwbPfahM3t+NL+M9HC8xeXG2I8pX5NoamTGNuomEUFI7fcUjA==", + "dev": true, + "requires": { + "@types/color-name": "^1.1.1", + "color-convert": "^2.0.1" + } + }, + "chalk": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-3.0.0.tgz", + "integrity": "sha512-4D3B6Wf41KOYRFdszmDqMCGq5VV/uMAB273JILmO+3jAlh8X4qDtdtgCR3fxtbLEMzSx22QdhnDcJvu2u1fVwg==", + "dev": true, + "requires": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + } + }, + "color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "requires": { + "color-name": "~1.1.4" + } + }, + "color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + }, + "has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true + }, + "supports-color": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.1.0.tgz", + "integrity": "sha512-oRSIpR8pxT1Wr2FquTNnGet79b3BWljqOuoW/h4oBhxJ/HUbX5nX6JSruTkvXDCFMwDPvsaTTbvMLKZWSy0R5g==", + "dev": true, + "requires": { + "has-flag": "^4.0.0" + } + } } }, "jest-message-util": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-24.9.0.tgz", - "integrity": "sha512-oCj8FiZ3U0hTP4aSui87P4L4jC37BtQwUMqk+zk/b11FR19BJDeZsZAvIHutWnmtw7r85UmR3CEWZ0HWU2mAlw==", + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/jest-message-util/-/jest-message-util-25.1.0.tgz", + "integrity": "sha512-Nr/Iwar2COfN22aCqX0kCVbXgn8IBm9nWf4xwGr5Olv/KZh0CZ32RKgZWMVDXGdOahicM10/fgjdimGNX/ttCQ==", "dev": true, "requires": { "@babel/code-frame": "^7.0.0", - "@jest/test-result": "^24.9.0", - "@jest/types": "^24.9.0", + "@jest/test-result": "^25.1.0", + "@jest/types": "^25.1.0", "@types/stack-utils": "^1.0.1", - "chalk": "^2.0.1", - "micromatch": "^3.1.10", - "slash": "^2.0.0", + "chalk": "^3.0.0", + "micromatch": "^4.0.2", + "slash": "^3.0.0", "stack-utils": "^1.0.1" + }, + "dependencies": { + "ansi-styles": { + "version": "4.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.2.1.tgz", + "integrity": "sha512-9VGjrMsG1vePxcSweQsN20KY/c4zN0h9fLjqAbwbPfahM3t+NL+M9HC8xeXG2I8pX5NoamTGNuomEUFI7fcUjA==", + "dev": true, + "requires": { + "@types/color-name": "^1.1.1", + "color-convert": "^2.0.1" + } + }, + "braces": { + "version": "3.0.2", + "resolved": "https://registry.npmjs.org/braces/-/braces-3.0.2.tgz", + "integrity": "sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==", + "dev": true, + "requires": { + "fill-range": "^7.0.1" + } + }, + "chalk": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-3.0.0.tgz", + "integrity": "sha512-4D3B6Wf41KOYRFdszmDqMCGq5VV/uMAB273JILmO+3jAlh8X4qDtdtgCR3fxtbLEMzSx22QdhnDcJvu2u1fVwg==", + "dev": true, + "requires": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + } + }, + "color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "requires": { + "color-name": "~1.1.4" + } + }, + "color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + }, + "fill-range": { + "version": "7.0.1", + "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz", + "integrity": "sha512-qOo9F+dMUmC2Lcb4BbVvnKJxTPjCm+RRpe4gDuGrzkL7mEVl/djYSu2OdQ2Pa302N4oqkSg9ir6jaLWJ2USVpQ==", + "dev": true, + "requires": { + "to-regex-range": "^5.0.1" + } + }, + "has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true + }, + "is-number": { + "version": "7.0.0", + "resolved": "https://registry.npmjs.org/is-number/-/is-number-7.0.0.tgz", + "integrity": "sha512-41Cifkg6e8TylSpdtTpeLVMqvSBEVzTttHvERD741+pnZ8ANv0004MRL43QKPDlK9cGvNp6NZWZUBlbGXYxxng==", + "dev": true + }, + "micromatch": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/micromatch/-/micromatch-4.0.2.tgz", + "integrity": "sha512-y7FpHSbMUMoyPbYUSzO6PaZ6FyRnQOpHuKwbo1G+Knck95XVU4QAiKdGEnj5wwoS7PlOgthX/09u5iFJ+aYf5Q==", + "dev": true, + "requires": { + "braces": "^3.0.1", + "picomatch": "^2.0.5" + } + }, + "supports-color": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.1.0.tgz", + "integrity": "sha512-oRSIpR8pxT1Wr2FquTNnGet79b3BWljqOuoW/h4oBhxJ/HUbX5nX6JSruTkvXDCFMwDPvsaTTbvMLKZWSy0R5g==", + "dev": true, + "requires": { + "has-flag": "^4.0.0" + } + }, + "to-regex-range": { + "version": "5.0.1", + "resolved": "https://registry.npmjs.org/to-regex-range/-/to-regex-range-5.0.1.tgz", + "integrity": "sha512-65P7iz6X5yEr1cwcgvQxbbIw7Uk3gOy5dIdtZ4rDveLqhrdJP+Li/Hx6tyK0NEb+2GCyneCMJiGqrADCSNk8sQ==", + "dev": true, + "requires": { + "is-number": "^7.0.0" + } + } } }, "jest-mock": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/jest-mock/-/jest-mock-24.9.0.tgz", - "integrity": "sha512-3BEYN5WbSq9wd+SyLDES7AHnjH9A/ROBwmz7l2y+ol+NtSFO8DYiEBzoO1CeFc9a8DYy10EO4dDFVv/wN3zl1w==", + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/jest-mock/-/jest-mock-25.1.0.tgz", + "integrity": "sha512-28/u0sqS+42vIfcd1mlcg4ZVDmSUYuNvImP4X2lX5hRMLW+CN0BeiKVD4p+ujKKbSPKd3rg/zuhCF+QBLJ4vag==", "dev": true, "requires": { - "@jest/types": "^24.9.0" + "@jest/types": "^25.1.0" } }, "jest-pnp-resolver": { @@ -6267,224 +7814,555 @@ "dev": true }, "jest-regex-util": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/jest-regex-util/-/jest-regex-util-24.9.0.tgz", - "integrity": "sha512-05Cmb6CuxaA+Ys6fjr3PhvV3bGQmO+2p2La4hFbU+W5uOc479f7FdLXUWXw4pYMAhhSZIuKHwSXSu6CsSBAXQA==", + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/jest-regex-util/-/jest-regex-util-25.1.0.tgz", + "integrity": "sha512-9lShaDmDpqwg+xAd73zHydKrBbbrIi08Kk9YryBEBybQFg/lBWR/2BDjjiSE7KIppM9C5+c03XiDaZ+m4Pgs1w==", "dev": true }, "jest-resolve": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/jest-resolve/-/jest-resolve-24.9.0.tgz", - "integrity": "sha512-TaLeLVL1l08YFZAt3zaPtjiVvyy4oSA6CRe+0AFPPVX3Q/VI0giIWWoAvoS5L96vj9Dqxj4fB5p2qrHCmTU/MQ==", + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/jest-resolve/-/jest-resolve-25.1.0.tgz", + "integrity": "sha512-XkBQaU1SRCHj2Evz2Lu4Czs+uIgJXWypfO57L7JYccmAXv4slXA6hzNblmcRmf7P3cQ1mE7fL3ABV6jAwk4foQ==", "dev": true, "requires": { - "@jest/types": "^24.9.0", + "@jest/types": "^25.1.0", "browser-resolve": "^1.11.3", - "chalk": "^2.0.1", + "chalk": "^3.0.0", "jest-pnp-resolver": "^1.2.1", "realpath-native": "^1.1.0" + }, + "dependencies": { + "ansi-styles": { + "version": "4.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.2.1.tgz", + "integrity": "sha512-9VGjrMsG1vePxcSweQsN20KY/c4zN0h9fLjqAbwbPfahM3t+NL+M9HC8xeXG2I8pX5NoamTGNuomEUFI7fcUjA==", + "dev": true, + "requires": { + "@types/color-name": "^1.1.1", + "color-convert": "^2.0.1" + } + }, + "chalk": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-3.0.0.tgz", + "integrity": "sha512-4D3B6Wf41KOYRFdszmDqMCGq5VV/uMAB273JILmO+3jAlh8X4qDtdtgCR3fxtbLEMzSx22QdhnDcJvu2u1fVwg==", + "dev": true, + "requires": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + } + }, + "color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "requires": { + "color-name": "~1.1.4" + } + }, + "color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + }, + "has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true + }, + "supports-color": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.1.0.tgz", + "integrity": "sha512-oRSIpR8pxT1Wr2FquTNnGet79b3BWljqOuoW/h4oBhxJ/HUbX5nX6JSruTkvXDCFMwDPvsaTTbvMLKZWSy0R5g==", + "dev": true, + "requires": { + "has-flag": "^4.0.0" + } + } } }, "jest-resolve-dependencies": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/jest-resolve-dependencies/-/jest-resolve-dependencies-24.9.0.tgz", - "integrity": "sha512-Fm7b6AlWnYhT0BXy4hXpactHIqER7erNgIsIozDXWl5dVm+k8XdGVe1oTg1JyaFnOxarMEbax3wyRJqGP2Pq+g==", + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/jest-resolve-dependencies/-/jest-resolve-dependencies-25.1.0.tgz", + "integrity": "sha512-Cu/Je38GSsccNy4I2vL12ZnBlD170x2Oh1devzuM9TLH5rrnLW1x51lN8kpZLYTvzx9j+77Y5pqBaTqfdzVzrw==", "dev": true, "requires": { - "@jest/types": "^24.9.0", - "jest-regex-util": "^24.3.0", - "jest-snapshot": "^24.9.0" + "@jest/types": "^25.1.0", + "jest-regex-util": "^25.1.0", + "jest-snapshot": "^25.1.0" } }, "jest-runner": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/jest-runner/-/jest-runner-24.9.0.tgz", - "integrity": "sha512-KksJQyI3/0mhcfspnxxEOBueGrd5E4vV7ADQLT9ESaCzz02WnbdbKWIf5Mkaucoaj7obQckYPVX6JJhgUcoWWg==", + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/jest-runner/-/jest-runner-25.1.0.tgz", + "integrity": "sha512-su3O5fy0ehwgt+e8Wy7A8CaxxAOCMzL4gUBftSs0Ip32S0epxyZPDov9Znvkl1nhVOJNf4UwAsnqfc3plfQH9w==", "dev": true, "requires": { - "@jest/console": "^24.7.1", - "@jest/environment": "^24.9.0", - "@jest/test-result": "^24.9.0", - "@jest/types": "^24.9.0", - "chalk": "^2.4.2", + "@jest/console": "^25.1.0", + "@jest/environment": "^25.1.0", + "@jest/test-result": "^25.1.0", + "@jest/types": "^25.1.0", + "chalk": "^3.0.0", "exit": "^0.1.2", - "graceful-fs": "^4.1.15", - "jest-config": "^24.9.0", - "jest-docblock": "^24.3.0", - "jest-haste-map": "^24.9.0", - "jest-jasmine2": "^24.9.0", - "jest-leak-detector": "^24.9.0", - "jest-message-util": "^24.9.0", - "jest-resolve": "^24.9.0", - "jest-runtime": "^24.9.0", - "jest-util": "^24.9.0", - "jest-worker": "^24.6.0", + "graceful-fs": "^4.2.3", + "jest-config": "^25.1.0", + "jest-docblock": "^25.1.0", + "jest-haste-map": "^25.1.0", + "jest-jasmine2": "^25.1.0", + "jest-leak-detector": "^25.1.0", + "jest-message-util": "^25.1.0", + "jest-resolve": "^25.1.0", + "jest-runtime": "^25.1.0", + "jest-util": "^25.1.0", + "jest-worker": "^25.1.0", "source-map-support": "^0.5.6", - "throat": "^4.0.0" + "throat": "^5.0.0" + }, + "dependencies": { + "ansi-styles": { + "version": "4.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.2.1.tgz", + "integrity": "sha512-9VGjrMsG1vePxcSweQsN20KY/c4zN0h9fLjqAbwbPfahM3t+NL+M9HC8xeXG2I8pX5NoamTGNuomEUFI7fcUjA==", + "dev": true, + "requires": { + "@types/color-name": "^1.1.1", + "color-convert": "^2.0.1" + } + }, + "chalk": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-3.0.0.tgz", + "integrity": "sha512-4D3B6Wf41KOYRFdszmDqMCGq5VV/uMAB273JILmO+3jAlh8X4qDtdtgCR3fxtbLEMzSx22QdhnDcJvu2u1fVwg==", + "dev": true, + "requires": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + } + }, + "color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "requires": { + "color-name": "~1.1.4" + } + }, + "color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + }, + "has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true + }, + "supports-color": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.1.0.tgz", + "integrity": "sha512-oRSIpR8pxT1Wr2FquTNnGet79b3BWljqOuoW/h4oBhxJ/HUbX5nX6JSruTkvXDCFMwDPvsaTTbvMLKZWSy0R5g==", + "dev": true, + "requires": { + "has-flag": "^4.0.0" + } + } } }, "jest-runtime": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/jest-runtime/-/jest-runtime-24.9.0.tgz", - "integrity": "sha512-8oNqgnmF3v2J6PVRM2Jfuj8oX3syKmaynlDMMKQ4iyzbQzIG6th5ub/lM2bCMTmoTKM3ykcUYI2Pw9xwNtjMnw==", - "dev": true, - "requires": { - "@jest/console": "^24.7.1", - "@jest/environment": "^24.9.0", - "@jest/source-map": "^24.3.0", - "@jest/transform": "^24.9.0", - "@jest/types": "^24.9.0", - "@types/yargs": "^13.0.0", - "chalk": "^2.0.1", + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/jest-runtime/-/jest-runtime-25.1.0.tgz", + "integrity": "sha512-mpPYYEdbExKBIBB16ryF6FLZTc1Rbk9Nx0ryIpIMiDDkOeGa0jQOKVI/QeGvVGlunKKm62ywcioeFVzIbK03bA==", + "dev": true, + "requires": { + "@jest/console": "^25.1.0", + "@jest/environment": "^25.1.0", + "@jest/source-map": "^25.1.0", + "@jest/test-result": "^25.1.0", + "@jest/transform": "^25.1.0", + "@jest/types": "^25.1.0", + "@types/yargs": "^15.0.0", + "chalk": "^3.0.0", + "collect-v8-coverage": "^1.0.0", "exit": "^0.1.2", "glob": "^7.1.3", - "graceful-fs": "^4.1.15", - "jest-config": "^24.9.0", - "jest-haste-map": "^24.9.0", - "jest-message-util": "^24.9.0", - "jest-mock": "^24.9.0", - "jest-regex-util": "^24.3.0", - "jest-resolve": "^24.9.0", - "jest-snapshot": "^24.9.0", - "jest-util": "^24.9.0", - "jest-validate": "^24.9.0", + "graceful-fs": "^4.2.3", + "jest-config": "^25.1.0", + "jest-haste-map": "^25.1.0", + "jest-message-util": "^25.1.0", + "jest-mock": "^25.1.0", + "jest-regex-util": "^25.1.0", + "jest-resolve": "^25.1.0", + "jest-snapshot": "^25.1.0", + "jest-util": "^25.1.0", + "jest-validate": "^25.1.0", "realpath-native": "^1.1.0", - "slash": "^2.0.0", - "strip-bom": "^3.0.0", - "yargs": "^13.3.0" + "slash": "^3.0.0", + "strip-bom": "^4.0.0", + "yargs": "^15.0.0" }, "dependencies": { - "strip-bom": { + "ansi-styles": { + "version": "4.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.2.1.tgz", + "integrity": "sha512-9VGjrMsG1vePxcSweQsN20KY/c4zN0h9fLjqAbwbPfahM3t+NL+M9HC8xeXG2I8pX5NoamTGNuomEUFI7fcUjA==", + "dev": true, + "requires": { + "@types/color-name": "^1.1.1", + "color-convert": "^2.0.1" + } + }, + "chalk": { "version": "3.0.0", - "resolved": "https://registry.npmjs.org/strip-bom/-/strip-bom-3.0.0.tgz", - "integrity": "sha1-IzTBjpx1n3vdVv3vfprj1YjmjtM=", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-3.0.0.tgz", + "integrity": "sha512-4D3B6Wf41KOYRFdszmDqMCGq5VV/uMAB273JILmO+3jAlh8X4qDtdtgCR3fxtbLEMzSx22QdhnDcJvu2u1fVwg==", + "dev": true, + "requires": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + } + }, + "color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "requires": { + "color-name": "~1.1.4" + } + }, + "color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + }, + "has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", "dev": true + }, + "supports-color": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.1.0.tgz", + "integrity": "sha512-oRSIpR8pxT1Wr2FquTNnGet79b3BWljqOuoW/h4oBhxJ/HUbX5nX6JSruTkvXDCFMwDPvsaTTbvMLKZWSy0R5g==", + "dev": true, + "requires": { + "has-flag": "^4.0.0" + } } } }, "jest-serializer": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/jest-serializer/-/jest-serializer-24.9.0.tgz", - "integrity": "sha512-DxYipDr8OvfrKH3Kel6NdED3OXxjvxXZ1uIY2I9OFbGg+vUkkg7AGvi65qbhbWNPvDckXmzMPbK3u3HaDO49bQ==", + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/jest-serializer/-/jest-serializer-25.1.0.tgz", + "integrity": "sha512-20Wkq5j7o84kssBwvyuJ7Xhn7hdPeTXndnwIblKDR2/sy1SUm6rWWiG9kSCgJPIfkDScJCIsTtOKdlzfIHOfKA==", "dev": true }, "jest-snapshot": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/jest-snapshot/-/jest-snapshot-24.9.0.tgz", - "integrity": "sha512-uI/rszGSs73xCM0l+up7O7a40o90cnrk429LOiK3aeTvfC0HHmldbd81/B7Ix81KSFe1lwkbl7GnBGG4UfuDew==", + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/jest-snapshot/-/jest-snapshot-25.1.0.tgz", + "integrity": "sha512-xZ73dFYN8b/+X2hKLXz4VpBZGIAn7muD/DAg+pXtDzDGw3iIV10jM7WiHqhCcpDZfGiKEj7/2HXAEPtHTj0P2A==", "dev": true, "requires": { "@babel/types": "^7.0.0", - "@jest/types": "^24.9.0", - "chalk": "^2.0.1", - "expect": "^24.9.0", - "jest-diff": "^24.9.0", - "jest-get-type": "^24.9.0", - "jest-matcher-utils": "^24.9.0", - "jest-message-util": "^24.9.0", - "jest-resolve": "^24.9.0", + "@jest/types": "^25.1.0", + "chalk": "^3.0.0", + "expect": "^25.1.0", + "jest-diff": "^25.1.0", + "jest-get-type": "^25.1.0", + "jest-matcher-utils": "^25.1.0", + "jest-message-util": "^25.1.0", + "jest-resolve": "^25.1.0", "mkdirp": "^0.5.1", "natural-compare": "^1.4.0", - "pretty-format": "^24.9.0", - "semver": "^6.2.0" + "pretty-format": "^25.1.0", + "semver": "^7.1.1" }, "dependencies": { + "ansi-styles": { + "version": "4.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.2.1.tgz", + "integrity": "sha512-9VGjrMsG1vePxcSweQsN20KY/c4zN0h9fLjqAbwbPfahM3t+NL+M9HC8xeXG2I8pX5NoamTGNuomEUFI7fcUjA==", + "dev": true, + "requires": { + "@types/color-name": "^1.1.1", + "color-convert": "^2.0.1" + } + }, + "chalk": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-3.0.0.tgz", + "integrity": "sha512-4D3B6Wf41KOYRFdszmDqMCGq5VV/uMAB273JILmO+3jAlh8X4qDtdtgCR3fxtbLEMzSx22QdhnDcJvu2u1fVwg==", + "dev": true, + "requires": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + } + }, + "color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "requires": { + "color-name": "~1.1.4" + } + }, + "color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + }, + "has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true + }, "semver": { - "version": "6.3.0", - "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.0.tgz", - "integrity": "sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw==", + "version": "7.1.2", + "resolved": "https://registry.npmjs.org/semver/-/semver-7.1.2.tgz", + "integrity": "sha512-BJs9T/H8sEVHbeigqzIEo57Iu/3DG6c4QoqTfbQB3BPA4zgzAomh/Fk9E7QtjWQ8mx2dgA9YCfSF4y9k9bHNpQ==", "dev": true + }, + "supports-color": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.1.0.tgz", + "integrity": "sha512-oRSIpR8pxT1Wr2FquTNnGet79b3BWljqOuoW/h4oBhxJ/HUbX5nX6JSruTkvXDCFMwDPvsaTTbvMLKZWSy0R5g==", + "dev": true, + "requires": { + "has-flag": "^4.0.0" + } } } }, "jest-util": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-24.9.0.tgz", - "integrity": "sha512-x+cZU8VRmOJxbA1K5oDBdxQmdq0OIdADarLxk0Mq+3XS4jgvhG/oKGWcIDCtPG0HgjxOYvF+ilPJQsAyXfbNOg==", + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/jest-util/-/jest-util-25.1.0.tgz", + "integrity": "sha512-7did6pLQ++87Qsj26Fs/TIwZMUFBXQ+4XXSodRNy3luch2DnRXsSnmpVtxxQ0Yd6WTipGpbhh2IFP1mq6/fQGw==", "dev": true, "requires": { - "@jest/console": "^24.9.0", - "@jest/fake-timers": "^24.9.0", - "@jest/source-map": "^24.9.0", - "@jest/test-result": "^24.9.0", - "@jest/types": "^24.9.0", - "callsites": "^3.0.0", - "chalk": "^2.0.1", - "graceful-fs": "^4.1.15", + "@jest/types": "^25.1.0", + "chalk": "^3.0.0", "is-ci": "^2.0.0", - "mkdirp": "^0.5.1", - "slash": "^2.0.0", - "source-map": "^0.6.0" + "mkdirp": "^0.5.1" }, "dependencies": { - "callsites": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/callsites/-/callsites-3.1.0.tgz", - "integrity": "sha512-P8BjAsXvZS+VIDUI11hHCQEv74YT67YUi5JJFNWIqL235sBmjX4+qx9Muvls5ivyNENctx46xQLQ3aTuE7ssaQ==", + "ansi-styles": { + "version": "4.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.2.1.tgz", + "integrity": "sha512-9VGjrMsG1vePxcSweQsN20KY/c4zN0h9fLjqAbwbPfahM3t+NL+M9HC8xeXG2I8pX5NoamTGNuomEUFI7fcUjA==", + "dev": true, + "requires": { + "@types/color-name": "^1.1.1", + "color-convert": "^2.0.1" + } + }, + "chalk": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-3.0.0.tgz", + "integrity": "sha512-4D3B6Wf41KOYRFdszmDqMCGq5VV/uMAB273JILmO+3jAlh8X4qDtdtgCR3fxtbLEMzSx22QdhnDcJvu2u1fVwg==", + "dev": true, + "requires": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + } + }, + "color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "requires": { + "color-name": "~1.1.4" + } + }, + "color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + }, + "has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true + }, + "supports-color": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.1.0.tgz", + "integrity": "sha512-oRSIpR8pxT1Wr2FquTNnGet79b3BWljqOuoW/h4oBhxJ/HUbX5nX6JSruTkvXDCFMwDPvsaTTbvMLKZWSy0R5g==", + "dev": true, + "requires": { + "has-flag": "^4.0.0" + } + } + } + }, + "jest-validate": { + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/jest-validate/-/jest-validate-25.1.0.tgz", + "integrity": "sha512-kGbZq1f02/zVO2+t1KQGSVoCTERc5XeObLwITqC6BTRH3Adv7NZdYqCpKIZLUgpLXf2yISzQ465qOZpul8abXA==", + "dev": true, + "requires": { + "@jest/types": "^25.1.0", + "camelcase": "^5.3.1", + "chalk": "^3.0.0", + "jest-get-type": "^25.1.0", + "leven": "^3.1.0", + "pretty-format": "^25.1.0" + }, + "dependencies": { + "ansi-styles": { + "version": "4.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.2.1.tgz", + "integrity": "sha512-9VGjrMsG1vePxcSweQsN20KY/c4zN0h9fLjqAbwbPfahM3t+NL+M9HC8xeXG2I8pX5NoamTGNuomEUFI7fcUjA==", + "dev": true, + "requires": { + "@types/color-name": "^1.1.1", + "color-convert": "^2.0.1" + } + }, + "chalk": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-3.0.0.tgz", + "integrity": "sha512-4D3B6Wf41KOYRFdszmDqMCGq5VV/uMAB273JILmO+3jAlh8X4qDtdtgCR3fxtbLEMzSx22QdhnDcJvu2u1fVwg==", + "dev": true, + "requires": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + } + }, + "color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "requires": { + "color-name": "~1.1.4" + } + }, + "color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", "dev": true }, - "source-map": { - "version": "0.6.1", - "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", - "integrity": "sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==", + "has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", "dev": true + }, + "supports-color": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.1.0.tgz", + "integrity": "sha512-oRSIpR8pxT1Wr2FquTNnGet79b3BWljqOuoW/h4oBhxJ/HUbX5nX6JSruTkvXDCFMwDPvsaTTbvMLKZWSy0R5g==", + "dev": true, + "requires": { + "has-flag": "^4.0.0" + } } } }, - "jest-validate": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/jest-validate/-/jest-validate-24.9.0.tgz", - "integrity": "sha512-HPIt6C5ACwiqSiwi+OfSSHbK8sG7akG8eATl+IPKaeIjtPOeBUd/g3J7DghugzxrGjI93qS/+RPKe1H6PqvhRQ==", - "dev": true, - "requires": { - "@jest/types": "^24.9.0", - "camelcase": "^5.3.1", - "chalk": "^2.0.1", - "jest-get-type": "^24.9.0", - "leven": "^3.1.0", - "pretty-format": "^24.9.0" - } - }, "jest-watcher": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/jest-watcher/-/jest-watcher-24.9.0.tgz", - "integrity": "sha512-+/fLOfKPXXYJDYlks62/4R4GoT+GU1tYZed99JSCOsmzkkF7727RqKrjNAxtfO4YpGv11wybgRvCjR73lK2GZw==", + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/jest-watcher/-/jest-watcher-25.1.0.tgz", + "integrity": "sha512-Q9eZ7pyaIr6xfU24OeTg4z1fUqBF/4MP6J801lyQfg7CsnZ/TCzAPvCfckKdL5dlBBEKBeHV0AdyjFZ5eWj4ig==", "dev": true, "requires": { - "@jest/test-result": "^24.9.0", - "@jest/types": "^24.9.0", - "@types/yargs": "^13.0.0", - "ansi-escapes": "^3.0.0", - "chalk": "^2.0.1", - "jest-util": "^24.9.0", - "string-length": "^2.0.0" + "@jest/test-result": "^25.1.0", + "@jest/types": "^25.1.0", + "ansi-escapes": "^4.2.1", + "chalk": "^3.0.0", + "jest-util": "^25.1.0", + "string-length": "^3.1.0" }, "dependencies": { - "ansi-escapes": { - "version": "3.2.0", - "resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-3.2.0.tgz", - "integrity": "sha512-cBhpre4ma+U0T1oM5fXg7Dy1Jw7zzwv7lt/GoCpr+hDQJoYnKVPLL4dCvSEFMmQurOQvSrwT7SL/DAlhBI97RQ==", + "ansi-styles": { + "version": "4.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.2.1.tgz", + "integrity": "sha512-9VGjrMsG1vePxcSweQsN20KY/c4zN0h9fLjqAbwbPfahM3t+NL+M9HC8xeXG2I8pX5NoamTGNuomEUFI7fcUjA==", + "dev": true, + "requires": { + "@types/color-name": "^1.1.1", + "color-convert": "^2.0.1" + } + }, + "chalk": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/chalk/-/chalk-3.0.0.tgz", + "integrity": "sha512-4D3B6Wf41KOYRFdszmDqMCGq5VV/uMAB273JILmO+3jAlh8X4qDtdtgCR3fxtbLEMzSx22QdhnDcJvu2u1fVwg==", + "dev": true, + "requires": { + "ansi-styles": "^4.1.0", + "supports-color": "^7.1.0" + } + }, + "color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "requires": { + "color-name": "~1.1.4" + } + }, + "color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + }, + "has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", "dev": true + }, + "supports-color": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.1.0.tgz", + "integrity": "sha512-oRSIpR8pxT1Wr2FquTNnGet79b3BWljqOuoW/h4oBhxJ/HUbX5nX6JSruTkvXDCFMwDPvsaTTbvMLKZWSy0R5g==", + "dev": true, + "requires": { + "has-flag": "^4.0.0" + } } } }, "jest-worker": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/jest-worker/-/jest-worker-24.9.0.tgz", - "integrity": "sha512-51PE4haMSXcHohnSMdM42anbvZANYTqMrr52tVKPqqsPJMzoP6FYYDVqahX/HrAoKEKz3uUPzSvKs9A3qR4iVw==", + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/jest-worker/-/jest-worker-25.1.0.tgz", + "integrity": "sha512-ZHhHtlxOWSxCoNOKHGbiLzXnl42ga9CxDr27H36Qn+15pQZd3R/F24jrmjDelw9j/iHUIWMWs08/u2QN50HHOg==", "dev": true, "requires": { "merge-stream": "^2.0.0", - "supports-color": "^6.1.0" + "supports-color": "^7.0.0" }, "dependencies": { + "has-flag": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/has-flag/-/has-flag-4.0.0.tgz", + "integrity": "sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ==", + "dev": true + }, "supports-color": { - "version": "6.1.0", - "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-6.1.0.tgz", - "integrity": "sha512-qe1jfm1Mg7Nq/NSh6XE24gPXROEVsWHxC1LIx//XNlD9iw7YZQGjZNjYN7xGaEG6iKdA8EtNFW6R0gjnVXp+wQ==", + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/supports-color/-/supports-color-7.1.0.tgz", + "integrity": "sha512-oRSIpR8pxT1Wr2FquTNnGet79b3BWljqOuoW/h4oBhxJ/HUbX5nX6JSruTkvXDCFMwDPvsaTTbvMLKZWSy0R5g==", "dev": true, "requires": { - "has-flag": "^3.0.0" + "has-flag": "^4.0.0" } } } @@ -6518,44 +8396,49 @@ "dev": true }, "jsdom": { - "version": "11.12.0", - "resolved": "https://registry.npmjs.org/jsdom/-/jsdom-11.12.0.tgz", - "integrity": "sha512-y8Px43oyiBM13Zc1z780FrfNLJCXTL40EWlty/LXUtcjykRBNgLlCjWXpfSPBl2iv+N7koQN+dvqszHZgT/Fjw==", + "version": "15.2.1", + "resolved": "https://registry.npmjs.org/jsdom/-/jsdom-15.2.1.tgz", + "integrity": "sha512-fAl1W0/7T2G5vURSyxBzrJ1LSdQn6Tr5UX/xD4PXDx/PDgwygedfW6El/KIj3xJ7FU61TTYnc/l/B7P49Eqt6g==", "dev": true, "requires": { "abab": "^2.0.0", - "acorn": "^5.5.3", - "acorn-globals": "^4.1.0", + "acorn": "^7.1.0", + "acorn-globals": "^4.3.2", "array-equal": "^1.0.0", - "cssom": ">= 0.3.2 < 0.4.0", - "cssstyle": "^1.0.0", - "data-urls": "^1.0.0", + "cssom": "^0.4.1", + "cssstyle": "^2.0.0", + "data-urls": "^1.1.0", "domexception": "^1.0.1", - "escodegen": "^1.9.1", + "escodegen": "^1.11.1", "html-encoding-sniffer": "^1.0.2", - "left-pad": "^1.3.0", - "nwsapi": "^2.0.7", - "parse5": "4.0.0", + "nwsapi": "^2.2.0", + "parse5": "5.1.0", "pn": "^1.1.0", - "request": "^2.87.0", - "request-promise-native": "^1.0.5", - "sax": "^1.2.4", + "request": "^2.88.0", + "request-promise-native": "^1.0.7", + "saxes": "^3.1.9", "symbol-tree": "^3.2.2", - "tough-cookie": "^2.3.4", + "tough-cookie": "^3.0.1", "w3c-hr-time": "^1.0.1", + "w3c-xmlserializer": "^1.1.2", "webidl-conversions": "^4.0.2", - "whatwg-encoding": "^1.0.3", - "whatwg-mimetype": "^2.1.0", - "whatwg-url": "^6.4.1", - "ws": "^5.2.0", + "whatwg-encoding": "^1.0.5", + "whatwg-mimetype": "^2.3.0", + "whatwg-url": "^7.0.0", + "ws": "^7.0.0", "xml-name-validator": "^3.0.0" }, "dependencies": { - "acorn": { - "version": "5.7.3", - "resolved": "https://registry.npmjs.org/acorn/-/acorn-5.7.3.tgz", - "integrity": "sha512-T/zvzYRfbVojPWahDsE5evJdHb3oJoQfFbsrKM7w5Zcs++Tr257tia3BmMP8XYVjp1S9RZXQMh7gao96BlqZOw==", - "dev": true + "whatwg-url": { + "version": "7.1.0", + "resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-7.1.0.tgz", + "integrity": "sha512-WUu7Rg1DroM7oQvGWfOiAK21n74Gg+T4elXEQYkOhtyLeWiJFoOGLXPKI/9gzIie9CtwVLm8wtw6YJdKyxSjeg==", + "dev": true, + "requires": { + "lodash.sortby": "^4.7.0", + "tr46": "^1.0.1", + "webidl-conversions": "^4.0.2" + } } } }, @@ -6669,12 +8552,6 @@ "package-json": "^6.3.0" } }, - "left-pad": { - "version": "1.3.0", - "resolved": "https://registry.npmjs.org/left-pad/-/left-pad-1.3.0.tgz", - "integrity": "sha512-XI5MPzVNApjAyhQzphX8BkmKsKUxD4LdyK24iZeQGinBN9yTQT3bFlCBy/aVx2HrNcqQGsdot8ghrjyrvMCoEA==", - "dev": true - }, "leven": { "version": "3.1.0", "resolved": "https://registry.npmjs.org/leven/-/leven-3.1.0.tgz", @@ -7207,6 +9084,15 @@ } } }, + "lolex": { + "version": "5.1.2", + "resolved": "https://registry.npmjs.org/lolex/-/lolex-5.1.2.tgz", + "integrity": "sha512-h4hmjAvHTmd+25JSwrtTIuwbKdwg5NzZVRMLn9saij4SZaepCrTCxPr35H/3bjwfMJtN+t3CX8672UIkglz28A==", + "dev": true, + "requires": { + "@sinonjs/commons": "^1.7.0" + } + }, "loose-envify": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/loose-envify/-/loose-envify-1.4.0.tgz", @@ -7464,18 +9350,18 @@ "dev": true }, "mime-db": { - "version": "1.40.0", - "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.40.0.tgz", - "integrity": "sha512-jYdeOMPy9vnxEqFRRo6ZvTZ8d9oPb+k18PKoYNYUe2stVEBPPwsln/qWzdbmaIvnhZ9v2P+CuecK+fpUfsV2mA==", + "version": "1.43.0", + "resolved": "https://registry.npmjs.org/mime-db/-/mime-db-1.43.0.tgz", + "integrity": "sha512-+5dsGEEovYbT8UY9yD7eE4XTc4UwJ1jBYlgaQQF38ENsKR3wj/8q8RFZrF9WIZpB2V1ArTVFUva8sAul1NzRzQ==", "dev": true }, "mime-types": { - "version": "2.1.24", - "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.24.tgz", - "integrity": "sha512-WaFHS3MCl5fapm3oLxU4eYDw77IQM2ACcxQ9RIxfaC3ooc6PFuBMGZZsYpvoXS5D5QTWPieo1jjLdAm3TBP3cQ==", + "version": "2.1.26", + "resolved": "https://registry.npmjs.org/mime-types/-/mime-types-2.1.26.tgz", + "integrity": "sha512-01paPWYgLrkqAyrlDorC1uDwl2p3qZT7yl806vW7DvDoxwXi46jsjFbg+WdwotBIk6/MbEhO/dh5aZ5sNj/dWQ==", "dev": true, "requires": { - "mime-db": "1.40.0" + "mime-db": "1.43.0" } }, "mimic-fn": { @@ -7584,13 +9470,6 @@ "integrity": "sha512-nnbWWOkoWyUsTjKrhgD0dcz22mdkSnpYqbEjIm2nhwhuxlSkpywJmBo8h0ZqJdkp73mb90SssHkN4rsRaBAfAA==", "dev": true }, - "nan": { - "version": "2.14.0", - "resolved": "https://registry.npmjs.org/nan/-/nan-2.14.0.tgz", - "integrity": "sha512-INOFj37C7k3AfaNTtX8RhsTw7qRy7eLET14cROi9+5HAVbbHuIWUHEauBv5qT4Av2tWasiTY1Jw6puUNqRJXQg==", - "dev": true, - "optional": true - }, "nanomatch": { "version": "1.2.13", "resolved": "https://registry.npmjs.org/nanomatch/-/nanomatch-1.2.13.tgz", @@ -7662,22 +9541,39 @@ "dev": true }, "node-notifier": { - "version": "5.4.3", - "resolved": "https://registry.npmjs.org/node-notifier/-/node-notifier-5.4.3.tgz", - "integrity": "sha512-M4UBGcs4jeOK9CjTsYwkvH6/MzuUmGCyTW+kCY7uO+1ZVr0+FHGdPdIf5CCLqAaxnRrWidyoQlNkMIIVwbKB8Q==", + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/node-notifier/-/node-notifier-6.0.0.tgz", + "integrity": "sha512-SVfQ/wMw+DesunOm5cKqr6yDcvUTDl/yc97ybGHMrteNEY6oekXpNpS3lZwgLlwz0FLgHoiW28ZpmBHUDg37cw==", "dev": true, + "optional": true, "requires": { "growly": "^1.3.0", - "is-wsl": "^1.1.0", - "semver": "^5.5.0", + "is-wsl": "^2.1.1", + "semver": "^6.3.0", "shellwords": "^0.1.1", - "which": "^1.3.0" + "which": "^1.3.1" + }, + "dependencies": { + "is-wsl": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/is-wsl/-/is-wsl-2.1.1.tgz", + "integrity": "sha512-umZHcSrwlDHo2TGMXv0DZ8dIUGunZ2Iv68YZnrmCiBPkZ4aaOhtv7pXJKeki9k3qJ3RJr0cDyitcl5wEH3AYog==", + "dev": true, + "optional": true + }, + "semver": { + "version": "6.3.0", + "resolved": "https://registry.npmjs.org/semver/-/semver-6.3.0.tgz", + "integrity": "sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw==", + "dev": true, + "optional": true + } } }, "node-releases": { - "version": "1.1.39", - "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-1.1.39.tgz", - "integrity": "sha512-8MRC/ErwNCHOlAFycy9OPca46fQYUjbJRDcZTHVWIGXIjYLM73k70vv3WkYutVnM4cCo4hE0MqBVVZjP6vjISA==", + "version": "1.1.41", + "resolved": "https://registry.npmjs.org/node-releases/-/node-releases-1.1.41.tgz", + "integrity": "sha512-+IctMa7wIs8Cfsa8iYzeaLTFwv5Y4r5jZud+4AnfymzeEXKBCavFX0KBgzVaPVqf0ywa6PrO8/b+bPqdwjGBSg==", "dev": true, "requires": { "semver": "^6.3.0" @@ -7712,13 +9608,10 @@ } }, "normalize-path": { - "version": "2.1.1", - "resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-2.1.1.tgz", - "integrity": "sha1-GrKLVW4Zg2Oowab35vogE3/mrtk=", - "dev": true, - "requires": { - "remove-trailing-separator": "^1.0.1" - } + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-3.0.0.tgz", + "integrity": "sha512-6eZs5Ls3WtCisHWp9S2GUy8dqkpGi4BVSz3GaqiE6ezub0512ESztXUwUB6C6IKbQkY2Pnb/mD4WYojCRwcwLA==", + "dev": true }, "normalize-url": { "version": "4.5.0", @@ -11498,13 +13391,81 @@ } }, "object.getownpropertydescriptors": { - "version": "2.0.3", - "resolved": "https://registry.npmjs.org/object.getownpropertydescriptors/-/object.getownpropertydescriptors-2.0.3.tgz", - "integrity": "sha1-h1jIRvW0B62rDyNuCYbxSwUcqhY=", + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/object.getownpropertydescriptors/-/object.getownpropertydescriptors-2.1.0.tgz", + "integrity": "sha512-Z53Oah9A3TdLoblT7VKJaTDdXdT+lQO+cNpKVnya5JDe9uLvzu1YyY1yFDFrcxrlRgWrEFH0jJtD/IbuwjcEVg==", "dev": true, "requires": { - "define-properties": "^1.1.2", - "es-abstract": "^1.5.1" + "define-properties": "^1.1.3", + "es-abstract": "^1.17.0-next.1" + }, + "dependencies": { + "es-abstract": { + "version": "1.17.4", + "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.17.4.tgz", + "integrity": "sha512-Ae3um/gb8F0mui/jPL+QiqmglkUsaQf7FwBEHYIFkztkneosu9imhqHpBzQ3h1vit8t5iQ74t6PEVvphBZiuiQ==", + "dev": true, + "requires": { + "es-to-primitive": "^1.2.1", + "function-bind": "^1.1.1", + "has": "^1.0.3", + "has-symbols": "^1.0.1", + "is-callable": "^1.1.5", + "is-regex": "^1.0.5", + "object-inspect": "^1.7.0", + "object-keys": "^1.1.1", + "object.assign": "^4.1.0", + "string.prototype.trimleft": "^2.1.1", + "string.prototype.trimright": "^2.1.1" + } + }, + "has-symbols": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.1.tgz", + "integrity": "sha512-PLcsoqu++dmEIZB+6totNFKq/7Do+Z0u4oT0zKOJNl3lYK6vGwwu2hjHs+68OEZbTjiUE9bgOABXbP/GvrS0Kg==", + "dev": true + }, + "is-callable": { + "version": "1.1.5", + "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.1.5.tgz", + "integrity": "sha512-ESKv5sMCJB2jnHTWZ3O5itG+O128Hsus4K4Qh1h2/cgn2vbgnLSVqfV46AeJA9D5EeeLa9w81KUXMtn34zhX+Q==", + "dev": true + }, + "is-regex": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.0.5.tgz", + "integrity": "sha512-vlKW17SNq44owv5AQR3Cq0bQPEb8+kF3UKZ2fiZNOWtztYE5i0CzCZxFDwO58qAOWtxdBRVO/V5Qin1wjCqFYQ==", + "dev": true, + "requires": { + "has": "^1.0.3" + } + }, + "object-inspect": { + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.7.0.tgz", + "integrity": "sha512-a7pEHdh1xKIAgTySUGgLMx/xwDZskN1Ud6egYYN3EdRW4ZMPNEDUTF+hwy2LUC+Bl+SyLXANnwz/jyh/qutKUw==", + "dev": true + }, + "string.prototype.trimleft": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/string.prototype.trimleft/-/string.prototype.trimleft-2.1.1.tgz", + "integrity": "sha512-iu2AGd3PuP5Rp7x2kEZCrB2Nf41ehzh+goo8TV7z8/XDBbsvc6HQIlUl9RjkZ4oyrW1XM5UwlGl1oVEaDjg6Ag==", + "dev": true, + "requires": { + "define-properties": "^1.1.3", + "function-bind": "^1.1.1" + } + }, + "string.prototype.trimright": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/string.prototype.trimright/-/string.prototype.trimright-2.1.1.tgz", + "integrity": "sha512-qFvWL3/+QIgZXVmJBfpHmxLB7xsUXz6HsUmP8+5dRaC3Q7oKUv9Vo6aMCRZC1smrtyECFsIT30PqBJ1gTjAs+g==", + "dev": true, + "requires": { + "define-properties": "^1.1.3", + "function-bind": "^1.1.1" + } + } } }, "object.pick": { @@ -11619,13 +13580,10 @@ "dev": true }, "p-each-series": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/p-each-series/-/p-each-series-1.0.0.tgz", - "integrity": "sha1-kw89Et0fUOdDRFeiLNbwSsatf3E=", - "dev": true, - "requires": { - "p-reduce": "^1.0.0" - } + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/p-each-series/-/p-each-series-2.1.0.tgz", + "integrity": "sha512-ZuRs1miPT4HrjFa+9fRfOFXxGJfORgelKV9f9nNOWw2gl6gVsRaVDOQP0+MI0G0wGKns1Yacsu0GjOFbTK0JFQ==", + "dev": true }, "p-filter": { "version": "2.1.0", @@ -11682,12 +13640,6 @@ "mimic-fn": "^2.1.0" } }, - "p-reduce": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/p-reduce/-/p-reduce-1.0.0.tgz", - "integrity": "sha1-GMKw3ZNqRpClKfgjH1ig/bakffo=", - "dev": true - }, "p-retry": { "version": "4.2.0", "resolved": "https://registry.npmjs.org/p-retry/-/p-retry-4.2.0.tgz", @@ -11761,9 +13713,9 @@ } }, "parse5": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/parse5/-/parse5-4.0.0.tgz", - "integrity": "sha512-VrZ7eOd3T1Fk4XWNXMgiGBK/z0MG48BWG2uQNU4I72fkQuKUTZpl+u9k+CxEG0twMVzSmXEEz12z5Fnw1jIQFA==", + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/parse5/-/parse5-5.1.0.tgz", + "integrity": "sha512-fxNG2sQjHvlVAYmzBZS9YlDp6PTSSDwa98vkD4QgVDDCAo84z5X1t5XyJQ62ImdLXx5NdIIfihey6xpum9/gRQ==", "dev": true }, "pascalcase": { @@ -11974,15 +13926,48 @@ "dev": true }, "pretty-format": { - "version": "24.9.0", - "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-24.9.0.tgz", - "integrity": "sha512-00ZMZUiHaJrNfk33guavqgvfJS30sLYf0f8+Srklv0AMPodGGHcoHgksZ3OThYnIvOd+8yMCn0YiEOogjlgsnA==", + "version": "25.1.0", + "resolved": "https://registry.npmjs.org/pretty-format/-/pretty-format-25.1.0.tgz", + "integrity": "sha512-46zLRSGLd02Rp+Lhad9zzuNZ+swunitn8zIpfD2B4OPCRLXbM87RJT2aBLBWYOznNUML/2l/ReMyWNC80PJBUQ==", "dev": true, "requires": { - "@jest/types": "^24.9.0", - "ansi-regex": "^4.0.0", - "ansi-styles": "^3.2.0", - "react-is": "^16.8.4" + "@jest/types": "^25.1.0", + "ansi-regex": "^5.0.0", + "ansi-styles": "^4.0.0", + "react-is": "^16.12.0" + }, + "dependencies": { + "ansi-regex": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.0.tgz", + "integrity": "sha512-bY6fj56OUQ0hU1KjFNDQuJFezqKdrAyFdIevADiqrWHwSlbmBNMHp5ak2f40Pm8JTFyM2mqxkG6ngkHO11f/lg==", + "dev": true + }, + "ansi-styles": { + "version": "4.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-4.2.1.tgz", + "integrity": "sha512-9VGjrMsG1vePxcSweQsN20KY/c4zN0h9fLjqAbwbPfahM3t+NL+M9HC8xeXG2I8pX5NoamTGNuomEUFI7fcUjA==", + "dev": true, + "requires": { + "@types/color-name": "^1.1.1", + "color-convert": "^2.0.1" + } + }, + "color-convert": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", + "integrity": "sha512-RRECPsj7iu/xb5oKYcsFHSppFNnsj/52OVTRKb4zP5onXwVF3zVmmToNcOfGC+CRDpfK/U584fMg38ZHCaElKQ==", + "dev": true, + "requires": { + "color-name": "~1.1.4" + } + }, + "color-name": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.4.tgz", + "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", + "dev": true + } } }, "private": { @@ -12014,9 +13999,9 @@ "dev": true }, "psl": { - "version": "1.4.0", - "resolved": "https://registry.npmjs.org/psl/-/psl-1.4.0.tgz", - "integrity": "sha512-HZzqCGPecFLyoRj5HLfuDSKYTJkAfB5thKBIkRHtGjWwY7p1dAyveIbXIq4tO0KYfDF2tHqPUgY9SDnGm00uFw==", + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/psl/-/psl-1.7.0.tgz", + "integrity": "sha512-5NsSEDv8zY70ScRnOTn7bK7eanl2MvFrOrS/R6x+dBt5g1ghnj9Zv90kO8GwT8gxcu2ANyFprnFYB85IogIJOQ==", "dev": true }, "pump": { @@ -12080,9 +14065,9 @@ } }, "react-is": { - "version": "16.11.0", - "resolved": "https://registry.npmjs.org/react-is/-/react-is-16.11.0.tgz", - "integrity": "sha512-gbBVYR2p8mnriqAwWx9LbuUrShnAuSCNnuPGyc7GJrMVQtPDAh8iLpv7FRuMPFb56KkaVZIYSz1PrjI9q0QPCw==", + "version": "16.12.0", + "resolved": "https://registry.npmjs.org/react-is/-/react-is-16.12.0.tgz", + "integrity": "sha512-rPCkf/mWBtKc97aLL9/txD8DZdemK0vkA3JMLShjlJB3Pj3s+lpf1KaBzMfQrAmhMQB0n1cU/SUGgKKBCe837Q==", "dev": true }, "read-pkg": { @@ -12419,6 +14404,18 @@ "request-promise-core": "1.1.3", "stealthy-require": "^1.1.1", "tough-cookie": "^2.3.3" + }, + "dependencies": { + "tough-cookie": { + "version": "2.5.0", + "resolved": "https://registry.npmjs.org/tough-cookie/-/tough-cookie-2.5.0.tgz", + "integrity": "sha512-nlLsUzgm1kfLXSXfRZMc1KLAugd4hqJHDTvc2hDIwS3mZAfMEuMbc03SujMF+GEcpaX/qboeycw6iO8JwVv2+g==", + "dev": true, + "requires": { + "psl": "^1.1.28", + "punycode": "^2.1.1" + } + } } }, "require-directory": { @@ -12442,23 +14439,15 @@ "path-parse": "^1.0.6" } }, - "resolve-cwd": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/resolve-cwd/-/resolve-cwd-2.0.0.tgz", - "integrity": "sha1-AKn3OHVW4nA46uIyyqNypqWbZlo=", - "dev": true, - "requires": { - "resolve-from": "^3.0.0" - }, - "dependencies": { - "resolve-from": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-3.0.0.tgz", - "integrity": "sha1-six699nWiBvItuZTM17rywoYh0g=", - "dev": true - } - } - }, + "resolve-cwd": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/resolve-cwd/-/resolve-cwd-3.0.0.tgz", + "integrity": "sha512-OrZaX2Mb+rJCpH/6CpSqt9xFVpN++x01XnN2ie9g6P5/3xelLAkXWVADpdz1IHD/KFfEXyE6V0U01OQ3UO2rEg==", + "dev": true, + "requires": { + "resolve-from": "^5.0.0" + } + }, "resolve-from": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/resolve-from/-/resolve-from-5.0.0.tgz", @@ -12518,9 +14507,9 @@ } }, "rollup": { - "version": "1.26.4", - "resolved": "https://registry.npmjs.org/rollup/-/rollup-1.26.4.tgz", - "integrity": "sha512-faL58wTzZM+AH9mUSoncJEjUqvj5KSa4GpNkfn7mxdeBci5GOyT4i1K5+5+6vTfV68QGREh2xi4rW/l+0UFUAw==", + "version": "1.27.5", + "resolved": "https://registry.npmjs.org/rollup/-/rollup-1.27.5.tgz", + "integrity": "sha512-8rfVdzuTg2kt8ObD9LNJpEwUN7B6lsl3sHc5fddtgICpLjpYeSf4m2+RftBzcCaBTMi1iYX3Ez8zFT4Gj2nJjg==", "dev": true, "requires": { "@types/estree": "*", @@ -12630,19 +14619,41 @@ "walker": "~1.0.5" }, "dependencies": { + "anymatch": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/anymatch/-/anymatch-2.0.0.tgz", + "integrity": "sha512-5teOsQWABXHHBFP9y3skS5P3d/WfWXpv3FUpy+LorMrNYaT9pI4oLMQX7jzQ2KklNpGpWHzdCXTDT2Y3XGlZBw==", + "dev": true, + "requires": { + "micromatch": "^3.1.4", + "normalize-path": "^2.1.1" + } + }, "minimist": { "version": "1.2.0", "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.0.tgz", "integrity": "sha1-o1AIsg9BOD7sH7kU9M1d95omQoQ=", "dev": true + }, + "normalize-path": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/normalize-path/-/normalize-path-2.1.1.tgz", + "integrity": "sha1-GrKLVW4Zg2Oowab35vogE3/mrtk=", + "dev": true, + "requires": { + "remove-trailing-separator": "^1.0.1" + } } } }, - "sax": { - "version": "1.2.4", - "resolved": "https://registry.npmjs.org/sax/-/sax-1.2.4.tgz", - "integrity": "sha512-NqVDv9TpANUjFm0N8uM5GxL36UgKi9/atZw+x7YFnQ8ckwFGKrl4xX4yWtrey3UJm5nP1kUbnYgLopqWNSRhWw==", - "dev": true + "saxes": { + "version": "3.1.11", + "resolved": "https://registry.npmjs.org/saxes/-/saxes-3.1.11.tgz", + "integrity": "sha512-Ydydq3zC+WYDJK1+gRxRapLIED9PWeSuuS41wqyoRmzvhhh9nc+QQrVMKJYzJFULazeGhzSV0QleN2wD3boh2g==", + "dev": true, + "requires": { + "xmlchars": "^2.1.1" + } }, "scoped-regex": { "version": "2.1.0", @@ -13184,7 +15195,8 @@ "version": "0.1.1", "resolved": "https://registry.npmjs.org/shellwords/-/shellwords-0.1.1.tgz", "integrity": "sha512-vFwSUfQvqybiICwZY5+DAWIPLKsWO31Q91JSKl3UYv+K5c2QRPzn0qzec6QPu1Qc9eHYItiP3NdJqNVqetYAww==", - "dev": true + "dev": true, + "optional": true }, "signal-exit": { "version": "3.0.2", @@ -13221,9 +15233,9 @@ "dev": true }, "slash": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/slash/-/slash-2.0.0.tgz", - "integrity": "sha512-ZYKh3Wh2z1PpEXWr0MpSBZ0V6mZHAQfYevttO11c51CaWjGTaadiKZ+wVt1PbMlDV5qhMFslpZCemhwOK7C89A==", + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/slash/-/slash-3.0.0.tgz", + "integrity": "sha512-g9Q1haeby36OSStwb4ntCGGGaKsaVSjQ68fBxoQcutl5fS1vuY18H3wSt3jFyFtrkx+Kz0V1G85A4MyAdDMi2Q==", "dev": true }, "slice-ansi": { @@ -13592,30 +15604,13 @@ } }, "string-length": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/string-length/-/string-length-2.0.0.tgz", - "integrity": "sha1-1A27aGo6zpYMHP/KVivyxF+DY+0=", + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/string-length/-/string-length-3.1.0.tgz", + "integrity": "sha512-Ttp5YvkGm5v9Ijagtaz1BnN+k9ObpvS0eIBblPMp2YWL8FBmi9qblQ9fexc2k/CXFgrTIteU3jAw3payCnwSTA==", "dev": true, "requires": { "astral-regex": "^1.0.0", - "strip-ansi": "^4.0.0" - }, - "dependencies": { - "ansi-regex": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-3.0.0.tgz", - "integrity": "sha1-7QMXwyIGT3lGbAKWa922Bas32Zg=", - "dev": true - }, - "strip-ansi": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-4.0.0.tgz", - "integrity": "sha1-qEeQIusaw2iocTibY1JixQXuNo8=", - "dev": true, - "requires": { - "ansi-regex": "^3.0.0" - } - } + "strip-ansi": "^5.2.0" } }, "string-to-jsdoc-comment": { @@ -13865,70 +15860,14 @@ } }, "test-exclude": { - "version": "5.2.3", - "resolved": "https://registry.npmjs.org/test-exclude/-/test-exclude-5.2.3.tgz", - "integrity": "sha512-M+oxtseCFO3EDtAaGH7iiej3CBkzXqFMbzqYAACdzKui4eZA+pq3tZEwChvOdNfa7xxy8BfbmgJSIr43cC/+2g==", + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/test-exclude/-/test-exclude-6.0.0.tgz", + "integrity": "sha512-cAGWPIyOHU6zlmg88jwm7VRyXnMN7iV68OGAbYDk/Mh/xC/pzVPlQtY6ngoIH/5/tciuhGfvESU8GrHrcxD56w==", "dev": true, "requires": { - "glob": "^7.1.3", - "minimatch": "^3.0.4", - "read-pkg-up": "^4.0.0", - "require-main-filename": "^2.0.0" - }, - "dependencies": { - "find-up": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/find-up/-/find-up-3.0.0.tgz", - "integrity": "sha512-1yD6RmLI1XBfxugvORwlck6f75tYL+iR0jqwsOrOxMZyGYqUuDhJ0l4AXdO1iX/FTs9cBAMEk1gWSEx1kSbylg==", - "dev": true, - "requires": { - "locate-path": "^3.0.0" - } - }, - "locate-path": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-3.0.0.tgz", - "integrity": "sha512-7AO748wWnIhNqAuaty2ZWHkQHRSNfPVIsPIfwEOWO22AmaoVrWavlOcMR5nzTLNYvp36X220/maaRsrec1G65A==", - "dev": true, - "requires": { - "p-locate": "^3.0.0", - "path-exists": "^3.0.0" - } - }, - "p-limit": { - "version": "2.2.1", - "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.2.1.tgz", - "integrity": "sha512-85Tk+90UCVWvbDavCLKPOLC9vvY8OwEX/RtKF+/1OADJMVlFfEHOiMTPVyxg7mk/dKa+ipdHm0OUkTvCpMTuwg==", - "dev": true, - "requires": { - "p-try": "^2.0.0" - } - }, - "p-locate": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-3.0.0.tgz", - "integrity": "sha512-x+12w/To+4GFfgJhBEpiDcLozRJGegY+Ei7/z0tSLkMmxGZNybVMSfWj9aJn8Z5Fc7dBUNJOOVgPv2H7IwulSQ==", - "dev": true, - "requires": { - "p-limit": "^2.0.0" - } - }, - "p-try": { - "version": "2.2.0", - "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", - "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==", - "dev": true - }, - "read-pkg-up": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/read-pkg-up/-/read-pkg-up-4.0.0.tgz", - "integrity": "sha512-6etQSH7nJGsK0RbG/2TeDzZFa8shjQ1um+SwQQ5cwKy0dhSXdOncEhb1CPpvQG4h7FyOV6EB6YlV0yJvZQNAkA==", - "dev": true, - "requires": { - "find-up": "^3.0.0", - "read-pkg": "^3.0.0" - } - } + "@istanbuljs/schema": "^0.1.2", + "glob": "^7.1.4", + "minimatch": "^3.0.4" } }, "text-extensions": { @@ -13938,9 +15877,9 @@ "dev": true }, "throat": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/throat/-/throat-4.1.0.tgz", - "integrity": "sha1-iQN8vJLFarGJJua6TLsgDhVnKmo=", + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/throat/-/throat-5.0.0.tgz", + "integrity": "sha512-fcwX4mndzpLQKBS1DVYhGAcYaYt7vsHNIvQV+WXMvnow5cgjPphq5CaayLaGsjRdSCKZFNGt7/GYAuXaNOiYCA==", "dev": true }, "through": { @@ -14034,13 +15973,22 @@ } }, "tough-cookie": { - "version": "2.5.0", - "resolved": "https://registry.npmjs.org/tough-cookie/-/tough-cookie-2.5.0.tgz", - "integrity": "sha512-nlLsUzgm1kfLXSXfRZMc1KLAugd4hqJHDTvc2hDIwS3mZAfMEuMbc03SujMF+GEcpaX/qboeycw6iO8JwVv2+g==", + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/tough-cookie/-/tough-cookie-3.0.1.tgz", + "integrity": "sha512-yQyJ0u4pZsv9D4clxO69OEjLWYw+jbgspjTue4lTQZLfV0c5l1VmK2y1JK8E9ahdpltPOaAThPcp5nKPUgSnsg==", "dev": true, "requires": { + "ip-regex": "^2.1.0", "psl": "^1.1.28", "punycode": "^2.1.1" + }, + "dependencies": { + "ip-regex": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/ip-regex/-/ip-regex-2.1.0.tgz", + "integrity": "sha1-+ni/XS5pE8kRzp+BnuUUa7bYROk=", + "dev": true + } } }, "tr46": { @@ -14135,12 +16083,27 @@ "prelude-ls": "~1.1.2" } }, + "type-detect": { + "version": "4.0.8", + "resolved": "https://registry.npmjs.org/type-detect/-/type-detect-4.0.8.tgz", + "integrity": "sha512-0fr/mIH1dlO+x7TlcMy+bIDqKPsw/70tVyeHW787goQjhmqaZe10uwLujubK9q9Lg6Fiho1KUKDYz0Z7k7g5/g==", + "dev": true + }, "type-fest": { "version": "0.5.2", "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-0.5.2.tgz", "integrity": "sha512-DWkS49EQKVX//Tbupb9TFa19c7+MK1XmzkrZUR8TAktmE/DizXoaoJV6TZ/tSIPXipqNiRI6CyAe7x69Jb6RSw==", "dev": true }, + "typedarray-to-buffer": { + "version": "3.1.5", + "resolved": "https://registry.npmjs.org/typedarray-to-buffer/-/typedarray-to-buffer-3.1.5.tgz", + "integrity": "sha512-zdu8XMNEDepKKR+XYOXAVPtWui0ly0NtohUscw+UmaHiAWT8hrV1rr//H6V+0DvJ3OQ19S979M0laLfX8rm82Q==", + "dev": true, + "requires": { + "is-typedarray": "^1.0.0" + } + }, "typescript": { "version": "3.7.2", "resolved": "https://registry.npmjs.org/typescript/-/typescript-3.7.2.tgz", @@ -14380,21 +16343,110 @@ "dev": true }, "util.promisify": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/util.promisify/-/util.promisify-1.0.0.tgz", - "integrity": "sha512-i+6qA2MPhvoKLuxnJNpXAGhg7HphQOSUq2LKMZD0m15EiskXUkMvKdF4Uui0WYeCUGea+o2cw/ZuwehtfsrNkA==", + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/util.promisify/-/util.promisify-1.0.1.tgz", + "integrity": "sha512-g9JpC/3He3bm38zsLupWryXHoEcS22YHthuPQSJdMy6KNrzIRzWqcsHzD/WUnqe45whVou4VIsPew37DoXWNrA==", "dev": true, "requires": { - "define-properties": "^1.1.2", - "object.getownpropertydescriptors": "^2.0.3" + "define-properties": "^1.1.3", + "es-abstract": "^1.17.2", + "has-symbols": "^1.0.1", + "object.getownpropertydescriptors": "^2.1.0" + }, + "dependencies": { + "es-abstract": { + "version": "1.17.4", + "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.17.4.tgz", + "integrity": "sha512-Ae3um/gb8F0mui/jPL+QiqmglkUsaQf7FwBEHYIFkztkneosu9imhqHpBzQ3h1vit8t5iQ74t6PEVvphBZiuiQ==", + "dev": true, + "requires": { + "es-to-primitive": "^1.2.1", + "function-bind": "^1.1.1", + "has": "^1.0.3", + "has-symbols": "^1.0.1", + "is-callable": "^1.1.5", + "is-regex": "^1.0.5", + "object-inspect": "^1.7.0", + "object-keys": "^1.1.1", + "object.assign": "^4.1.0", + "string.prototype.trimleft": "^2.1.1", + "string.prototype.trimright": "^2.1.1" + } + }, + "has-symbols": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.1.tgz", + "integrity": "sha512-PLcsoqu++dmEIZB+6totNFKq/7Do+Z0u4oT0zKOJNl3lYK6vGwwu2hjHs+68OEZbTjiUE9bgOABXbP/GvrS0Kg==", + "dev": true + }, + "is-callable": { + "version": "1.1.5", + "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.1.5.tgz", + "integrity": "sha512-ESKv5sMCJB2jnHTWZ3O5itG+O128Hsus4K4Qh1h2/cgn2vbgnLSVqfV46AeJA9D5EeeLa9w81KUXMtn34zhX+Q==", + "dev": true + }, + "is-regex": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.0.5.tgz", + "integrity": "sha512-vlKW17SNq44owv5AQR3Cq0bQPEb8+kF3UKZ2fiZNOWtztYE5i0CzCZxFDwO58qAOWtxdBRVO/V5Qin1wjCqFYQ==", + "dev": true, + "requires": { + "has": "^1.0.3" + } + }, + "object-inspect": { + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.7.0.tgz", + "integrity": "sha512-a7pEHdh1xKIAgTySUGgLMx/xwDZskN1Ud6egYYN3EdRW4ZMPNEDUTF+hwy2LUC+Bl+SyLXANnwz/jyh/qutKUw==", + "dev": true + }, + "string.prototype.trimleft": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/string.prototype.trimleft/-/string.prototype.trimleft-2.1.1.tgz", + "integrity": "sha512-iu2AGd3PuP5Rp7x2kEZCrB2Nf41ehzh+goo8TV7z8/XDBbsvc6HQIlUl9RjkZ4oyrW1XM5UwlGl1oVEaDjg6Ag==", + "dev": true, + "requires": { + "define-properties": "^1.1.3", + "function-bind": "^1.1.1" + } + }, + "string.prototype.trimright": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/string.prototype.trimright/-/string.prototype.trimright-2.1.1.tgz", + "integrity": "sha512-qFvWL3/+QIgZXVmJBfpHmxLB7xsUXz6HsUmP8+5dRaC3Q7oKUv9Vo6aMCRZC1smrtyECFsIT30PqBJ1gTjAs+g==", + "dev": true, + "requires": { + "define-properties": "^1.1.3", + "function-bind": "^1.1.1" + } + } } }, "uuid": { - "version": "3.3.3", - "resolved": "https://registry.npmjs.org/uuid/-/uuid-3.3.3.tgz", - "integrity": "sha512-pW0No1RGHgzlpHJO1nsVrHKpOEIxkGg1xB+v0ZmdNH5OAeAwzAVrCnI2/6Mtx+Uys6iaylxa+D3g4j63IKKjSQ==", + "version": "3.4.0", + "resolved": "https://registry.npmjs.org/uuid/-/uuid-3.4.0.tgz", + "integrity": "sha512-HjSDRw6gZE5JMggctHBcjVak08+KEVhSIiDzFnT9S9aegmp85S/bReBVTb4QTFaRNptJ9kuYaNhnbNEOkbKb/A==", "dev": true }, + "v8-to-istanbul": { + "version": "4.0.1", + "resolved": "https://registry.npmjs.org/v8-to-istanbul/-/v8-to-istanbul-4.0.1.tgz", + "integrity": "sha512-x0yZvZAkjJwdD3fPiJzYP37aod0ati4LlmD2RmpKjqewjKAov/u/ytZ8ViIZb07cN4cePKzl9ijiUi7C1LQ8hQ==", + "dev": true, + "requires": { + "@types/istanbul-lib-coverage": "^2.0.1", + "convert-source-map": "^1.6.0", + "source-map": "^0.7.3" + }, + "dependencies": { + "source-map": { + "version": "0.7.3", + "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.7.3.tgz", + "integrity": "sha512-CkCj6giN3S+n9qrYiBTX5gystlENnRW5jZeNLHpe6aue+SrHcG5VYwujhW9s4dY31mEGsxBDrHR6oI69fTXsaQ==", + "dev": true + } + } + }, "validate-npm-package-license": { "version": "3.0.4", "resolved": "https://registry.npmjs.org/validate-npm-package-license/-/validate-npm-package-license-3.0.4.tgz", @@ -14434,6 +16486,17 @@ "browser-process-hrtime": "^0.1.2" } }, + "w3c-xmlserializer": { + "version": "1.1.2", + "resolved": "https://registry.npmjs.org/w3c-xmlserializer/-/w3c-xmlserializer-1.1.2.tgz", + "integrity": "sha512-p10l/ayESzrBMYWRID6xbuCKh2Fp77+sA0doRuGn4tTIMrrZVeqfpKjXHY+oDh3K4nLdPgNwMTVP6Vp4pvqbNg==", + "dev": true, + "requires": { + "domexception": "^1.0.1", + "webidl-conversions": "^4.0.2", + "xml-name-validator": "^3.0.0" + } + }, "walker": { "version": "1.0.7", "resolved": "https://registry.npmjs.org/walker/-/walker-1.0.7.tgz", @@ -14614,13 +16677,10 @@ } }, "ws": { - "version": "5.2.2", - "resolved": "https://registry.npmjs.org/ws/-/ws-5.2.2.tgz", - "integrity": "sha512-jaHFD6PFv6UgoIVda6qZllptQsMlDEJkTQcybzzXDYM1XO9Y8em691FGMPmM46WGyLU4z9KMgQN+qrux/nhlHA==", - "dev": true, - "requires": { - "async-limiter": "~1.0.0" - } + "version": "7.2.1", + "resolved": "https://registry.npmjs.org/ws/-/ws-7.2.1.tgz", + "integrity": "sha512-sucePNSafamSKoOqoNfBd8V0StlkzJKL2ZAhGQinCfNQ+oacw+Pk7lcdAElecBF2VkLNZRiIb5Oi1Q5lVUVt2A==", + "dev": true }, "xdg-basedir": { "version": "3.0.0", @@ -14634,6 +16694,12 @@ "integrity": "sha512-A5CUptxDsvxKJEU3yO6DuWBSJz/qizqzJKOMIfUJHETbBw/sFaDxgd6fxm1ewUaM0jZ444Fc5vC5ROYurg/4Pw==", "dev": true }, + "xmlchars": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/xmlchars/-/xmlchars-2.2.0.tgz", + "integrity": "sha512-JZnDKK8B0RCDw84FNdDAIpZK+JuJw+s7Lz8nksI7SIuU3UXJJslUthsi+uWBUYOwPFwW7W7PRLRfUKpxjtjFCw==", + "dev": true + }, "xtend": { "version": "4.0.2", "resolved": "https://registry.npmjs.org/xtend/-/xtend-4.0.2.tgz", @@ -14662,70 +16728,65 @@ } }, "yargs": { - "version": "13.3.0", - "resolved": "https://registry.npmjs.org/yargs/-/yargs-13.3.0.tgz", - "integrity": "sha512-2eehun/8ALW8TLoIl7MVaRUrg+yCnenu8B4kBlRxj3GJGDKU1Og7sMXPNm1BYyM1DOJmTZ4YeN/Nwxv+8XJsUA==", + "version": "15.1.0", + "resolved": "https://registry.npmjs.org/yargs/-/yargs-15.1.0.tgz", + "integrity": "sha512-T39FNN1b6hCW4SOIk1XyTOWxtXdcen0t+XYrysQmChzSipvhBO8Bj0nK1ozAasdk24dNWuMZvr4k24nz+8HHLg==", "dev": true, "requires": { - "cliui": "^5.0.0", - "find-up": "^3.0.0", + "cliui": "^6.0.0", + "decamelize": "^1.2.0", + "find-up": "^4.1.0", "get-caller-file": "^2.0.1", "require-directory": "^2.1.1", "require-main-filename": "^2.0.0", "set-blocking": "^2.0.0", - "string-width": "^3.0.0", + "string-width": "^4.2.0", "which-module": "^2.0.0", "y18n": "^4.0.0", - "yargs-parser": "^13.1.1" + "yargs-parser": "^16.1.0" }, "dependencies": { - "emoji-regex": { - "version": "7.0.3", - "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-7.0.3.tgz", - "integrity": "sha512-CwBLREIQ7LvYFB0WyRvwhq5N5qPhc6PMjD6bYggFlI5YyDgl+0vxq5VHbMOFqLg7hfWzmu8T5Z1QofhmTIhItA==", + "ansi-regex": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.0.tgz", + "integrity": "sha512-bY6fj56OUQ0hU1KjFNDQuJFezqKdrAyFdIevADiqrWHwSlbmBNMHp5ak2f40Pm8JTFyM2mqxkG6ngkHO11f/lg==", "dev": true }, "find-up": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/find-up/-/find-up-3.0.0.tgz", - "integrity": "sha512-1yD6RmLI1XBfxugvORwlck6f75tYL+iR0jqwsOrOxMZyGYqUuDhJ0l4AXdO1iX/FTs9cBAMEk1gWSEx1kSbylg==", + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-4.1.0.tgz", + "integrity": "sha512-PpOwAdQ/YlXQ2vj8a3h8IipDuYRi3wceVQQGYWxNINccq40Anw7BlsEXCMbt1Zt+OLA6Fq9suIpIWD0OsnISlw==", "dev": true, "requires": { - "locate-path": "^3.0.0" + "locate-path": "^5.0.0", + "path-exists": "^4.0.0" } }, - "is-fullwidth-code-point": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-2.0.0.tgz", - "integrity": "sha1-o7MKXE8ZkYMWeqq5O+764937ZU8=", - "dev": true - }, "locate-path": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-3.0.0.tgz", - "integrity": "sha512-7AO748wWnIhNqAuaty2ZWHkQHRSNfPVIsPIfwEOWO22AmaoVrWavlOcMR5nzTLNYvp36X220/maaRsrec1G65A==", + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-5.0.0.tgz", + "integrity": "sha512-t7hw9pI+WvuwNJXwk5zVHpyhIqzg2qTlklJOf0mVxGSbe3Fp2VieZcduNYjaLDoy6p9uGpQEGWG87WpMKlNq8g==", "dev": true, "requires": { - "p-locate": "^3.0.0", - "path-exists": "^3.0.0" + "p-locate": "^4.1.0" } }, "p-limit": { - "version": "2.2.1", - "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.2.1.tgz", - "integrity": "sha512-85Tk+90UCVWvbDavCLKPOLC9vvY8OwEX/RtKF+/1OADJMVlFfEHOiMTPVyxg7mk/dKa+ipdHm0OUkTvCpMTuwg==", + "version": "2.2.2", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.2.2.tgz", + "integrity": "sha512-WGR+xHecKTr7EbUEhyLSh5Dube9JtdiG78ufaeLxTgpudf/20KqyMioIUZJAezlTIi6evxuoUs9YXc11cU+yzQ==", "dev": true, "requires": { "p-try": "^2.0.0" } }, "p-locate": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-3.0.0.tgz", - "integrity": "sha512-x+12w/To+4GFfgJhBEpiDcLozRJGegY+Ei7/z0tSLkMmxGZNybVMSfWj9aJn8Z5Fc7dBUNJOOVgPv2H7IwulSQ==", + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-4.1.0.tgz", + "integrity": "sha512-R79ZZ/0wAxKGu3oYMlz8jy/kbhsNrS7SKZ7PxEHBgJ5+F2mtFW2fK2cOtBh1cHYkQsbzFV7I+EoRKe6Yt0oK7A==", "dev": true, "requires": { - "p-limit": "^2.0.0" + "p-limit": "^2.2.0" } }, "p-try": { @@ -14734,15 +16795,40 @@ "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==", "dev": true }, + "path-exists": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-4.0.0.tgz", + "integrity": "sha512-ak9Qy5Q7jYb2Wwcey5Fpvg2KoAc/ZIhLSLOSBmRmygPsGwkVVt0fZa0qrtMz+m6tJTAHfZQ8FnmB4MG4LWy7/w==", + "dev": true + }, "string-width": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/string-width/-/string-width-3.1.0.tgz", - "integrity": "sha512-vafcv6KjVZKSgz06oM/H6GDBrAtz8vdhQakGjFIvNrHA6y3HCF1CInLy+QLq8dTJPQ1b+KDUqDFctkdRW44e1w==", + "version": "4.2.0", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-4.2.0.tgz", + "integrity": "sha512-zUz5JD+tgqtuDjMhwIg5uFVV3dtqZ9yQJlZVfq4I01/K5Paj5UHj7VyrQOJvzawSVlKpObApbfD0Ed6yJc+1eg==", "dev": true, "requires": { - "emoji-regex": "^7.0.1", - "is-fullwidth-code-point": "^2.0.0", - "strip-ansi": "^5.1.0" + "emoji-regex": "^8.0.0", + "is-fullwidth-code-point": "^3.0.0", + "strip-ansi": "^6.0.0" + } + }, + "strip-ansi": { + "version": "6.0.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-6.0.0.tgz", + "integrity": "sha512-AuvKTrTfQNYNIctbR1K/YGTR1756GycPsg7b9bdV9Duqur4gv6aKqHXah67Z8ImS7WEz5QVcOtlfW2rZEugt6w==", + "dev": true, + "requires": { + "ansi-regex": "^5.0.0" + } + }, + "yargs-parser": { + "version": "16.1.0", + "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-16.1.0.tgz", + "integrity": "sha512-H/V41UNZQPkUMIT5h5hiwg4QKIY1RPvoBV4XcjUbRM8Bk2oKqqyZ0DIEbTFZB0XjbtSPG8SAa/0DxCQmiRgzKg==", + "dev": true, + "requires": { + "camelcase": "^5.0.0", + "decamelize": "^1.2.0" } } } diff --git a/package.json b/package.json index e1031288f..adaa38d5c 100644 --- a/package.json +++ b/package.json @@ -32,14 +32,14 @@ "@octokit/core": "^2.1.2", "@octokit/graphql": "^4.3.1", "@pika/pack": "^0.5.0", - "@pika/plugin-build-node": "^0.7.1", - "@pika/plugin-build-web": "^0.7.1", - "@pika/plugin-ts-standard-pkg": "^0.7.1", + "@pika/plugin-build-node": "^0.8.1", + "@pika/plugin-build-web": "^0.8.1", + "@pika/plugin-ts-standard-pkg": "^0.8.1", "@types/fetch-mock": "^7.3.1", "@types/jest": "^25.1.0", "@types/node": "^13.1.0", "fetch-mock": "^8.0.0", - "jest": "^24.9.0", + "jest": "^25.1.0", "lodash.camelcase": "^4.3.0", "lodash.set": "^4.3.2", "lodash.upperfirst": "^4.3.1", diff --git a/scripts/update-endpoints/code.js b/scripts/update-endpoints/code.js index 852a64b44..c0c41aa6c 100644 --- a/scripts/update-endpoints/code.js +++ b/scripts/update-endpoints/code.js @@ -5,7 +5,6 @@ const prettier = require("prettier"); const sortKeys = require("sort-keys"); const ENDPOINTS = require("./generated/endpoints.json"); -const WORKAROUNDS = require("./workarounds"); const ROUTES_PATH = join( __dirname, @@ -21,7 +20,7 @@ const newRoutes = {}; generateRoutes(); async function generateRoutes() { - ENDPOINTS.concat(WORKAROUNDS).forEach(endpoint => { + ENDPOINTS.forEach(endpoint => { const scope = endpoint.scope; if (endpoint.isLegacy && !/^\/teams\/\{team_id\}/.test(endpoint.url)) { @@ -29,98 +28,105 @@ async function generateRoutes() { return; } + const isUploadReleaseAssetUrl = /^\{origin\}/.test(endpoint.url); + if (isUploadReleaseAssetUrl) { + endpoint.url = endpoint.url.substr("{origin}".length); + } + + const idName = endpoint.id; + const route = `${endpoint.method} ${endpoint.url}`; + const endpointDefaults = {}; + const endpointDecorations = {}; + if (!newRoutes[scope]) { newRoutes[scope] = {}; } - const idName = endpoint.id; - const url = endpoint.url.toLowerCase().replace(/\{(\w+)\}/g, ":$1"); + if (endpoint.headers.length) { + const headers = endpoint.headers.reduce((result, header) => { + // accept header is set via mediatype + if (header.name === "accept") { + return result; + } + + // ignore headers with null values. THese can be required headers that must be set by the user, + // such as `headers['content-type']` for `octokit.repos.uploadReleaseAsset()` + if (header.value === null) { + return result; + } - // new route - newRoutes[scope][idName] = { - method: endpoint.method, - headers: endpoint.headers.reduce((result, header) => { if (!result) { result = {}; } + result[header.name] = header.value; return result; - }, undefined), - params: endpoint.parameters.reduce((result, param) => { - result[param.name] = { - type: param.type - }; - if (param.allowNull) { - result[param.name].allowNull = true; - } - if (param.required) { - result[param.name].required = true; - } - if (param.mapToData) { - result[param.name].mapTo = "data"; - } - if (param.enum) { - result[param.name].enum = param.enum; - } - if (param.validation) { - result[param.name].validation = param.validation; - } - if (param.deprecated) { - result[param.name].deprecated = true; - - if (param.alias) { - result[param.name].alias = param.alias; - result[param.name].type = result[param.alias].type; - } else { - result[param.name].type = param.type; - result[param.name].description = param.description; - } - } + }, undefined); - return result; - }, {}), - url, - deprecated: newRoutes[scope][idName] - ? newRoutes[scope][idName].deprecated - : undefined - }; - - const previewHeaders = endpoint.previews - .map(preview => `application/vnd.github.${preview.name}-preview+json`) - .join(","); - - if (previewHeaders) { - newRoutes[scope][idName].headers = { - accept: previewHeaders + if (headers) { + endpointDefaults.headers = headers; + } + } + + if (endpoint.previews.length) { + endpointDefaults.mediaType = { + previews: endpoint.previews.map(preview => preview.name) }; } if (endpoint.renamed) { - const { before, after } = endpoint.renamed; - if (!newRoutes[before.scope]) { - newRoutes[before.scope] = {}; - } + endpointDecorations.renamed = [ + endpoint.renamed.after.scope, + endpoint.renamed.after.id + ]; + } + + if (endpoint.isDeprecated && !endpoint.renamed) { + endpointDecorations.deprecated = `octokit.${scope}.${idName}() is deprecated, see ${endpoint.documentationUrl}`; + } - if (!newRoutes[before.scope][before.id]) { - newRoutes[before.scope][before.id] = newRoutes[scope][idName]; + const renamedParameters = endpoint.parameters.filter( + parameter => !!parameter.alias + ); + + if (renamedParameters.length) { + endpointDecorations.renamedParameters = {}; + + for (const parameter of renamedParameters) { + endpointDecorations.renamedParameters[parameter.name] = parameter.alias; } + } + + const mapToDataParameter = endpoint.parameters.find(parameter => { + return parameter.mapToData && parameter.name !== "data"; + }); - newRoutes[before.scope][ - before.id - ].deprecated = `octokit.${before.scope}.${before.id}() has been renamed to octokit.${after.scope}.${after.id}() (${endpoint.renamed.date})`; + if (mapToDataParameter) { + endpointDecorations.mapToData = mapToDataParameter.name; } - if (endpoint.isDeprecated && !newRoutes[scope][idName].deprecated) { - newRoutes[scope][ - idName - ].deprecated = `octokit.${scope}.${idName}() is deprecated, see ${endpoint.documentationUrl}`; + if (isUploadReleaseAssetUrl) { + endpointDefaults.baseUrl = "https://uploads.github.com"; + } + + newRoutes[scope][idName] = [route]; + + if (Object.keys(endpointDecorations).length) { + newRoutes[scope][idName].push(endpointDefaults, endpointDecorations); + } else if (Object.keys(endpointDefaults).length) { + newRoutes[scope][idName].push(endpointDefaults); } }); writeFileSync( ROUTES_PATH, prettier.format( - `export default ` + JSON.stringify(sortKeys(newRoutes, { deep: true })), + `import { EndpointsDefaultsAndDecorations } from "../types"; + const Endpoints: EndpointsDefaultsAndDecorations = ${JSON.stringify( + sortKeys(newRoutes, { deep: true }) + )} + + export default Endpoints`, { parser: "typescript" } ) ); diff --git a/scripts/update-endpoints/docs.js b/scripts/update-endpoints/docs.js index aa357d3c1..292a73afa 100644 --- a/scripts/update-endpoints/docs.js +++ b/scripts/update-endpoints/docs.js @@ -4,7 +4,6 @@ const { join } = require("path"); const prettier = require("prettier"); const ENDPOINTS = require("./generated/endpoints.json"); -const WORKAROUNDS = require("./workarounds"); const README_PATH = join(__dirname, "..", "..", "README.md"); @@ -13,30 +12,28 @@ const newRoutes = {}; generateRoutes(); async function generateRoutes() { - const examples = ENDPOINTS.concat(WORKAROUNDS) - .map(endpoint => { - if (endpoint.isLegacy && !/^\/teams\/\{team_id\}/.test(endpoint.url)) { - // ignore legacy endpoints with the exception of the new teams legacy methods - return; - } - - const paramNames = endpoint.parameters - .filter(parameter => !parameter.alias) - .filter(parameter => !parameter.name.includes(".")) - .filter(parameter => !["per_page", "page"].includes(parameter.name)) - .map(parameter => parameter.name) - .join(", "); - - const comment = endpoint.renamed - ? `// DEPRECATED: octokit.${endpoint.renamed.before.scope}.${endpoint.renamed.before.id}() has been renamed to octokit.${endpoint.renamed.after.scope}.${endpoint.renamed.after.id}()` - : `// ${endpoint.documentationUrl}`; - - return `${comment} + const examples = ENDPOINTS.map(endpoint => { + if (endpoint.isLegacy && !/^\/teams\/\{team_id\}/.test(endpoint.url)) { + // ignore legacy endpoints with the exception of the new teams legacy methods + return; + } + + const paramNames = endpoint.parameters + .filter(parameter => !parameter.alias) + .filter(parameter => !parameter.name.includes(".")) + .filter(parameter => !["per_page", "page"].includes(parameter.name)) + .map(parameter => parameter.name) + .join(", "); + + const comment = endpoint.renamed + ? `// DEPRECATED: octokit.${endpoint.renamed.before.scope}.${endpoint.renamed.before.id}() has been renamed to octokit.${endpoint.renamed.after.scope}.${endpoint.renamed.after.id}()` + : `// ${endpoint.documentationUrl}`; + + return `${comment} octokit.${endpoint.scope}.${endpoint.id}(${ - paramNames ? `{ ${paramNames} }` : "" - });`; - }) - .join("\n\n"); + paramNames ? `{ ${paramNames} }` : "" + });`; + }).join("\n\n"); const currentContent = readFileSync(README_PATH, "utf8"); const newContent = currentContent.replace( diff --git a/scripts/update-endpoints/fetch-json.js b/scripts/update-endpoints/fetch-json.js index 1cb743001..fcb96d047 100644 --- a/scripts/update-endpoints/fetch-json.js +++ b/scripts/update-endpoints/fetch-json.js @@ -9,8 +9,8 @@ if (!process.env.VERSION) { } const QUERY = ` - query ($version: String) { - endpoints(version: $version, filter: { isGithubCloudOnly: false }) { + query ($version: String!, $ignoreChangesBefore: String!) { + endpoints(version: $version, ignoreChangesBefore: $ignoreChangesBefore, filter: { isDeprecated: false, isGithubCloudOnly: false }) { name scope(format: CAMELCASE) id(format: CAMELCASE) @@ -26,6 +26,7 @@ const QUERY = ` headers { name value + required } parameters { name @@ -67,7 +68,8 @@ main(); async function main() { const { endpoints } = await graphql(QUERY, { url: "https://octokit-routes-graphql-server.now.sh/", - version: process.env.VERSION + version: process.env.VERSION, + ignoreChangesBefore: "2020-02-01" }); writeFileSync( diff --git a/scripts/update-endpoints/generated/endpoints.json b/scripts/update-endpoints/generated/endpoints.json index 4c62b0af8..1775601dc 100644 --- a/scripts/update-endpoints/generated/endpoints.json +++ b/scripts/update-endpoints/generated/endpoints.json @@ -13,7 +13,8 @@ "headers": [ { "name": "accept", - "value": "application/vnd.github.machine-man-preview+json" + "value": "application/vnd.github.machine-man-preview+json", + "required": true } ], "parameters": [], @@ -42,7 +43,11 @@ "documentationUrl": "https://developer.github.com/v3/apps/#create-a-github-app-from-a-manifest", "previews": [{ "name": "fury" }], "headers": [ - { "name": "accept", "value": "application/vnd.github.fury-preview+json" } + { + "name": "accept", + "value": "application/vnd.github.fury-preview+json", + "required": true + } ], "parameters": [ { @@ -86,7 +91,8 @@ "headers": [ { "name": "accept", - "value": "application/vnd.github.machine-man-preview+json" + "value": "application/vnd.github.machine-man-preview+json", + "required": true } ], "parameters": [ @@ -144,7 +150,8 @@ "headers": [ { "name": "accept", - "value": "application/vnd.github.machine-man-preview+json" + "value": "application/vnd.github.machine-man-preview+json", + "required": true } ], "parameters": [ @@ -189,7 +196,8 @@ "headers": [ { "name": "accept", - "value": "application/vnd.github.gambit-preview+json,application/vnd.github.machine-man-preview+json" + "value": "application/vnd.github.gambit-preview+json,application/vnd.github.machine-man-preview+json", + "required": true } ], "parameters": [ @@ -224,7 +232,8 @@ "headers": [ { "name": "accept", - "value": "application/vnd.github.machine-man-preview+json" + "value": "application/vnd.github.machine-man-preview+json", + "required": true } ], "parameters": [ @@ -281,129 +290,6 @@ ], "renamed": null }, - { - "name": "List your grants", - "scope": "oauthAuthorizations", - "id": "listGrants", - "method": "GET", - "url": "/applications/grants", - "isDeprecated": true, - "isLegacy": false, - "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nYou can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://developer.github.com/v3/oauth_authorizations/#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `[\"repo\", \"user\"]`.", - "documentationUrl": "https://developer.github.com/v3/oauth_authorizations/#list-your-grants", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"id\":1,\"url\":\"https://api.github.com/applications/grants/1\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"created_at\":\"2011-09-06T17:26:27Z\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"scopes\":[\"public_repo\"]}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a single grant", - "scope": "oauthAuthorizations", - "id": "getGrant", - "method": "GET", - "url": "/applications/grants/{grant_id}", - "isDeprecated": true, - "isLegacy": false, - "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).", - "documentationUrl": "https://developer.github.com/v3/oauth_authorizations/#get-a-single-grant", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "grant_id", - "description": "grant_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"id\":1,\"url\":\"https://api.github.com/applications/grants/1\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"created_at\":\"2011-09-06T17:26:27Z\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"scopes\":[\"public_repo\"]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Delete a grant", - "scope": "oauthAuthorizations", - "id": "deleteGrant", - "method": "DELETE", - "url": "/applications/grants/{grant_id}", - "isDeprecated": true, - "isLegacy": false, - "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).", - "documentationUrl": "https://developer.github.com/v3/oauth_authorizations/#delete-a-grant", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "grant_id", - "description": "grant_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [], - "renamed": null - }, { "name": "Delete an app authorization", "scope": "apps", @@ -418,7 +304,8 @@ "headers": [ { "name": "accept", - "value": "application/vnd.github.doctor-strange-preview+json" + "value": "application/vnd.github.doctor-strange-preview+json", + "required": true } ], "parameters": [ @@ -452,100 +339,6 @@ "responses": [], "renamed": null }, - { - "name": "Revoke a grant for an application", - "scope": "apps", - "id": "revokeGrantForApplication", - "method": "DELETE", - "url": "/applications/{client_id}/grants/{access_token}", - "isDeprecated": true, - "isLegacy": false, - "description": "**Deprecation Notice:** GitHub will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nOAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid token as `:access_token` and the grant for the token's owner will be deleted.\n\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the Applications settings page under \"Authorized OAuth Apps\" on GitHub](https://github.com/settings/applications#authorized).", - "documentationUrl": "https://developer.github.com/v3/apps/oauth_applications/#revoke-a-grant-for-an-application", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "client_id", - "description": "client_id parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "access_token", - "description": "access_token parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "Revoke a grant for an application", - "scope": "oauthAuthorizations", - "id": "revokeGrantForApplication", - "method": "DELETE", - "url": "/applications/{client_id}/grants/{access_token}", - "isDeprecated": true, - "isLegacy": false, - "description": "**Deprecation Notice:** GitHub will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nOAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid token as `:access_token` and the grant for the token's owner will be deleted.\n\nDeleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the Applications settings page under \"Authorized OAuth Apps\" on GitHub](https://github.com/settings/applications#authorized).", - "documentationUrl": "https://developer.github.com/v3/apps/oauth_applications/#revoke-a-grant-for-an-application", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "client_id", - "description": "client_id parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "access_token", - "description": "access_token parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [], - "renamed": { - "before": { - "scope": "oauthAuthorizations", - "id": "revokeGrantForApplication" - }, - "after": { "scope": "apps", "id": "revokeGrantForApplication" }, - "date": "2019-11-05", - "note": "\"Revoke a grant for an application\" has been moved from \"OAuth Authorizations\" to \"Apps\"" - } - }, { "name": "Check a token", "scope": "apps", @@ -560,7 +353,8 @@ "headers": [ { "name": "accept", - "value": "application/vnd.github.doctor-strange-preview+json" + "value": "application/vnd.github.doctor-strange-preview+json", + "required": true } ], "parameters": [ @@ -618,7 +412,8 @@ "headers": [ { "name": "accept", - "value": "application/vnd.github.doctor-strange-preview+json" + "value": "application/vnd.github.doctor-strange-preview+json", + "required": true } ], "parameters": [ @@ -676,7 +471,8 @@ "headers": [ { "name": "accept", - "value": "application/vnd.github.doctor-strange-preview+json" + "value": "application/vnd.github.doctor-strange-preview+json", + "required": true } ], "parameters": [ @@ -711,34 +507,27 @@ "renamed": null }, { - "name": "Check an authorization", + "name": "Get a single GitHub App", "scope": "apps", - "id": "checkAuthorization", + "id": "getBySlug", "method": "GET", - "url": "/applications/{client_id}/tokens/{access_token}", - "isDeprecated": true, + "url": "/apps/{app_slug}", + "isDeprecated": false, "isLegacy": false, - "description": "**Deprecation Notice:** GitHub will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nOAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.", - "documentationUrl": "https://developer.github.com/v3/apps/oauth_applications/#check-an-authorization", - "previews": [], - "headers": [], - "parameters": [ + "description": "**Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).\n\nIf the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "documentationUrl": "https://developer.github.com/v3/apps/#get-a-single-github-app", + "previews": [{ "name": "machine-man" }], + "headers": [ { - "name": "client_id", - "description": "client_id parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, + "name": "accept", + "value": "application/vnd.github.machine-man-preview+json", + "required": true + } + ], + "parameters": [ { - "name": "access_token", - "description": "access_token parameter", + "name": "app_slug", + "description": "app_slug parameter", "in": "PATH", "type": "string", "required": true, @@ -756,7 +545,7 @@ "description": "response", "examples": [ { - "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\"],\"token\":\"abcdefgh12345678\",\"token_last_eight\":\"12345678\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" + "data": "{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}" } ] } @@ -764,92 +553,59 @@ "renamed": null }, { - "name": "Check an authorization", - "scope": "oauthAuthorizations", - "id": "checkAuthorization", + "name": "List all codes of conduct", + "scope": "codesOfConduct", + "id": "listConductCodes", "method": "GET", - "url": "/applications/{client_id}/tokens/{access_token}", - "isDeprecated": true, + "url": "/codes_of_conduct", + "isDeprecated": false, "isLegacy": false, - "description": "**Deprecation Notice:** GitHub will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nOAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.", - "documentationUrl": "https://developer.github.com/v3/apps/oauth_applications/#check-an-authorization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "client_id", - "description": "client_id parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, + "description": "", + "documentationUrl": "https://developer.github.com/v3/codes_of_conduct/#list-all-codes-of-conduct", + "previews": [{ "name": "scarlet-witch" }], + "headers": [ { - "name": "access_token", - "description": "access_token parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null + "name": "accept", + "value": "application/vnd.github.scarlet-witch-preview+json", + "required": true } ], + "parameters": [], "responses": [ { "code": 200, "description": "response", "examples": [ { - "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\"],\"token\":\"abcdefgh12345678\",\"token_last_eight\":\"12345678\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" + "data": "[{\"key\":\"citizen_code_of_conduct\",\"name\":\"Citizen Code of Conduct\",\"url\":\"https://api.github.com/codes_of_conduct/citizen_code_of_conduct\"},{\"key\":\"contributor_covenant\",\"name\":\"Contributor Covenant\",\"url\":\"https://api.github.com/codes_of_conduct/contributor_covenant\"}]" } ] } ], - "renamed": { - "before": { "scope": "oauthAuthorizations", "id": "checkAuthorization" }, - "after": { "scope": "apps", "id": "checkAuthorization" }, - "date": "2019-11-05", - "note": "\"Check an authorization\" has been moved from \"OAuth Authorizations\" to \"Apps\"" - } + "renamed": null }, { - "name": "Reset an authorization", - "scope": "apps", - "id": "resetAuthorization", - "method": "POST", - "url": "/applications/{client_id}/tokens/{access_token}", - "isDeprecated": true, + "name": "Get an individual code of conduct", + "scope": "codesOfConduct", + "id": "getConductCode", + "method": "GET", + "url": "/codes_of_conduct/{key}", + "isDeprecated": false, "isLegacy": false, - "description": "**Deprecation Notice:** GitHub will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nOAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.", - "documentationUrl": "https://developer.github.com/v3/apps/oauth_applications/#reset-an-authorization", - "previews": [], - "headers": [], - "parameters": [ + "description": "", + "documentationUrl": "https://developer.github.com/v3/codes_of_conduct/#get-an-individual-code-of-conduct", + "previews": [{ "name": "scarlet-witch" }], + "headers": [ { - "name": "client_id", - "description": "client_id parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, + "name": "accept", + "value": "application/vnd.github.scarlet-witch-preview+json", + "required": true + } + ], + "parameters": [ { - "name": "access_token", - "description": "access_token parameter", + "name": "key", + "description": "key parameter", "in": "PATH", "type": "string", "required": true, @@ -867,7 +623,7 @@ "description": "response", "examples": [ { - "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\"],\"token\":\"abcdefgh12345678\",\"token_last_eight\":\"12345678\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" + "data": "{\"key\":\"contributor_covenant\",\"name\":\"Contributor Covenant\",\"url\":\"https://api.github.com/codes_of_conduct/contributor_covenant\",\"body\":\"# Contributor Covenant Code of Conduct\\n\\n## Our Pledge\\n\\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\\n\\n## Our Standards\\n\\nExamples of behavior that contributes to creating a positive environment include:\\n\\n* Using welcoming and inclusive language\\n* Being respectful of differing viewpoints and experiences\\n* Gracefully accepting constructive criticism\\n* Focusing on what is best for the community\\n* Showing empathy towards other community members\\n\\nExamples of unacceptable behavior by participants include:\\n\\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\\n* Trolling, insulting/derogatory comments, and personal or political attacks\\n* Public or private harassment\\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\\n* Other conduct which could reasonably be considered inappropriate in a professional setting\\n\\n## Our Responsibilities\\n\\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\\n to any instances of unacceptable behavior.\\n\\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\\n\\n## Scope\\n\\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\\n\\n## Enforcement\\n\\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\\n\\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\\n\\n## Attribution\\n\\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\\n\\n[homepage]: http://contributor-covenant.org\\n[version]: http://contributor-covenant.org/version/1/4/\\n\"}" } ] } @@ -875,22 +631,41 @@ "renamed": null }, { - "name": "Reset an authorization", - "scope": "oauthAuthorizations", - "id": "resetAuthorization", + "name": "Create a content attachment", + "scope": "apps", + "id": "createContentAttachment", "method": "POST", - "url": "/applications/{client_id}/tokens/{access_token}", - "isDeprecated": true, + "url": "/content_references/{content_reference_id}/attachments", + "isDeprecated": false, "isLegacy": false, - "description": "**Deprecation Notice:** GitHub will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nOAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the \"token\" property in the response because changes take effect immediately. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`.", - "documentationUrl": "https://developer.github.com/v3/apps/oauth_applications/#reset-an-authorization", - "previews": [], - "headers": [], + "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` of the content reference from the [`content_reference` event](https://developer.github.com/v3/activity/events/types/#contentreferenceevent) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://developer.github.com/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.\n\nThis example creates a content attachment for the domain `https://errors.ai/`.", + "documentationUrl": "https://developer.github.com/v3/apps/installations/#create-a-content-attachment", + "previews": [{ "name": "corsair" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.corsair-preview+json", + "required": true + } + ], "parameters": [ { - "name": "client_id", - "description": "client_id parameter", + "name": "content_reference_id", + "description": "content_reference_id parameter", "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "title", + "description": "The title of the content attachment displayed in the body or comment of an issue or pull request.", + "in": "BODY", "type": "string", "required": true, "enum": null, @@ -901,9 +676,9 @@ "deprecated": null }, { - "name": "access_token", - "description": "access_token parameter", - "in": "PATH", + "name": "body", + "description": "The body text of the content attachment displayed in the body or comment of an issue or pull request. This parameter supports markdown.", + "in": "BODY", "type": "string", "required": true, "enum": null, @@ -920,80 +695,48 @@ "description": "response", "examples": [ { - "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\"],\"token\":\"abcdefgh12345678\",\"token_last_eight\":\"12345678\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" + "data": "{\"id\":101,\"title\":\"[A-1234] Error found in core/models.py file'\",\"body\":\"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"}" } ] } ], - "renamed": { - "before": { "scope": "oauthAuthorizations", "id": "resetAuthorization" }, - "after": { "scope": "apps", "id": "resetAuthorization" }, - "date": "2019-11-05", - "note": "\"Reset an authorization\" has been moved from \"OAuth Authorizations\" to \"Apps\"" - } + "renamed": null }, { - "name": "Revoke an authorization for an application", - "scope": "apps", - "id": "revokeAuthorizationForApplication", - "method": "DELETE", - "url": "/applications/{client_id}/tokens/{access_token}", - "isDeprecated": true, + "name": "Get", + "scope": "emojis", + "id": "get", + "method": "GET", + "url": "/emojis", + "isDeprecated": false, "isLegacy": false, - "description": "**Deprecation Notice:** GitHub will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nOAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password.", - "documentationUrl": "https://developer.github.com/v3/apps/oauth_applications/#revoke-an-authorization-for-an-application", + "description": "Lists all the emojis available to use on GitHub.\n\n", + "documentationUrl": "https://developer.github.com/v3/emojis/#emojis", "previews": [], "headers": [], - "parameters": [ - { - "name": "client_id", - "description": "client_id parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "access_token", - "description": "access_token parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], + "parameters": [], "responses": [], "renamed": null }, { - "name": "Revoke an authorization for an application", - "scope": "oauthAuthorizations", - "id": "revokeAuthorizationForApplication", - "method": "DELETE", - "url": "/applications/{client_id}/tokens/{access_token}", - "isDeprecated": true, + "name": "List public events", + "scope": "activity", + "id": "listPublicEvents", + "method": "GET", + "url": "/events", + "isDeprecated": false, "isLegacy": false, - "description": "**Deprecation Notice:** GitHub will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nOAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password.", - "documentationUrl": "https://developer.github.com/v3/apps/oauth_applications/#revoke-an-authorization-for-an-application", + "description": "We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.", + "documentationUrl": "https://developer.github.com/v3/activity/events/#list-public-events", "previews": [], "headers": [], "parameters": [ { - "name": "client_id", - "description": "client_id parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -1002,11 +745,11 @@ "deprecated": null }, { - "name": "access_token", - "description": "access_token parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -1016,55 +759,28 @@ } ], "responses": [], - "renamed": { - "before": { - "scope": "oauthAuthorizations", - "id": "revokeAuthorizationForApplication" - }, - "after": { "scope": "apps", "id": "revokeAuthorizationForApplication" }, - "date": "2019-11-05", - "note": "\"Revoke an authorization for an application\" has been moved from \"OAuth Authorizations\" to \"Apps\"" - } + "renamed": null }, { - "name": "Get a single GitHub App", - "scope": "apps", - "id": "getBySlug", + "name": "List feeds", + "scope": "activity", + "id": "listFeeds", "method": "GET", - "url": "/apps/{app_slug}", + "url": "/feeds", "isDeprecated": false, "isLegacy": false, - "description": "**Note**: The `:app_slug` is just the URL-friendly name of your GitHub App. You can find this on the settings page for your GitHub App (e.g., `https://github.com/settings/apps/:app_slug`).\n\nIf the GitHub App you specify is public, you can access this endpoint without authenticating. If the GitHub App you specify is private, you must authenticate with a [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or an [installation access token](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "documentationUrl": "https://developer.github.com/v3/apps/#get-a-single-github-app", - "previews": [{ "name": "machine-man" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.machine-man-preview+json" - } - ], - "parameters": [ - { - "name": "app_slug", - "description": "app_slug parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], + "description": "GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user:\n\n* **Timeline**: The GitHub global public timeline\n* **User**: The public timeline for any user, using [URI template](https://developer.github.com/v3/#hypermedia)\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub.\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://developer.github.com/v3/#basic-authentication) since current feed URIs use the older, non revocable auth tokens.", + "documentationUrl": "https://developer.github.com/v3/activity/feeds/#list-feeds", + "previews": [], + "headers": [], + "parameters": [], "responses": [ { "code": 200, "description": "response", "examples": [ { - "data": "{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}" + "data": "{\"timeline_url\":\"https://github.com/timeline\",\"user_url\":\"https://github.com/{user}\",\"current_user_public_url\":\"https://github.com/octocat\",\"current_user_url\":\"https://github.com/octocat.private?token=abc123\",\"current_user_actor_url\":\"https://github.com/octocat.private.actor?token=abc123\",\"current_user_organization_url\":\"\",\"current_user_organization_urls\":[\"https://github.com/organizations/github/octocat.private.atom?token=abc123\"],\"security_advisories_url\":\"https://github.com/security-advisories\",\"_links\":{\"timeline\":{\"href\":\"https://github.com/timeline\",\"type\":\"application/atom+xml\"},\"user\":{\"href\":\"https://github.com/{user}\",\"type\":\"application/atom+xml\"},\"current_user_public\":{\"href\":\"https://github.com/octocat\",\"type\":\"application/atom+xml\"},\"current_user\":{\"href\":\"https://github.com/octocat.private?token=abc123\",\"type\":\"application/atom+xml\"},\"current_user_actor\":{\"href\":\"https://github.com/octocat.private.actor?token=abc123\",\"type\":\"application/atom+xml\"},\"current_user_organization\":{\"href\":\"\",\"type\":\"\"},\"current_user_organizations\":[{\"href\":\"https://github.com/organizations/github/octocat.private.atom?token=abc123\",\"type\":\"application/atom+xml\"}],\"security_advisories\":{\"href\":\"https://github.com/security-advisories\",\"type\":\"application/atom+xml\"}}}" } ] } @@ -1072,18 +788,31 @@ "renamed": null }, { - "name": "List your authorizations", - "scope": "oauthAuthorizations", - "id": "listAuthorizations", + "name": "List the authenticated user's gists or if called anonymously, this will return all public gists", + "scope": "gists", + "id": "list", "method": "GET", - "url": "/authorizations", - "isDeprecated": true, + "url": "/gists", + "isDeprecated": false, "isLegacy": false, - "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).", - "documentationUrl": "https://developer.github.com/v3/oauth_authorizations/#list-your-authorizations", + "description": "", + "documentationUrl": "https://developer.github.com/v3/gists/#list-a-users-gists", "previews": [], "headers": [], "parameters": [ + { + "name": "since", + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "per_page", "description": "Results per page (max 100)", @@ -1117,7 +846,7 @@ "description": "response", "examples": [ { - "data": "[{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\"],\"token\":\"\",\"token_last_eight\":\"12345678\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\"}]" + "data": "[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"truncated\":false}]" } ] } @@ -1125,36 +854,23 @@ "renamed": null }, { - "name": "Create a new authorization", - "scope": "oauthAuthorizations", - "id": "createAuthorization", + "name": "Create a gist", + "scope": "gists", + "id": "create", "method": "POST", - "url": "/authorizations", - "isDeprecated": true, + "url": "/gists", + "isDeprecated": false, "isLegacy": false, - "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\n**Warning:** Apps must use the [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nCreates OAuth tokens using [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication). If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://developer.github.com/v3/auth/#working-with-two-factor-authentication).\"\n\nTo create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use `fingerprint` to differentiate between them.\n\nYou can also create tokens on GitHub from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://help.github.com/articles/creating-an-access-token-for-command-line-use).\n\nOrganizations that enforce SAML SSO require personal access tokens to be whitelisted. Read more about whitelisting tokens in [the GitHub Help documentation](https://help.github.com/articles/about-identity-and-access-management-with-saml-single-sign-on).", - "documentationUrl": "https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization", + "description": "Allows you to add a new gist with one or more files.\n\n**Note:** Don't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.", + "documentationUrl": "https://developer.github.com/v3/gists/#create-a-gist", "previews": [], "headers": [], "parameters": [ { - "name": "scopes", - "description": "A list of scopes that this authorization is in.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "note", - "description": "A note to remind you what the OAuth token is for. Tokens not associated with a specific OAuth application (i.e. personal access tokens) must have a unique note.", + "name": "files", + "description": "The filenames and content of each file in the gist. The keys in the `files` object represent the filename and have the type `string`.", "in": "BODY", - "type": "string", + "type": "object", "required": true, "enum": null, "allowNull": false, @@ -1164,21 +880,8 @@ "deprecated": null }, { - "name": "note_url", - "description": "A URL to remind you what app the OAuth token is for.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "client_id", - "description": "The 20 character OAuth app client key for which to create the token.", + "name": "files.content", + "description": "The content of the file.", "in": "BODY", "type": "string", "required": false, @@ -1190,8 +893,8 @@ "deprecated": null }, { - "name": "client_secret", - "description": "The 40 character OAuth app client secret for which to create the token.", + "name": "description", + "description": "A descriptive name for this gist.", "in": "BODY", "type": "string", "required": false, @@ -1203,10 +906,10 @@ "deprecated": null }, { - "name": "fingerprint", - "description": "A unique string to distinguish an authorization from others created for the same client ID and user.", + "name": "public", + "description": "When `true`, the gist will be public and available for anyone to see.", "in": "BODY", - "type": "string", + "type": "boolean", "required": false, "enum": null, "allowNull": false, @@ -1222,7 +925,7 @@ "description": "response", "examples": [ { - "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\"],\"token\":\"abcdefgh12345678\",\"token_last_eight\":\"12345678\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"\"}" + "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167,\"truncated\":false,\"content\":\"class HelloWorld\\n def initialize(name)\\n @name = name.capitalize\\n end\\n def sayHi\\n puts \\\"Hello !\\\"\\n end\\nend\\n\\nhello = HelloWorld.new(\\\"World\\\")\\nhello.sayHi\"},\"hello_world.py\":{\"filename\":\"hello_world.py\",\"type\":\"application/x-python\",\"language\":\"Python\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/e29f3839074953e1cc2934867fa5f2d2/raw/99c1bf3a345505c2e6195198d5f8c36267de570b/hello_world.py\",\"size\":199,\"truncated\":false,\"content\":\"class HelloWorld:\\n\\n def __init__(self, name):\\n self.name = name.capitalize()\\n \\n def sayHi(self):\\n print \\\"Hello \\\" + self.name + \\\"!\\\"\\n\\nhello = HelloWorld(\\\"world\\\")\\nhello.sayHi()\"},\"hello_world_ruby.txt\":{\"filename\":\"hello_world_ruby.txt\",\"type\":\"text/plain\",\"language\":\"Text\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/e29f3839074953e1cc2934867fa5f2d2/raw/9e4544db60e01a261aac098592b11333704e9082/hello_world_ruby.txt\",\"size\":46,\"truncated\":false,\"content\":\"Run `ruby hello_world.rb` to print Hello World\"},\"hello_world_python.txt\":{\"filename\":\"hello_world_python.txt\",\"type\":\"text/plain\",\"language\":\"Text\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/e29f3839074953e1cc2934867fa5f2d2/raw/076b4b78c10c9b7e1e0b73ffb99631bfc948de3b/hello_world_python.txt\",\"size\":48,\"truncated\":false,\"content\":\"Run `python hello_world.py` to print Hello World\"}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"truncated\":false,\"forks\":[{\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"url\":\"https://api.github.com/gists/dee9c42e4998ce2ea439\",\"id\":\"dee9c42e4998ce2ea439\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}],\"history\":[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f\",\"version\":\"57a7f021a713b1c5a6a199b54cc514735d2d462f\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"change_status\":{\"deletions\":0,\"additions\":180,\"total\":180},\"committed_at\":\"2010-04-14T02:15:15Z\"}]}" } ] } @@ -1230,24 +933,24 @@ "renamed": null }, { - "name": "Get-or-create an authorization for a specific app", - "scope": "oauthAuthorizations", - "id": "getOrCreateAuthorizationForApp", - "method": "PUT", - "url": "/authorizations/clients/{client_id}", - "isDeprecated": true, + "name": "List all public gists", + "scope": "gists", + "id": "listPublic", + "method": "GET", + "url": "/gists/public", + "isDeprecated": false, "isLegacy": false, - "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\n**Warning:** Apps must use the [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nCreates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.\n\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://developer.github.com/v3/auth/#working-with-two-factor-authentication).\"\n\n**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).", - "documentationUrl": "https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app", + "description": "List all public gists sorted by most recently updated to least recently updated.\n\nNote: With [pagination](https://developer.github.com/v3/#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.", + "documentationUrl": "https://developer.github.com/v3/gists/#list-all-public-gists", "previews": [], "headers": [], "parameters": [ { - "name": "client_id", - "description": "client_id parameter", - "in": "PATH", + "name": "since", + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.", + "in": "QUERY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -1256,49 +959,10 @@ "deprecated": null }, { - "name": "client_secret", - "description": "The 40 character OAuth app client secret associated with the client ID specified in the URL.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "scopes", - "description": "A list of scopes that this authorization is in.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "note", - "description": "A note to remind you what the OAuth token is for.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "note_url", - "description": "A URL to remind you what app the OAuth token is for.", - "in": "BODY", - "type": "string", + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -1308,10 +972,10 @@ "deprecated": null }, { - "name": "fingerprint", - "description": "A unique string to distinguish an authorization from others created for the same client and user. If provided, this API is functionally equivalent to [Get-or-create an authorization for a specific app and fingerprint](https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint).", - "in": "BODY", - "type": "string", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -1324,19 +988,10 @@ "responses": [ { "code": 200, - "description": "Response if returning an existing token", - "examples": [ - { - "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\"],\"token\":\"\",\"token_last_eight\":\"12345678\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"\"}" - } - ] - }, - { - "code": 201, - "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).", + "description": "response", "examples": [ { - "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\"],\"token\":\"abcdefgh12345678\",\"token_last_eight\":\"12345678\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"\"}" + "data": "[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"truncated\":false}]" } ] } @@ -1344,62 +999,23 @@ "renamed": null }, { - "name": "Get-or-create an authorization for a specific app and fingerprint", - "scope": "oauthAuthorizations", - "id": "getOrCreateAuthorizationForAppAndFingerprint", - "method": "PUT", - "url": "/authorizations/clients/{client_id}/{fingerprint}", - "isDeprecated": true, + "name": "List starred gists", + "scope": "gists", + "id": "listStarred", + "method": "GET", + "url": "/gists/starred", + "isDeprecated": false, "isLegacy": false, - "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\n**Warning:** Apps must use the [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nThis method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.\n\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://developer.github.com/v3/auth/#working-with-two-factor-authentication).\"", - "documentationUrl": "https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint", + "description": "List the authenticated user's starred gists:", + "documentationUrl": "https://developer.github.com/v3/gists/#list-starred-gists", "previews": [], "headers": [], "parameters": [ { - "name": "client_id", - "description": "client_id parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "fingerprint", - "description": "fingerprint parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "client_secret", - "description": "The 40 character OAuth app client secret associated with the client ID specified in the URL.", - "in": "BODY", + "name": "since", + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.", + "in": "QUERY", "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "scopes", - "description": "A list of scopes that this authorization is in.", - "in": "BODY", - "type": "string[]", "required": false, "enum": null, "allowNull": false, @@ -1409,10 +1025,10 @@ "deprecated": null }, { - "name": "note", - "description": "A note to remind you what the OAuth token is for.", - "in": "BODY", - "type": "string", + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -1422,10 +1038,10 @@ "deprecated": null }, { - "name": "note_url", - "description": "A URL to remind you what app the OAuth token is for.", - "in": "BODY", - "type": "string", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -1438,19 +1054,10 @@ "responses": [ { "code": 200, - "description": "Response if returning an existing token", - "examples": [ - { - "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\"],\"token\":\"\",\"token_last_eight\":\"12345678\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\"}" - } - ] - }, - { - "code": 201, - "description": "Response if returning a new token", + "description": "response", "examples": [ { - "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\"],\"token\":\"abcdefgh12345678\",\"token_last_eight\":\"12345678\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\"}" + "data": "[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"truncated\":false}]" } ] } @@ -1458,21 +1065,21 @@ "renamed": null }, { - "name": "Get-or-create an authorization for a specific app and fingerprint", - "scope": "oauthAuthorizations", - "id": "getOrCreateAuthorizationForAppFingerprint", - "method": "PUT", - "url": "/authorizations/clients/{client_id}/{fingerprint}", - "isDeprecated": true, + "name": "Get a single gist", + "scope": "gists", + "id": "get", + "method": "GET", + "url": "/gists/{gist_id}", + "isDeprecated": false, "isLegacy": false, - "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\n**Warning:** Apps must use the [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nThis method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one.\n\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://developer.github.com/v3/auth/#working-with-two-factor-authentication).\"", - "documentationUrl": "https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint", + "description": "", + "documentationUrl": "https://developer.github.com/v3/gists/#get-a-single-gist", "previews": [], "headers": [], "parameters": [ { - "name": "client_id", - "description": "client_id parameter", + "name": "gist_id", + "description": "gist_id parameter", "in": "PATH", "type": "string", "required": true, @@ -1482,10 +1089,37 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ + { + "code": 200, + "description": "response", + "examples": [ + { + "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167,\"truncated\":false,\"content\":\"class HelloWorld\\n def initialize(name)\\n @name = name.capitalize\\n end\\n def sayHi\\n puts \\\"Hello !\\\"\\n end\\nend\\n\\nhello = HelloWorld.new(\\\"World\\\")\\nhello.sayHi\"},\"hello_world.py\":{\"filename\":\"hello_world.py\",\"type\":\"application/x-python\",\"language\":\"Python\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/e29f3839074953e1cc2934867fa5f2d2/raw/99c1bf3a345505c2e6195198d5f8c36267de570b/hello_world.py\",\"size\":199,\"truncated\":false,\"content\":\"class HelloWorld:\\n\\n def __init__(self, name):\\n self.name = name.capitalize()\\n \\n def sayHi(self):\\n print \\\"Hello \\\" + self.name + \\\"!\\\"\\n\\nhello = HelloWorld(\\\"world\\\")\\nhello.sayHi()\"},\"hello_world_ruby.txt\":{\"filename\":\"hello_world_ruby.txt\",\"type\":\"text/plain\",\"language\":\"Text\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/e29f3839074953e1cc2934867fa5f2d2/raw/9e4544db60e01a261aac098592b11333704e9082/hello_world_ruby.txt\",\"size\":46,\"truncated\":false,\"content\":\"Run `ruby hello_world.rb` to print Hello World\"},\"hello_world_python.txt\":{\"filename\":\"hello_world_python.txt\",\"type\":\"text/plain\",\"language\":\"Text\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/e29f3839074953e1cc2934867fa5f2d2/raw/076b4b78c10c9b7e1e0b73ffb99631bfc948de3b/hello_world_python.txt\",\"size\":48,\"truncated\":false,\"content\":\"Run `python hello_world.py` to print Hello World\"}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"truncated\":false,\"forks\":[{\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"url\":\"https://api.github.com/gists/dee9c42e4998ce2ea439\",\"id\":\"dee9c42e4998ce2ea439\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}],\"history\":[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f\",\"version\":\"57a7f021a713b1c5a6a199b54cc514735d2d462f\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"change_status\":{\"deletions\":0,\"additions\":180,\"total\":180},\"committed_at\":\"2010-04-14T02:15:15Z\"}]}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Edit a gist", + "scope": "gists", + "id": "update", + "method": "PATCH", + "url": "/gists/{gist_id}", + "isDeprecated": false, + "isLegacy": false, + "description": "Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.", + "documentationUrl": "https://developer.github.com/v3/gists/#edit-a-gist", + "previews": [], + "headers": [], + "parameters": [ { - "name": "fingerprint", - "description": "fingerprint parameter", + "name": "gist_id", + "description": "gist_id parameter", "in": "PATH", "type": "string", "required": true, @@ -1497,11 +1131,11 @@ "deprecated": null }, { - "name": "client_secret", - "description": "The 40 character OAuth app client secret associated with the client ID specified in the URL.", + "name": "description", + "description": "A descriptive name for this gist.", "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -1510,10 +1144,10 @@ "deprecated": null }, { - "name": "scopes", - "description": "A list of scopes that this authorization is in.", + "name": "files", + "description": "The filenames and content that make up this gist.", "in": "BODY", - "type": "string[]", + "type": "object", "required": false, "enum": null, "allowNull": false, @@ -1523,8 +1157,8 @@ "deprecated": null }, { - "name": "note", - "description": "A note to remind you what the OAuth token is for.", + "name": "files.content", + "description": "The updated content of the file.", "in": "BODY", "type": "string", "required": false, @@ -1536,8 +1170,8 @@ "deprecated": null }, { - "name": "note_url", - "description": "A URL to remind you what app the OAuth token is for.", + "name": "files.filename", + "description": "The new name for this file. To delete a file, set the value of the filename to `null`.", "in": "BODY", "type": "string", "required": false, @@ -1552,54 +1186,34 @@ "responses": [ { "code": 200, - "description": "Response if returning an existing token", - "examples": [ - { - "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\"],\"token\":\"\",\"token_last_eight\":\"12345678\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\"}" - } - ] - }, - { - "code": 201, - "description": "Response if returning a new token", + "description": "response", "examples": [ { - "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\"],\"token\":\"abcdefgh12345678\",\"token_last_eight\":\"12345678\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\"}" + "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167,\"truncated\":false,\"content\":\"class HelloWorld\\n def initialize(name)\\n @name = name.capitalize\\n end\\n def sayHi\\n puts \\\"Hello !\\\"\\n end\\nend\\n\\nhello = HelloWorld.new(\\\"World\\\")\\nhello.sayHi\"},\"hello_world.py\":{\"filename\":\"hello_world.py\",\"type\":\"application/x-python\",\"language\":\"Python\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/e29f3839074953e1cc2934867fa5f2d2/raw/99c1bf3a345505c2e6195198d5f8c36267de570b/hello_world.py\",\"size\":199,\"truncated\":false,\"content\":\"class HelloWorld:\\n\\n def __init__(self, name):\\n self.name = name.capitalize()\\n \\n def sayHi(self):\\n print \\\"Hello \\\" + self.name + \\\"!\\\"\\n\\nhello = HelloWorld(\\\"world\\\")\\nhello.sayHi()\"},\"hello_world.md\":{\"filename\":\"hello_world.md\",\"type\":\"text/plain\",\"language\":\"Markdown\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/8df0a8f642973cbda937bf542d37d4e9/raw/4221bb4b942568c4e3ab253022d2b7fec7844f21/hello_world.md\",\"size\":73,\"truncated\":false,\"content\":\"Run `ruby hello_world.rb` or `python hello_world.py` to print Hello World\"},\"new_file.txt\":{\"filename\":\"new_file.txt\",\"type\":\"text/plain\",\"language\":\"Text\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/8df0a8f642973cbda937bf542d37d4e9/raw/56ab7bdf864fa11c1e16acce2a5116171514d2d1/new_file.txt\",\"size\":31,\"truncated\":false,\"content\":\"This is a new placeholder file.\"}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"truncated\":false,\"forks\":[{\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"url\":\"https://api.github.com/gists/dee9c42e4998ce2ea439\",\"id\":\"dee9c42e4998ce2ea439\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}],\"history\":[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f\",\"version\":\"57a7f021a713b1c5a6a199b54cc514735d2d462f\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"change_status\":{\"deletions\":0,\"additions\":180,\"total\":180},\"committed_at\":\"2010-04-14T02:15:15Z\"}]}" } ] } ], - "renamed": { - "before": { - "scope": "oauthAuthorizations", - "id": "getOrCreateAuthorizationForAppFingerprint" - }, - "after": { - "scope": "oauthAuthorizations", - "id": "getOrCreateAuthorizationForAppAndFingerprint" - }, - "date": "2018-12-27", - "note": "`idName` changed for \"Get-or-create an authorization for a specific app and fingerprint\". It now includes `-and-`" - } + "renamed": null }, { - "name": "Get a single authorization", - "scope": "oauthAuthorizations", - "id": "getAuthorization", - "method": "GET", - "url": "/authorizations/{authorization_id}", - "isDeprecated": true, + "name": "Delete a gist", + "scope": "gists", + "id": "delete", + "method": "DELETE", + "url": "/gists/{gist_id}", + "isDeprecated": false, "isLegacy": false, - "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).", - "documentationUrl": "https://developer.github.com/v3/oauth_authorizations/#get-a-single-authorization", + "description": "", + "documentationUrl": "https://developer.github.com/v3/gists/#delete-a-gist", "previews": [], "headers": [], "parameters": [ { - "name": "authorization_id", - "description": "authorization_id parameter", + "name": "gist_id", + "description": "gist_id parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -1609,90 +1223,28 @@ "deprecated": null } ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\"],\"token\":\"\",\"token_last_eight\":\"12345678\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\"}" - } - ] - } - ], + "responses": [], "renamed": null }, { - "name": "Update an existing authorization", - "scope": "oauthAuthorizations", - "id": "updateAuthorization", - "method": "PATCH", - "url": "/authorizations/{authorization_id}", - "isDeprecated": true, + "name": "List comments on a gist", + "scope": "gists", + "id": "listComments", + "method": "GET", + "url": "/gists/{gist_id}/comments", + "isDeprecated": false, "isLegacy": false, - "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).\n\nIf you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see \"[Working with two-factor authentication](https://developer.github.com/v3/auth/#working-with-two-factor-authentication).\"\n\nYou can only send one of these scope keys at a time.", - "documentationUrl": "https://developer.github.com/v3/oauth_authorizations/#update-an-existing-authorization", + "description": "", + "documentationUrl": "https://developer.github.com/v3/gists/comments/#list-comments-on-a-gist", "previews": [], "headers": [], "parameters": [ { - "name": "authorization_id", - "description": "authorization_id parameter", + "name": "gist_id", + "description": "gist_id parameter", "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "scopes", - "description": "Replaces the authorization scopes with these.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "add_scopes", - "description": "A list of scopes to add to this authorization.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "remove_scopes", - "description": "A list of scopes to remove from this authorization.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "note", - "description": "A note to remind you what the OAuth token is for. Tokens not associated with a specific OAuth application (i.e. personal access tokens) must have a unique note.", - "in": "BODY", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -1701,10 +1253,10 @@ "deprecated": null }, { - "name": "note_url", - "description": "A URL to remind you what app the OAuth token is for.", - "in": "BODY", - "type": "string", + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -1714,10 +1266,10 @@ "deprecated": null }, { - "name": "fingerprint", - "description": "A unique string to distinguish an authorization from others created for the same client ID and user.", - "in": "BODY", - "type": "string", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -1733,7 +1285,7 @@ "description": "response", "examples": [ { - "data": "{\"id\":1,\"url\":\"https://api.github.com/authorizations/1\",\"scopes\":[\"public_repo\"],\"token\":\"\",\"token_last_eight\":\"12345678\",\"hashed_token\":\"25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8\",\"app\":{\"url\":\"http://my-github-app.com\",\"name\":\"my github app\",\"client_id\":\"abcde12345fghij67890\"},\"note\":\"optional note\",\"note_url\":\"http://optional/note/url\",\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\",\"fingerprint\":\"jklmnop12345678\"}" + "data": "[{\"id\":1,\"node_id\":\"MDExOkdpc3RDb21tZW50MQ==\",\"url\":\"https://api.github.com/gists/a6db0bec360bb87e9418/comments/1\",\"body\":\"Just commenting for the sake of commenting\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-18T23:23:56Z\",\"updated_at\":\"2011-04-18T23:23:56Z\"}]" } ] } @@ -1741,23 +1293,23 @@ "renamed": null }, { - "name": "Delete an authorization", - "scope": "oauthAuthorizations", - "id": "deleteAuthorization", - "method": "DELETE", - "url": "/authorizations/{authorization_id}", - "isDeprecated": true, + "name": "Create a comment", + "scope": "gists", + "id": "createComment", + "method": "POST", + "url": "/gists/{gist_id}/comments", + "isDeprecated": false, "isLegacy": false, - "description": "**Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api).", - "documentationUrl": "https://developer.github.com/v3/oauth_authorizations/#delete-an-authorization", + "description": "", + "documentationUrl": "https://developer.github.com/v3/gists/comments/#create-a-comment", "previews": [], "headers": [], "parameters": [ { - "name": "authorization_id", - "description": "authorization_id parameter", + "name": "gist_id", + "description": "gist_id parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -1765,36 +1317,28 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "List all codes of conduct", - "scope": "codesOfConduct", - "id": "listConductCodes", - "method": "GET", - "url": "/codes_of_conduct", - "isDeprecated": false, - "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/codes_of_conduct/#list-all-codes-of-conduct", - "previews": [{ "name": "scarlet-witch" }], - "headers": [ + }, { - "name": "accept", - "value": "application/vnd.github.scarlet-witch-preview+json" + "name": "body", + "description": "The comment text.", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], - "parameters": [], "responses": [ { - "code": 200, + "code": 201, "description": "response", "examples": [ { - "data": "[{\"key\":\"citizen_code_of_conduct\",\"name\":\"Citizen Code of Conduct\",\"url\":\"https://api.github.com/codes_of_conduct/citizen_code_of_conduct\"},{\"key\":\"contributor_covenant\",\"name\":\"Contributor Covenant\",\"url\":\"https://api.github.com/codes_of_conduct/contributor_covenant\"}]" + "data": "{\"id\":1,\"node_id\":\"MDExOkdpc3RDb21tZW50MQ==\",\"url\":\"https://api.github.com/gists/a6db0bec360bb87e9418/comments/1\",\"body\":\"Just commenting for the sake of commenting\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-18T23:23:56Z\",\"updated_at\":\"2011-04-18T23:23:56Z\"}" } ] } @@ -1802,26 +1346,21 @@ "renamed": null }, { - "name": "Get an individual code of conduct", - "scope": "codesOfConduct", - "id": "getConductCode", + "name": "Get a single comment", + "scope": "gists", + "id": "getComment", "method": "GET", - "url": "/codes_of_conduct/{key}", + "url": "/gists/{gist_id}/comments/{comment_id}", "isDeprecated": false, "isLegacy": false, "description": "", - "documentationUrl": "https://developer.github.com/v3/codes_of_conduct/#get-an-individual-code-of-conduct", - "previews": [{ "name": "scarlet-witch" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.scarlet-witch-preview+json" - } - ], + "documentationUrl": "https://developer.github.com/v3/gists/comments/#get-a-single-comment", + "previews": [], + "headers": [], "parameters": [ { - "name": "key", - "description": "key parameter", + "name": "gist_id", + "description": "gist_id parameter", "in": "PATH", "type": "string", "required": true, @@ -1831,6 +1370,19 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "comment_id", + "description": "comment_id parameter", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -1839,7 +1391,7 @@ "description": "response", "examples": [ { - "data": "{\"key\":\"contributor_covenant\",\"name\":\"Contributor Covenant\",\"url\":\"https://api.github.com/codes_of_conduct/contributor_covenant\",\"body\":\"# Contributor Covenant Code of Conduct\\n\\n## Our Pledge\\n\\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\\n\\n## Our Standards\\n\\nExamples of behavior that contributes to creating a positive environment include:\\n\\n* Using welcoming and inclusive language\\n* Being respectful of differing viewpoints and experiences\\n* Gracefully accepting constructive criticism\\n* Focusing on what is best for the community\\n* Showing empathy towards other community members\\n\\nExamples of unacceptable behavior by participants include:\\n\\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\\n* Trolling, insulting/derogatory comments, and personal or political attacks\\n* Public or private harassment\\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\\n* Other conduct which could reasonably be considered inappropriate in a professional setting\\n\\n## Our Responsibilities\\n\\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\\n to any instances of unacceptable behavior.\\n\\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\\n\\n## Scope\\n\\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\\n\\n## Enforcement\\n\\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\\n\\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\\n\\n## Attribution\\n\\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\\n\\n[homepage]: http://contributor-covenant.org\\n[version]: http://contributor-covenant.org/version/1/4/\\n\"}" + "data": "{\"id\":1,\"node_id\":\"MDExOkdpc3RDb21tZW50MQ==\",\"url\":\"https://api.github.com/gists/a6db0bec360bb87e9418/comments/1\",\"body\":\"Just commenting for the sake of commenting\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-18T23:23:56Z\",\"updated_at\":\"2011-04-18T23:23:56Z\"}" } ] } @@ -1847,28 +1399,23 @@ "renamed": null }, { - "name": "Create a content attachment", - "scope": "apps", - "id": "createContentAttachment", - "method": "POST", - "url": "/content_references/{content_reference_id}/attachments", + "name": "Edit a comment", + "scope": "gists", + "id": "updateComment", + "method": "PATCH", + "url": "/gists/{gist_id}/comments/{comment_id}", "isDeprecated": false, "isLegacy": false, - "description": "Creates an attachment under a content reference URL in the body or comment of an issue or pull request. Use the `id` of the content reference from the [`content_reference` event](https://developer.github.com/v3/activity/events/types/#contentreferenceevent) to create an attachment.\n\nThe app must create a content attachment within six hours of the content reference URL being posted. See \"[Using content attachments](https://developer.github.com/apps/using-content-attachments/)\" for details about content attachments.\n\nYou must use an [installation access token](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.\n\nThis example creates a content attachment for the domain `https://errors.ai/`.", - "documentationUrl": "https://developer.github.com/v3/apps/installations/#create-a-content-attachment", - "previews": [{ "name": "corsair" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.corsair-preview+json" - } - ], + "description": "", + "documentationUrl": "https://developer.github.com/v3/gists/comments/#edit-a-comment", + "previews": [], + "headers": [], "parameters": [ { - "name": "content_reference_id", - "description": "content_reference_id parameter", + "name": "gist_id", + "description": "gist_id parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -1878,10 +1425,10 @@ "deprecated": null }, { - "name": "title", - "description": "The title of the content attachment displayed in the body or comment of an issue or pull request.", - "in": "BODY", - "type": "string", + "name": "comment_id", + "description": "comment_id parameter", + "in": "PATH", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -1892,7 +1439,7 @@ }, { "name": "body", - "description": "The body text of the content attachment displayed in the body or comment of an issue or pull request. This parameter supports markdown.", + "description": "The comment text.", "in": "BODY", "type": "string", "required": true, @@ -1910,7 +1457,7 @@ "description": "response", "examples": [ { - "data": "{\"id\":101,\"title\":\"[A-1234] Error found in core/models.py file'\",\"body\":\"You have used an email that already exists for the user_email_uniq field.\\n ## DETAILS:\\n\\nThe (email)=(Octocat@github.com) already exists.\\n\\n The error was found in core/models.py in get_or_create_user at line 62.\\n\\n self.save()\"}" + "data": "{\"id\":1,\"node_id\":\"MDExOkdpc3RDb21tZW50MQ==\",\"url\":\"https://api.github.com/gists/a6db0bec360bb87e9418/comments/1\",\"body\":\"Just commenting for the sake of commenting\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-18T23:23:56Z\",\"updated_at\":\"2011-04-18T23:23:56Z\"}" } ] } @@ -1918,40 +1465,24 @@ "renamed": null }, { - "name": "Get", - "scope": "emojis", - "id": "get", - "method": "GET", - "url": "/emojis", - "isDeprecated": false, - "isLegacy": false, - "description": "Lists all the emojis available to use on GitHub.\n\n", - "documentationUrl": "https://developer.github.com/v3/emojis/#emojis", - "previews": [], - "headers": [], - "parameters": [], - "responses": [], - "renamed": null - }, - { - "name": "List public events", - "scope": "activity", - "id": "listPublicEvents", - "method": "GET", - "url": "/events", + "name": "Delete a comment", + "scope": "gists", + "id": "deleteComment", + "method": "DELETE", + "url": "/gists/{gist_id}/comments/{comment_id}", "isDeprecated": false, "isLegacy": false, - "description": "We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.", - "documentationUrl": "https://developer.github.com/v3/activity/events/#list-public-events", + "description": "", + "documentationUrl": "https://developer.github.com/v3/gists/comments/#delete-a-comment", "previews": [], "headers": [], "parameters": [ { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "gist_id", + "description": "gist_id parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -1960,11 +1491,11 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", + "name": "comment_id", + "description": "comment_id parameter", + "in": "PATH", "type": "integer", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -1977,50 +1508,24 @@ "renamed": null }, { - "name": "List feeds", - "scope": "activity", - "id": "listFeeds", - "method": "GET", - "url": "/feeds", - "isDeprecated": false, - "isLegacy": false, - "description": "GitHub provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user:\n\n* **Timeline**: The GitHub global public timeline\n* **User**: The public timeline for any user, using [URI template](https://developer.github.com/v3/#hypermedia)\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub.\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://developer.github.com/v3/#basic-authentication) since current feed URIs use the older, non revocable auth tokens.", - "documentationUrl": "https://developer.github.com/v3/activity/feeds/#list-feeds", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"timeline_url\":\"https://github.com/timeline\",\"user_url\":\"https://github.com/{user}\",\"current_user_public_url\":\"https://github.com/octocat\",\"current_user_url\":\"https://github.com/octocat.private?token=abc123\",\"current_user_actor_url\":\"https://github.com/octocat.private.actor?token=abc123\",\"current_user_organization_url\":\"\",\"current_user_organization_urls\":[\"https://github.com/organizations/github/octocat.private.atom?token=abc123\"],\"security_advisories_url\":\"https://github.com/security-advisories\",\"_links\":{\"timeline\":{\"href\":\"https://github.com/timeline\",\"type\":\"application/atom+xml\"},\"user\":{\"href\":\"https://github.com/{user}\",\"type\":\"application/atom+xml\"},\"current_user_public\":{\"href\":\"https://github.com/octocat\",\"type\":\"application/atom+xml\"},\"current_user\":{\"href\":\"https://github.com/octocat.private?token=abc123\",\"type\":\"application/atom+xml\"},\"current_user_actor\":{\"href\":\"https://github.com/octocat.private.actor?token=abc123\",\"type\":\"application/atom+xml\"},\"current_user_organization\":{\"href\":\"\",\"type\":\"\"},\"current_user_organizations\":[{\"href\":\"https://github.com/organizations/github/octocat.private.atom?token=abc123\",\"type\":\"application/atom+xml\"}],\"security_advisories\":{\"href\":\"https://github.com/security-advisories\",\"type\":\"application/atom+xml\"}}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List the authenticated user's gists or if called anonymously, this will return all public gists", + "name": "List gist commits", "scope": "gists", - "id": "list", + "id": "listCommits", "method": "GET", - "url": "/gists", + "url": "/gists/{gist_id}/commits", "isDeprecated": false, "isLegacy": false, "description": "", - "documentationUrl": "https://developer.github.com/v3/gists/#list-a-users-gists", + "documentationUrl": "https://developer.github.com/v3/gists/#list-gist-commits", "previews": [], "headers": [], "parameters": [ { - "name": "since", - "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.", - "in": "QUERY", + "name": "gist_id", + "description": "gist_id parameter", + "in": "PATH", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -2061,7 +1566,7 @@ "description": "response", "examples": [ { - "data": "[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"truncated\":false}]" + "data": "[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f\",\"version\":\"57a7f021a713b1c5a6a199b54cc514735d2d462f\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"change_status\":{\"deletions\":0,\"additions\":180,\"total\":180},\"committed_at\":\"2010-04-14T02:15:15Z\"}]" } ] } @@ -2069,63 +1574,24 @@ "renamed": null }, { - "name": "Create a gist", + "name": "Fork a gist", "scope": "gists", - "id": "create", + "id": "fork", "method": "POST", - "url": "/gists", + "url": "/gists/{gist_id}/forks", "isDeprecated": false, "isLegacy": false, - "description": "Allows you to add a new gist with one or more files.\n\n**Note:** Don't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.", - "documentationUrl": "https://developer.github.com/v3/gists/#create-a-gist", + "description": "**Note**: This was previously `/gists/:gist_id/fork`.", + "documentationUrl": "https://developer.github.com/v3/gists/#fork-a-gist", "previews": [], "headers": [], "parameters": [ { - "name": "files", - "description": "The filenames and content of each file in the gist. The keys in the `files` object represent the filename and have the type `string`.", - "in": "BODY", - "type": "object", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "files.content", - "description": "The content of the file.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "A descriptive name for this gist.", - "in": "BODY", + "name": "gist_id", + "description": "gist_id parameter", + "in": "PATH", "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "public", - "description": "When `true`, the gist will be public and available for anyone to see.", - "in": "BODY", - "type": "boolean", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -2140,7 +1606,7 @@ "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167,\"truncated\":false,\"content\":\"class HelloWorld\\n def initialize(name)\\n @name = name.capitalize\\n end\\n def sayHi\\n puts \\\"Hello !\\\"\\n end\\nend\\n\\nhello = HelloWorld.new(\\\"World\\\")\\nhello.sayHi\"},\"hello_world.py\":{\"filename\":\"hello_world.py\",\"type\":\"application/x-python\",\"language\":\"Python\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/e29f3839074953e1cc2934867fa5f2d2/raw/99c1bf3a345505c2e6195198d5f8c36267de570b/hello_world.py\",\"size\":199,\"truncated\":false,\"content\":\"class HelloWorld:\\n\\n def __init__(self, name):\\n self.name = name.capitalize()\\n \\n def sayHi(self):\\n print \\\"Hello \\\" + self.name + \\\"!\\\"\\n\\nhello = HelloWorld(\\\"world\\\")\\nhello.sayHi()\"},\"hello_world_ruby.txt\":{\"filename\":\"hello_world_ruby.txt\",\"type\":\"text/plain\",\"language\":\"Text\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/e29f3839074953e1cc2934867fa5f2d2/raw/9e4544db60e01a261aac098592b11333704e9082/hello_world_ruby.txt\",\"size\":46,\"truncated\":false,\"content\":\"Run `ruby hello_world.rb` to print Hello World\"},\"hello_world_python.txt\":{\"filename\":\"hello_world_python.txt\",\"type\":\"text/plain\",\"language\":\"Text\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/e29f3839074953e1cc2934867fa5f2d2/raw/076b4b78c10c9b7e1e0b73ffb99631bfc948de3b/hello_world_python.txt\",\"size\":48,\"truncated\":false,\"content\":\"Run `python hello_world.py` to print Hello World\"}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"truncated\":false,\"forks\":[{\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"url\":\"https://api.github.com/gists/dee9c42e4998ce2ea439\",\"id\":\"dee9c42e4998ce2ea439\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}],\"history\":[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f\",\"version\":\"57a7f021a713b1c5a6a199b54cc514735d2d462f\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"change_status\":{\"deletions\":0,\"additions\":180,\"total\":180},\"committed_at\":\"2010-04-14T02:15:15Z\"}]}" + "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"truncated\":false}" } ] } @@ -2148,24 +1614,24 @@ "renamed": null }, { - "name": "List all public gists", + "name": "List gist forks", "scope": "gists", - "id": "listPublic", + "id": "listForks", "method": "GET", - "url": "/gists/public", + "url": "/gists/{gist_id}/forks", "isDeprecated": false, "isLegacy": false, - "description": "List all public gists sorted by most recently updated to least recently updated.\n\nNote: With [pagination](https://developer.github.com/v3/#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.", - "documentationUrl": "https://developer.github.com/v3/gists/#list-all-public-gists", + "description": "", + "documentationUrl": "https://developer.github.com/v3/gists/#list-gist-forks", "previews": [], "headers": [], "parameters": [ { - "name": "since", - "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.", - "in": "QUERY", + "name": "gist_id", + "description": "gist_id parameter", + "in": "PATH", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -2206,7 +1672,7 @@ "description": "response", "examples": [ { - "data": "[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"truncated\":false}]" + "data": "[{\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"url\":\"https://api.github.com/gists/dee9c42e4998ce2ea439\",\"id\":\"dee9c42e4998ce2ea439\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}]" } ] } @@ -2214,50 +1680,54 @@ "renamed": null }, { - "name": "List starred gists", + "name": "Star a gist", "scope": "gists", - "id": "listStarred", - "method": "GET", - "url": "/gists/starred", + "id": "star", + "method": "PUT", + "url": "/gists/{gist_id}/star", "isDeprecated": false, "isLegacy": false, - "description": "List the authenticated user's starred gists:", - "documentationUrl": "https://developer.github.com/v3/gists/#list-starred-gists", + "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\"", + "documentationUrl": "https://developer.github.com/v3/gists/#star-a-gist", "previews": [], "headers": [], "parameters": [ { - "name": "since", - "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only gists updated at or after this time are returned.", - "in": "QUERY", + "name": "gist_id", + "description": "gist_id parameter", + "in": "PATH", "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [], + "renamed": null + }, + { + "name": "Unstar a gist", + "scope": "gists", + "id": "unstar", + "method": "DELETE", + "url": "/gists/{gist_id}/star", + "isDeprecated": false, + "isLegacy": false, + "description": "", + "documentationUrl": "https://developer.github.com/v3/gists/#unstar-a-gist", + "previews": [], + "headers": [], + "parameters": [ { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "gist_id", + "description": "gist_id parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -2266,29 +1736,19 @@ "deprecated": null } ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"truncated\":false}]" - } - ] - } - ], + "responses": [], "renamed": null }, { - "name": "Get a single gist", + "name": "Check if a gist is starred", "scope": "gists", - "id": "get", + "id": "checkIsStarred", "method": "GET", - "url": "/gists/{gist_id}", + "url": "/gists/{gist_id}/star", "isDeprecated": false, "isLegacy": false, "description": "", - "documentationUrl": "https://developer.github.com/v3/gists/#get-a-single-gist", + "documentationUrl": "https://developer.github.com/v3/gists/#check-if-a-gist-is-starred", "previews": [], "headers": [], "parameters": [ @@ -2306,29 +1766,19 @@ "deprecated": null } ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167,\"truncated\":false,\"content\":\"class HelloWorld\\n def initialize(name)\\n @name = name.capitalize\\n end\\n def sayHi\\n puts \\\"Hello !\\\"\\n end\\nend\\n\\nhello = HelloWorld.new(\\\"World\\\")\\nhello.sayHi\"},\"hello_world.py\":{\"filename\":\"hello_world.py\",\"type\":\"application/x-python\",\"language\":\"Python\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/e29f3839074953e1cc2934867fa5f2d2/raw/99c1bf3a345505c2e6195198d5f8c36267de570b/hello_world.py\",\"size\":199,\"truncated\":false,\"content\":\"class HelloWorld:\\n\\n def __init__(self, name):\\n self.name = name.capitalize()\\n \\n def sayHi(self):\\n print \\\"Hello \\\" + self.name + \\\"!\\\"\\n\\nhello = HelloWorld(\\\"world\\\")\\nhello.sayHi()\"},\"hello_world_ruby.txt\":{\"filename\":\"hello_world_ruby.txt\",\"type\":\"text/plain\",\"language\":\"Text\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/e29f3839074953e1cc2934867fa5f2d2/raw/9e4544db60e01a261aac098592b11333704e9082/hello_world_ruby.txt\",\"size\":46,\"truncated\":false,\"content\":\"Run `ruby hello_world.rb` to print Hello World\"},\"hello_world_python.txt\":{\"filename\":\"hello_world_python.txt\",\"type\":\"text/plain\",\"language\":\"Text\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/e29f3839074953e1cc2934867fa5f2d2/raw/076b4b78c10c9b7e1e0b73ffb99631bfc948de3b/hello_world_python.txt\",\"size\":48,\"truncated\":false,\"content\":\"Run `python hello_world.py` to print Hello World\"}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"truncated\":false,\"forks\":[{\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"url\":\"https://api.github.com/gists/dee9c42e4998ce2ea439\",\"id\":\"dee9c42e4998ce2ea439\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}],\"history\":[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f\",\"version\":\"57a7f021a713b1c5a6a199b54cc514735d2d462f\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"change_status\":{\"deletions\":0,\"additions\":180,\"total\":180},\"committed_at\":\"2010-04-14T02:15:15Z\"}]}" - } - ] - } - ], + "responses": [], "renamed": null }, { - "name": "Edit a gist", + "name": "Get a specific revision of a gist", "scope": "gists", - "id": "update", - "method": "PATCH", - "url": "/gists/{gist_id}", + "id": "getRevision", + "method": "GET", + "url": "/gists/{gist_id}/{sha}", "isDeprecated": false, "isLegacy": false, - "description": "Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.", - "documentationUrl": "https://developer.github.com/v3/gists/#edit-a-gist", + "description": "", + "documentationUrl": "https://developer.github.com/v3/gists/#get-a-specific-revision-of-a-gist", "previews": [], "headers": [], "parameters": [ @@ -2346,36 +1796,122 @@ "deprecated": null }, { - "name": "description", - "description": "A descriptive name for this gist.", - "in": "BODY", + "name": "sha", + "description": "sha parameter", + "in": "PATH", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "files", - "description": "The filenames and content that make up this gist.", - "in": "BODY", - "type": "object", - "required": false, + "code": 200, + "description": "response", + "examples": [ + { + "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167,\"truncated\":false,\"content\":\"class HelloWorld\\n def initialize(name)\\n @name = name.capitalize\\n end\\n def sayHi\\n puts \\\"Hello !\\\"\\n end\\nend\\n\\nhello = HelloWorld.new(\\\"World\\\")\\nhello.sayHi\"},\"hello_world.py\":{\"filename\":\"hello_world.py\",\"type\":\"application/x-python\",\"language\":\"Python\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/e29f3839074953e1cc2934867fa5f2d2/raw/99c1bf3a345505c2e6195198d5f8c36267de570b/hello_world.py\",\"size\":199,\"truncated\":false,\"content\":\"class HelloWorld:\\n\\n def __init__(self, name):\\n self.name = name.capitalize()\\n \\n def sayHi(self):\\n print \\\"Hello \\\" + self.name + \\\"!\\\"\\n\\nhello = HelloWorld(\\\"world\\\")\\nhello.sayHi()\"},\"hello_world_ruby.txt\":{\"filename\":\"hello_world_ruby.txt\",\"type\":\"text/plain\",\"language\":\"Text\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/e29f3839074953e1cc2934867fa5f2d2/raw/9e4544db60e01a261aac098592b11333704e9082/hello_world_ruby.txt\",\"size\":46,\"truncated\":false,\"content\":\"Run `ruby hello_world.rb` to print Hello World\"},\"hello_world_python.txt\":{\"filename\":\"hello_world_python.txt\",\"type\":\"text/plain\",\"language\":\"Text\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/e29f3839074953e1cc2934867fa5f2d2/raw/076b4b78c10c9b7e1e0b73ffb99631bfc948de3b/hello_world_python.txt\",\"size\":48,\"truncated\":false,\"content\":\"Run `python hello_world.py` to print Hello World\"}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"truncated\":false,\"forks\":[{\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"url\":\"https://api.github.com/gists/dee9c42e4998ce2ea439\",\"id\":\"dee9c42e4998ce2ea439\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}],\"history\":[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f\",\"version\":\"57a7f021a713b1c5a6a199b54cc514735d2d462f\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"change_status\":{\"deletions\":0,\"additions\":180,\"total\":180},\"committed_at\":\"2010-04-14T02:15:15Z\"}]}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Listing available templates", + "scope": "gitignore", + "id": "listTemplates", + "method": "GET", + "url": "/gitignore/templates", + "isDeprecated": false, + "isLegacy": false, + "description": "List all templates available to pass as an option when [creating a repository](https://developer.github.com/v3/repos/#create).", + "documentationUrl": "https://developer.github.com/v3/gitignore/#listing-available-templates", + "previews": [], + "headers": [], + "parameters": [], + "responses": [ + { + "code": 200, + "description": "response", + "examples": [ + { + "data": "[\"Actionscript\",\"Android\",\"AppceleratorTitanium\",\"Autotools\",\"Bancha\",\"C\",\"C++\"]" + } + ] + } + ], + "renamed": null + }, + { + "name": "Get a single template", + "scope": "gitignore", + "id": "getTemplate", + "method": "GET", + "url": "/gitignore/templates/{name}", + "isDeprecated": false, + "isLegacy": false, + "description": "The API also allows fetching the source of a single template.\n\nUse the raw [media type](https://developer.github.com/v3/media/) to get the raw contents.\n\n", + "documentationUrl": "https://developer.github.com/v3/gitignore/#get-a-single-template", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "name", + "description": "name parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "files.content", - "description": "The updated content of the file.", - "in": "BODY", - "type": "string", + "code": 200, + "description": "response", + "examples": [ + { + "data": "{\"name\":\"C\",\"source\":\"# Object files\\n*.o\\n\\n# Libraries\\n*.lib\\n*.a\\n\\n# Shared objects (inc. Windows DLLs)\\n*.dll\\n*.so\\n*.so.*\\n*.dylib\\n\\n# Executables\\n*.exe\\n*.out\\n*.app\\n\"}" + } + ] + } + ], + "renamed": null + }, + { + "name": "List repositories", + "scope": "apps", + "id": "listRepos", + "method": "GET", + "url": "/installation/repositories", + "isDeprecated": false, + "isLegacy": false, + "description": "List repositories that an installation can access.\n\nYou must use an [installation access token](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "documentationUrl": "https://developer.github.com/v3/apps/installations/#list-repositories", + "previews": [{ "name": "machine-man" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.machine-man-preview+json", + "required": true + } + ], + "parameters": [ + { + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -2385,10 +1921,10 @@ "deprecated": null }, { - "name": "files.filename", - "description": "The new name for this file. To delete a file, set the value of the filename to `null`.", - "in": "BODY", - "type": "string", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -2404,7 +1940,7 @@ "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167,\"truncated\":false,\"content\":\"class HelloWorld\\n def initialize(name)\\n @name = name.capitalize\\n end\\n def sayHi\\n puts \\\"Hello !\\\"\\n end\\nend\\n\\nhello = HelloWorld.new(\\\"World\\\")\\nhello.sayHi\"},\"hello_world.py\":{\"filename\":\"hello_world.py\",\"type\":\"application/x-python\",\"language\":\"Python\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/e29f3839074953e1cc2934867fa5f2d2/raw/99c1bf3a345505c2e6195198d5f8c36267de570b/hello_world.py\",\"size\":199,\"truncated\":false,\"content\":\"class HelloWorld:\\n\\n def __init__(self, name):\\n self.name = name.capitalize()\\n \\n def sayHi(self):\\n print \\\"Hello \\\" + self.name + \\\"!\\\"\\n\\nhello = HelloWorld(\\\"world\\\")\\nhello.sayHi()\"},\"hello_world.md\":{\"filename\":\"hello_world.md\",\"type\":\"text/plain\",\"language\":\"Markdown\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/8df0a8f642973cbda937bf542d37d4e9/raw/4221bb4b942568c4e3ab253022d2b7fec7844f21/hello_world.md\",\"size\":73,\"truncated\":false,\"content\":\"Run `ruby hello_world.rb` or `python hello_world.py` to print Hello World\"},\"new_file.txt\":{\"filename\":\"new_file.txt\",\"type\":\"text/plain\",\"language\":\"Text\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/8df0a8f642973cbda937bf542d37d4e9/raw/56ab7bdf864fa11c1e16acce2a5116171514d2d1/new_file.txt\",\"size\":31,\"truncated\":false,\"content\":\"This is a new placeholder file.\"}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"truncated\":false,\"forks\":[{\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"url\":\"https://api.github.com/gists/dee9c42e4998ce2ea439\",\"id\":\"dee9c42e4998ce2ea439\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}],\"history\":[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f\",\"version\":\"57a7f021a713b1c5a6a199b54cc514735d2d462f\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"change_status\":{\"deletions\":0,\"additions\":180,\"total\":180},\"committed_at\":\"2010-04-14T02:15:15Z\"}]}" + "data": "{\"total_count\":1,\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}]}" } ] } @@ -2412,54 +1948,111 @@ "renamed": null }, { - "name": "Delete a gist", - "scope": "gists", - "id": "delete", + "name": "Revoke an installation token", + "scope": "apps", + "id": "revokeInstallationToken", "method": "DELETE", - "url": "/gists/{gist_id}", + "url": "/installation/token", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/gists/#delete-a-gist", - "previews": [], - "headers": [], - "parameters": [ + "description": "Revokes the installation token you're using to authenticate as an installation and access this endpoint.\n\nOnce an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"[Create a new installation token](https://developer.github.com/v3/apps/#create-a-new-installation-token)\" endpoint.\n\nYou must use an [installation access token](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "documentationUrl": "https://developer.github.com/v3/apps/installations/#revoke-an-installation-token", + "previews": [{ "name": "gambit" }], + "headers": [ { - "name": "gist_id", - "description": "gist_id parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null + "name": "accept", + "value": "application/vnd.github.gambit-preview+json", + "required": true } ], + "parameters": [], "responses": [], "renamed": null }, { - "name": "List comments on a gist", - "scope": "gists", - "id": "listComments", + "name": "List all issues assigned to the authenticated user across all visible repositories including owned repositories, member repositories, and organization repositories", + "scope": "issues", + "id": "list", "method": "GET", - "url": "/gists/{gist_id}/comments", + "url": "/issues", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/gists/comments/#list-comments-on-a-gist", + "description": "**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key.\n\nBe aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests)\" endpoint.\n\n", + "documentationUrl": "https://developer.github.com/v3/issues/#list-issues", "previews": [], "headers": [], "parameters": [ { - "name": "gist_id", - "description": "gist_id parameter", - "in": "PATH", + "name": "filter", + "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all`: All issues the authenticated user can see, regardless of participation or creation", + "in": "QUERY", "type": "string", - "required": true, + "required": false, + "enum": ["assigned", "created", "mentioned", "subscribed", "all"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "state", + "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["open", "closed", "all"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "labels", + "description": "A list of comma separated label names. Example: `bug,ui,@high`", + "in": "QUERY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "sort", + "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["created", "updated", "comments"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "direction", + "description": "The direction of the sort. Can be either `asc` or `desc`.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["asc", "desc"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "since", + "description": "Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "QUERY", + "type": "string", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -2500,7 +2093,7 @@ "description": "response", "examples": [ { - "data": "[{\"id\":1,\"node_id\":\"MDExOkdpc3RDb21tZW50MQ==\",\"url\":\"https://api.github.com/gists/a6db0bec360bb87e9418/comments/1\",\"body\":\"Just commenting for the sake of commenting\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-18T23:23:56Z\",\"updated_at\":\"2011-04-18T23:23:56Z\"}]" + "data": "[{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}]" } ] } @@ -2508,52 +2101,25 @@ "renamed": null }, { - "name": "Create a comment", - "scope": "gists", - "id": "createComment", - "method": "POST", - "url": "/gists/{gist_id}/comments", + "name": "List commonly used licenses", + "scope": "licenses", + "id": "listCommonlyUsed", + "method": "GET", + "url": "/licenses", "isDeprecated": false, "isLegacy": false, "description": "", - "documentationUrl": "https://developer.github.com/v3/gists/comments/#create-a-comment", + "documentationUrl": "https://developer.github.com/v3/licenses/#list-commonly-used-licenses", "previews": [], "headers": [], - "parameters": [ - { - "name": "gist_id", - "description": "gist_id parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The comment text.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], + "parameters": [], "responses": [ { - "code": 201, + "code": 200, "description": "response", "examples": [ { - "data": "{\"id\":1,\"node_id\":\"MDExOkdpc3RDb21tZW50MQ==\",\"url\":\"https://api.github.com/gists/a6db0bec360bb87e9418/comments/1\",\"body\":\"Just commenting for the sake of commenting\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-18T23:23:56Z\",\"updated_at\":\"2011-04-18T23:23:56Z\"}" + "data": "[{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},{\"key\":\"lgpl-3.0\",\"name\":\"GNU Lesser General Public License v3.0\",\"spdx_id\":\"LGPL-3.0\",\"url\":\"https://api.github.com/licenses/lgpl-3.0\"},{\"key\":\"mpl-2.0\",\"name\":\"Mozilla Public License 2.0\",\"spdx_id\":\"MPL-2.0\",\"url\":\"https://api.github.com/licenses/mpl-2.0\"},{\"key\":\"agpl-3.0\",\"name\":\"GNU Affero General Public License v3.0\",\"spdx_id\":\"AGPL-3.0\",\"url\":\"https://api.github.com/licenses/agpl-3.0\"},{\"key\":\"unlicense\",\"name\":\"The Unlicense\",\"spdx_id\":\"Unlicense\",\"url\":\"https://api.github.com/licenses/unlicense\"},{\"key\":\"apache-2.0\",\"name\":\"Apache License 2.0\",\"spdx_id\":\"Apache-2.0\",\"url\":\"https://api.github.com/licenses/apache-2.0\"},{\"key\":\"gpl-3.0\",\"name\":\"GNU General Public License v3.0\",\"spdx_id\":\"GPL-3.0\",\"url\":\"https://api.github.com/licenses/gpl-3.0\"}]" } ] } @@ -2561,21 +2127,21 @@ "renamed": null }, { - "name": "Get a single comment", - "scope": "gists", - "id": "getComment", + "name": "Get an individual license", + "scope": "licenses", + "id": "get", "method": "GET", - "url": "/gists/{gist_id}/comments/{comment_id}", + "url": "/licenses/{license}", "isDeprecated": false, "isLegacy": false, "description": "", - "documentationUrl": "https://developer.github.com/v3/gists/comments/#get-a-single-comment", + "documentationUrl": "https://developer.github.com/v3/licenses/#get-an-individual-license", "previews": [], "headers": [], "parameters": [ { - "name": "gist_id", - "description": "gist_id parameter", + "name": "license", + "description": "license parameter", "in": "PATH", "type": "string", "required": true, @@ -2585,19 +2151,6 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "comment_id", - "description": "comment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null } ], "responses": [ @@ -2606,7 +2159,7 @@ "description": "response", "examples": [ { - "data": "{\"id\":1,\"node_id\":\"MDExOkdpc3RDb21tZW50MQ==\",\"url\":\"https://api.github.com/gists/a6db0bec360bb87e9418/comments/1\",\"body\":\"Just commenting for the sake of commenting\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-18T23:23:56Z\",\"updated_at\":\"2011-04-18T23:23:56Z\"}" + "data": "{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"http://choosealicense.com/licenses/mit/\",\"description\":\"A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty.\",\"implementation\":\"Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders.\",\"permissions\":[\"commercial-use\",\"modifications\",\"distribution\",\"sublicense\",\"private-use\"],\"conditions\":[\"include-copyright\"],\"limitations\":[\"no-liability\"],\"body\":\"\\n\\nThe MIT License (MIT)\\n\\nCopyright (c) [year] [fullname]\\n\\nPermission is hereby granted, free of charge, to any person obtaining a copy\\nof this software and associated documentation files (the \\\"Software\\\"), to deal\\nin the Software without restriction, including without limitation the rights\\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\\ncopies of the Software, and to permit persons to whom the Software is\\nfurnished to do so, subject to the following conditions:\\n\\nThe above copyright notice and this permission notice shall be included in all\\ncopies or substantial portions of the Software.\\n\\nTHE SOFTWARE IS PROVIDED \\\"AS IS\\\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\\nSOFTWARE.\\n\",\"featured\":true}" } ] } @@ -2614,22 +2167,22 @@ "renamed": null }, { - "name": "Edit a comment", - "scope": "gists", - "id": "updateComment", - "method": "PATCH", - "url": "/gists/{gist_id}/comments/{comment_id}", + "name": "Render an arbitrary Markdown document", + "scope": "markdown", + "id": "render", + "method": "POST", + "url": "/markdown", "isDeprecated": false, "isLegacy": false, "description": "", - "documentationUrl": "https://developer.github.com/v3/gists/comments/#edit-a-comment", + "documentationUrl": "https://developer.github.com/v3/markdown/#render-an-arbitrary-markdown-document", "previews": [], "headers": [], "parameters": [ { - "name": "gist_id", - "description": "gist_id parameter", - "in": "PATH", + "name": "text", + "description": "The Markdown text to render in HTML. Markdown content must be 400 KB or less.", + "in": "BODY", "type": "string", "required": true, "enum": null, @@ -2640,12 +2193,12 @@ "deprecated": null }, { - "name": "comment_id", - "description": "comment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, + "name": "mode", + "description": "The rendering mode. Can be either: \n\\* `markdown` to render a document in plain Markdown, just like README.md files are rendered. \n\\* `gfm` to render a document in [GitHub Flavored Markdown](https://github.github.com/gfm/), which creates links for user mentions as well as references to SHA-1 hashes, issues, and pull requests.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["markdown", "gfm"], "allowNull": false, "mapToData": null, "validation": null, @@ -2653,13 +2206,79 @@ "deprecated": null }, { - "name": "body", - "description": "The comment text.", + "name": "context", + "description": "The repository context to use when creating references in `gfm` mode. Omit this parameter when using `markdown` mode.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [], + "renamed": null + }, + { + "name": "Render a Markdown document in raw mode", + "scope": "markdown", + "id": "renderRaw", + "method": "POST", + "url": "/markdown/raw", + "isDeprecated": false, + "isLegacy": false, + "description": "You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.\n\n", + "documentationUrl": "https://developer.github.com/v3/markdown/#render-a-markdown-document-in-raw-mode", + "previews": [], + "headers": [ + { + "name": "content-type", + "value": "text/plain; charset=utf-8", + "required": false + } + ], + "parameters": [ + { + "name": "data", + "description": "data parameter", "in": "BODY", "type": "string", "required": true, "enum": null, "allowNull": false, + "mapToData": true, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [], + "renamed": null + }, + { + "name": "Check if a GitHub account is associated with any Marketplace listing", + "scope": "apps", + "id": "checkAccountIsAssociatedWithAny", + "method": "GET", + "url": "/marketplace_listing/accounts/{account_id}", + "isDeprecated": false, + "isLegacy": false, + "description": "Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://developer.github.com/v3/auth/#basic-authentication) with their client ID and client secret to access this endpoint.", + "documentationUrl": "https://developer.github.com/v3/apps/marketplace/#check-if-a-github-account-is-associated-with-any-marketplace-listing", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "account_id", + "description": "account_id parameter", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, "mapToData": null, "validation": null, "alias": null, @@ -2672,7 +2291,7 @@ "description": "response", "examples": [ { - "data": "{\"id\":1,\"node_id\":\"MDExOkdpc3RDb21tZW50MQ==\",\"url\":\"https://api.github.com/gists/a6db0bec360bb87e9418/comments/1\",\"body\":\"Just commenting for the sake of commenting\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-18T23:23:56Z\",\"updated_at\":\"2011-04-18T23:23:56Z\"}" + "data": "{\"url\":\"https://api.github.com/orgs/github\",\"type\":\"Organization\",\"id\":4,\"login\":\"github\",\"email\":null,\"organization_billing_email\":\"billing@github.com\",\"marketplace_pending_change\":{\"effective_date\":\"2017-11-11T00:00:00Z\",\"unit_count\":null,\"id\":77,\"plan\":{\"url\":\"https://api.github.com/marketplace_listing/plans/1111\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1111/accounts\",\"id\":1111,\"number\":2,\"name\":\"Startup\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":699,\"yearly_price_in_cents\":7870,\"price_model\":\"flat-rate\",\"has_free_trial\":true,\"state\":\"published\",\"unit_name\":null,\"bullets\":[\"Up to 10 private repositories\",\"3 concurrent builds\"]}},\"marketplace_purchase\":{\"billing_cycle\":\"monthly\",\"next_billing_date\":\"2017-11-11T00:00:00Z\",\"unit_count\":null,\"on_free_trial\":true,\"free_trial_ends_on\":\"2017-11-11T00:00:00Z\",\"updated_at\":\"2017-11-02T01:12:12Z\",\"plan\":{\"url\":\"https://api.github.com/marketplace_listing/plans/1313\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1313/accounts\",\"id\":1313,\"number\":3,\"name\":\"Pro\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":1099,\"yearly_price_in_cents\":11870,\"price_model\":\"flat-rate\",\"has_free_trial\":true,\"unit_name\":null,\"state\":\"published\",\"bullets\":[\"Up to 25 private repositories\",\"11 concurrent builds\"]}}}" } ] } @@ -2680,24 +2299,24 @@ "renamed": null }, { - "name": "Delete a comment", - "scope": "gists", - "id": "deleteComment", - "method": "DELETE", - "url": "/gists/{gist_id}/comments/{comment_id}", + "name": "List all plans for your Marketplace listing", + "scope": "apps", + "id": "listPlans", + "method": "GET", + "url": "/marketplace_listing/plans", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/gists/comments/#delete-a-comment", + "description": "GitHub Apps must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://developer.github.com/v3/auth/#basic-authentication) with their client ID and client secret to access this endpoint.", + "documentationUrl": "https://developer.github.com/v3/apps/marketplace/#list-all-plans-for-your-marketplace-listing", "previews": [], "headers": [], "parameters": [ { - "name": "gist_id", - "description": "gist_id parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -2706,11 +2325,11 @@ "deprecated": null }, { - "name": "comment_id", - "description": "comment_id parameter", - "in": "PATH", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", "type": "integer", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -2719,27 +2338,37 @@ "deprecated": null } ], - "responses": [], + "responses": [ + { + "code": 200, + "description": "response", + "examples": [ + { + "data": "[{\"url\":\"https://api.github.com/marketplace_listing/plans/1313\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1313/accounts\",\"id\":1313,\"number\":3,\"name\":\"Pro\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":1099,\"yearly_price_in_cents\":11870,\"price_model\":\"flat-rate\",\"has_free_trial\":true,\"unit_name\":null,\"state\":\"published\",\"bullets\":[\"Up to 25 private repositories\",\"11 concurrent builds\"]}]" + } + ] + } + ], "renamed": null }, { - "name": "List gist commits", - "scope": "gists", - "id": "listCommits", + "name": "List all GitHub accounts (user or organization) on a specific plan", + "scope": "apps", + "id": "listAccountsUserOrOrgOnPlan", "method": "GET", - "url": "/gists/{gist_id}/commits", + "url": "/marketplace_listing/plans/{plan_id}/accounts", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/gists/#list-gist-commits", + "description": "Returns any accounts associated with a plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://developer.github.com/v3/auth/#basic-authentication) with their client ID and client secret to access this endpoint.", + "documentationUrl": "https://developer.github.com/v3/apps/marketplace/#list-all-github-accounts-user-or-organization-on-a-specific-plan", "previews": [], "headers": [], "parameters": [ { - "name": "gist_id", - "description": "gist_id parameter", + "name": "plan_id", + "description": "plan_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -2748,6 +2377,32 @@ "alias": null, "deprecated": null }, + { + "name": "sort", + "description": "Sorts the GitHub accounts by the date they were created or last updated. Can be one of `created` or `updated`.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["created", "updated"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "direction", + "description": "To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["asc", "desc"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "per_page", "description": "Results per page (max 100)", @@ -2781,7 +2436,7 @@ "description": "response", "examples": [ { - "data": "[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f\",\"version\":\"57a7f021a713b1c5a6a199b54cc514735d2d462f\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"change_status\":{\"deletions\":0,\"additions\":180,\"total\":180},\"committed_at\":\"2010-04-14T02:15:15Z\"}]" + "data": "[{\"url\":\"https://api.github.com/orgs/github\",\"type\":\"Organization\",\"id\":4,\"login\":\"github\",\"email\":null,\"organization_billing_email\":\"billing@github.com\",\"marketplace_pending_change\":{\"effective_date\":\"2017-11-11T00:00:00Z\",\"unit_count\":null,\"id\":77,\"plan\":{\"url\":\"https://api.github.com/marketplace_listing/plans/1111\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1111/accounts\",\"id\":1111,\"number\":2,\"name\":\"Startup\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":699,\"yearly_price_in_cents\":7870,\"price_model\":\"flat-rate\",\"has_free_trial\":true,\"state\":\"published\",\"unit_name\":null,\"bullets\":[\"Up to 10 private repositories\",\"3 concurrent builds\"]}},\"marketplace_purchase\":{\"billing_cycle\":\"monthly\",\"next_billing_date\":\"2017-11-11T00:00:00Z\",\"unit_count\":null,\"on_free_trial\":true,\"free_trial_ends_on\":\"2017-11-11T00:00:00Z\",\"updated_at\":\"2017-11-02T01:12:12Z\",\"plan\":{\"url\":\"https://api.github.com/marketplace_listing/plans/1313\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1313/accounts\",\"id\":1313,\"number\":3,\"name\":\"Pro\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":1099,\"yearly_price_in_cents\":11870,\"price_model\":\"flat-rate\",\"has_free_trial\":true,\"unit_name\":null,\"state\":\"published\",\"bullets\":[\"Up to 25 private repositories\",\"11 concurrent builds\"]}}}]" } ] } @@ -2789,23 +2444,23 @@ "renamed": null }, { - "name": "Fork a gist", - "scope": "gists", - "id": "fork", - "method": "POST", - "url": "/gists/{gist_id}/forks", + "name": "Check if a GitHub account is associated with any Marketplace listing (stubbed)", + "scope": "apps", + "id": "checkAccountIsAssociatedWithAnyStubbed", + "method": "GET", + "url": "/marketplace_listing/stubbed/accounts/{account_id}", "isDeprecated": false, "isLegacy": false, - "description": "**Note**: This was previously `/gists/:gist_id/fork`.", - "documentationUrl": "https://developer.github.com/v3/gists/#fork-a-gist", + "description": "Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://developer.github.com/v3/auth/#basic-authentication) with their client ID and client secret to access this endpoint.", + "documentationUrl": "https://developer.github.com/v3/apps/marketplace/#check-if-a-github-account-is-associated-with-any-marketplace-listing", "previews": [], "headers": [], "parameters": [ { - "name": "gist_id", - "description": "gist_id parameter", + "name": "account_id", + "description": "account_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -2817,11 +2472,11 @@ ], "responses": [ { - "code": 201, + "code": 200, "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"truncated\":false}" + "data": "{\"url\":\"https://api.github.com/orgs/github\",\"type\":\"Organization\",\"id\":4,\"login\":\"github\",\"email\":null,\"organization_billing_email\":\"billing@github.com\",\"marketplace_pending_change\":{\"effective_date\":\"2017-11-11T00:00:00Z\",\"unit_count\":null,\"id\":77,\"plan\":{\"url\":\"https://api.github.com/marketplace_listing/plans/1111\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1111/accounts\",\"id\":1111,\"number\":2,\"name\":\"Startup\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":699,\"yearly_price_in_cents\":7870,\"price_model\":\"flat-rate\",\"has_free_trial\":true,\"state\":\"published\",\"unit_name\":null,\"bullets\":[\"Up to 10 private repositories\",\"3 concurrent builds\"]}},\"marketplace_purchase\":{\"billing_cycle\":\"monthly\",\"next_billing_date\":\"2017-11-11T00:00:00Z\",\"unit_count\":null,\"on_free_trial\":true,\"free_trial_ends_on\":\"2017-11-11T00:00:00Z\",\"updated_at\":\"2017-11-02T01:12:12Z\",\"plan\":{\"url\":\"https://api.github.com/marketplace_listing/plans/1313\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1313/accounts\",\"id\":1313,\"number\":3,\"name\":\"Pro\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":1099,\"yearly_price_in_cents\":11870,\"price_model\":\"flat-rate\",\"has_free_trial\":true,\"unit_name\":null,\"state\":\"published\",\"bullets\":[\"Up to 25 private repositories\",\"11 concurrent builds\"]}}}" } ] } @@ -2829,31 +2484,18 @@ "renamed": null }, { - "name": "List gist forks", - "scope": "gists", - "id": "listForks", + "name": "List all plans for your Marketplace listing (stubbed)", + "scope": "apps", + "id": "listPlansStubbed", "method": "GET", - "url": "/gists/{gist_id}/forks", + "url": "/marketplace_listing/stubbed/plans", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/gists/#list-gist-forks", + "description": "GitHub Apps must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://developer.github.com/v3/auth/#basic-authentication) with their client ID and client secret to access this endpoint.", + "documentationUrl": "https://developer.github.com/v3/apps/marketplace/#list-all-plans-for-your-marketplace-listing", "previews": [], "headers": [], "parameters": [ - { - "name": "gist_id", - "description": "gist_id parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, { "name": "per_page", "description": "Results per page (max 100)", @@ -2887,7 +2529,7 @@ "description": "response", "examples": [ { - "data": "[{\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"url\":\"https://api.github.com/gists/dee9c42e4998ce2ea439\",\"id\":\"dee9c42e4998ce2ea439\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}]" + "data": "[{\"url\":\"https://api.github.com/marketplace_listing/plans/1313\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1313/accounts\",\"id\":1313,\"number\":3,\"name\":\"Pro\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":1099,\"yearly_price_in_cents\":11870,\"price_model\":\"flat-rate\",\"has_free_trial\":true,\"unit_name\":null,\"state\":\"published\",\"bullets\":[\"Up to 25 private repositories\",\"11 concurrent builds\"]}]" } ] } @@ -2895,23 +2537,23 @@ "renamed": null }, { - "name": "Star a gist", - "scope": "gists", - "id": "star", - "method": "PUT", - "url": "/gists/{gist_id}/star", + "name": "List all GitHub accounts (user or organization) on a specific plan (stubbed)", + "scope": "apps", + "id": "listAccountsUserOrOrgOnPlanStubbed", + "method": "GET", + "url": "/marketplace_listing/stubbed/plans/{plan_id}/accounts", "isDeprecated": false, "isLegacy": false, - "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\"", - "documentationUrl": "https://developer.github.com/v3/gists/#star-a-gist", + "description": "Returns any accounts associated with a plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://developer.github.com/v3/auth/#basic-authentication) with their client ID and client secret to access this endpoint.", + "documentationUrl": "https://developer.github.com/v3/apps/marketplace/#list-all-github-accounts-user-or-organization-on-a-specific-plan", "previews": [], "headers": [], "parameters": [ { - "name": "gist_id", - "description": "gist_id parameter", + "name": "plan_id", + "description": "plan_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -2919,90 +2561,39 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "Unstar a gist", - "scope": "gists", - "id": "unstar", - "method": "DELETE", - "url": "/gists/{gist_id}/star", - "isDeprecated": false, - "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/gists/#unstar-a-gist", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "gist_id", - "description": "gist_id parameter", - "in": "PATH", + "name": "sort", + "description": "Sorts the GitHub accounts by the date they were created or last updated. Can be one of `created` or `updated`.", + "in": "QUERY", "type": "string", - "required": true, - "enum": null, + "required": false, + "enum": ["created", "updated"], "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "Check if a gist is starred", - "scope": "gists", - "id": "checkIsStarred", - "method": "GET", - "url": "/gists/{gist_id}/star", - "isDeprecated": false, - "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/gists/#check-if-a-gist-is-starred", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "gist_id", - "description": "gist_id parameter", - "in": "PATH", + "name": "direction", + "description": "To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter.", + "in": "QUERY", "type": "string", - "required": true, - "enum": null, + "required": false, + "enum": ["asc", "desc"], "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "Get a specific revision of a gist", - "scope": "gists", - "id": "getRevision", - "method": "GET", - "url": "/gists/{gist_id}/{sha}", - "isDeprecated": false, - "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/gists/#get-a-specific-revision-of-a-gist", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "gist_id", - "description": "gist_id parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -3011,11 +2602,11 @@ "deprecated": null }, { - "name": "sha", - "description": "sha parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -3030,7 +2621,7 @@ "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f\",\"forks_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\"commits_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\"id\":\"aa5a315d61ae9438b18d\",\"node_id\":\"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\"git_pull_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"git_push_url\":\"https://gist.github.com/aa5a315d61ae9438b18d.git\",\"html_url\":\"https://gist.github.com/aa5a315d61ae9438b18d\",\"files\":{\"hello_world.rb\":{\"filename\":\"hello_world.rb\",\"type\":\"application/x-ruby\",\"language\":\"Ruby\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\"size\":167,\"truncated\":false,\"content\":\"class HelloWorld\\n def initialize(name)\\n @name = name.capitalize\\n end\\n def sayHi\\n puts \\\"Hello !\\\"\\n end\\nend\\n\\nhello = HelloWorld.new(\\\"World\\\")\\nhello.sayHi\"},\"hello_world.py\":{\"filename\":\"hello_world.py\",\"type\":\"application/x-python\",\"language\":\"Python\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/e29f3839074953e1cc2934867fa5f2d2/raw/99c1bf3a345505c2e6195198d5f8c36267de570b/hello_world.py\",\"size\":199,\"truncated\":false,\"content\":\"class HelloWorld:\\n\\n def __init__(self, name):\\n self.name = name.capitalize()\\n \\n def sayHi(self):\\n print \\\"Hello \\\" + self.name + \\\"!\\\"\\n\\nhello = HelloWorld(\\\"world\\\")\\nhello.sayHi()\"},\"hello_world_ruby.txt\":{\"filename\":\"hello_world_ruby.txt\",\"type\":\"text/plain\",\"language\":\"Text\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/e29f3839074953e1cc2934867fa5f2d2/raw/9e4544db60e01a261aac098592b11333704e9082/hello_world_ruby.txt\",\"size\":46,\"truncated\":false,\"content\":\"Run `ruby hello_world.rb` to print Hello World\"},\"hello_world_python.txt\":{\"filename\":\"hello_world_python.txt\",\"type\":\"text/plain\",\"language\":\"Text\",\"raw_url\":\"https://gist.githubusercontent.com/octocat/e29f3839074953e1cc2934867fa5f2d2/raw/076b4b78c10c9b7e1e0b73ffb99631bfc948de3b/hello_world_python.txt\",\"size\":48,\"truncated\":false,\"content\":\"Run `python hello_world.py` to print Hello World\"}},\"public\":true,\"created_at\":\"2010-04-14T02:15:15Z\",\"updated_at\":\"2011-06-20T11:34:15Z\",\"description\":\"Hello World Examples\",\"comments\":0,\"user\":null,\"comments_url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"truncated\":false,\"forks\":[{\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"url\":\"https://api.github.com/gists/dee9c42e4998ce2ea439\",\"id\":\"dee9c42e4998ce2ea439\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}],\"history\":[{\"url\":\"https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f\",\"version\":\"57a7f021a713b1c5a6a199b54cc514735d2d462f\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"change_status\":{\"deletions\":0,\"additions\":180,\"total\":180},\"committed_at\":\"2010-04-14T02:15:15Z\"}]}" + "data": "[{\"url\":\"https://api.github.com/orgs/github\",\"type\":\"Organization\",\"id\":4,\"login\":\"github\",\"email\":null,\"organization_billing_email\":\"billing@github.com\",\"marketplace_pending_change\":{\"effective_date\":\"2017-11-11T00:00:00Z\",\"unit_count\":null,\"id\":77,\"plan\":{\"url\":\"https://api.github.com/marketplace_listing/plans/1111\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1111/accounts\",\"id\":1111,\"number\":2,\"name\":\"Startup\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":699,\"yearly_price_in_cents\":7870,\"price_model\":\"flat-rate\",\"has_free_trial\":true,\"state\":\"published\",\"unit_name\":null,\"bullets\":[\"Up to 10 private repositories\",\"3 concurrent builds\"]}},\"marketplace_purchase\":{\"billing_cycle\":\"monthly\",\"next_billing_date\":\"2017-11-11T00:00:00Z\",\"unit_count\":null,\"on_free_trial\":true,\"free_trial_ends_on\":\"2017-11-11T00:00:00Z\",\"updated_at\":\"2017-11-02T01:12:12Z\",\"plan\":{\"url\":\"https://api.github.com/marketplace_listing/plans/1313\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1313/accounts\",\"id\":1313,\"number\":3,\"name\":\"Pro\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":1099,\"yearly_price_in_cents\":11870,\"price_model\":\"flat-rate\",\"has_free_trial\":true,\"unit_name\":null,\"state\":\"published\",\"bullets\":[\"Up to 25 private repositories\",\"11 concurrent builds\"]}}}]" } ] } @@ -3038,15 +2629,15 @@ "renamed": null }, { - "name": "Listing available templates", - "scope": "gitignore", - "id": "listTemplates", + "name": "Get", + "scope": "meta", + "id": "get", "method": "GET", - "url": "/gitignore/templates", + "url": "/meta", "isDeprecated": false, "isLegacy": false, - "description": "List all templates available to pass as an option when [creating a repository](https://developer.github.com/v3/repos/#create).", - "documentationUrl": "https://developer.github.com/v3/gitignore/#listing-available-templates", + "description": "This endpoint provides a list of GitHub's IP addresses. For more information, see \"[About GitHub's IP addresses](https://help.github.com/articles/about-github-s-ip-addresses/).\"", + "documentationUrl": "https://developer.github.com/v3/meta/#meta", "previews": [], "headers": [], "parameters": [], @@ -3056,7 +2647,7 @@ "description": "response", "examples": [ { - "data": "[\"Actionscript\",\"Android\",\"AppceleratorTitanium\",\"Autotools\",\"Bancha\",\"C\",\"C++\"]" + "data": "{\"verifiable_password_authentication\":true,\"ssh_key_fingerprints\":{\"MD5_RSA\":\"16:27:ac:a5:76:28:2d:36:63:1b:56:4d:eb:df:a6:48\",\"MD5_DSA\":\"ad:1c:08:a4:40:e3:6f:9c:f5:66:26:5d:4b:33:5d:8c\",\"SHA256_RSA\":\"nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8\",\"SHA256_DSA\":\"br9IjFspm1vxR3iA35FWE+4VTyz1hYVLIE2t1/CeyWQ\"},\"hooks\":[\"192.30.252.0/22\"],\"web\":[\"192.30.252.0/22\",\"185.199.108.0/22\"],\"api\":[\"192.30.252.0/22\",\"185.199.108.0/22\"],\"git\":[\"192.30.252.0/22\"],\"pages\":[\"192.30.252.153/32\",\"192.30.252.154/32\"],\"importer\":[\"54.158.161.132\",\"54.226.70.38\"]}" } ] } @@ -3064,21 +2655,21 @@ "renamed": null }, { - "name": "Get a single template", - "scope": "gitignore", - "id": "getTemplate", + "name": "List public events for a network of repositories", + "scope": "activity", + "id": "listPublicEventsForRepoNetwork", "method": "GET", - "url": "/gitignore/templates/{name}", + "url": "/networks/{owner}/{repo}/events", "isDeprecated": false, "isLegacy": false, - "description": "The API also allows fetching the source of a single template.\n\nUse the raw [media type](https://developer.github.com/v3/media/) to get the raw contents.\n\n", - "documentationUrl": "https://developer.github.com/v3/gitignore/#get-a-single-template", + "description": "", + "documentationUrl": "https://developer.github.com/v3/activity/events/#list-public-events-for-a-network-of-repositories", "previews": [], "headers": [], "parameters": [ { - "name": "name", - "description": "name parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", "type": "string", "required": true, @@ -3088,39 +2679,20 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"name\":\"C\",\"source\":\"# Object files\\n*.o\\n\\n# Libraries\\n*.lib\\n*.a\\n\\n# Shared objects (inc. Windows DLLs)\\n*.dll\\n*.so\\n*.so.*\\n*.dylib\\n\\n# Executables\\n*.exe\\n*.out\\n*.app\\n\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List repositories", - "scope": "apps", - "id": "listRepos", - "method": "GET", - "url": "/installation/repositories", - "isDeprecated": false, - "isLegacy": false, - "description": "List repositories that an installation can access.\n\nYou must use an [installation access token](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "documentationUrl": "https://developer.github.com/v3/apps/installations/#list-repositories", - "previews": [{ "name": "machine-man" }], - "headers": [ + }, { - "name": "accept", - "value": "application/vnd.github.machine-man-preview+json" - } - ], - "parameters": [ + "name": "repo", + "description": "repo parameter", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "per_page", "description": "Results per page (max 100)", @@ -3148,84 +2720,27 @@ "deprecated": null } ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"total_count\":1,\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Revoke an installation token", - "scope": "apps", - "id": "revokeInstallationToken", - "method": "DELETE", - "url": "/installation/token", - "isDeprecated": false, - "isLegacy": false, - "description": "Revokes the installation token you're using to authenticate as an installation and access this endpoint.\n\nOnce an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"[Create a new installation token](https://developer.github.com/v3/apps/#create-a-new-installation-token)\" endpoint.\n\nYou must use an [installation access token](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", - "documentationUrl": "https://developer.github.com/v3/apps/installations/#revoke-an-installation-token", - "previews": [{ "name": "gambit" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.gambit-preview+json" - } - ], - "parameters": [], "responses": [], "renamed": null }, { - "name": "List all issues assigned to the authenticated user across all visible repositories including owned repositories, member repositories, and organization repositories", - "scope": "issues", - "id": "list", + "name": "List your notifications", + "scope": "activity", + "id": "listNotifications", "method": "GET", - "url": "/issues", + "url": "/notifications", "isDeprecated": false, "isLegacy": false, - "description": "**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key.\n\nBe aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests)\" endpoint.\n\n", - "documentationUrl": "https://developer.github.com/v3/issues/#list-issues", + "description": "List all notifications for the current user, sorted by most recently updated.\n\nThe following example uses the `since` parameter to list notifications that have been updated after the specified time.", + "documentationUrl": "https://developer.github.com/v3/activity/notifications/#list-your-notifications", "previews": [], "headers": [], "parameters": [ { - "name": "filter", - "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all`: All issues the authenticated user can see, regardless of participation or creation", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["assigned", "created", "mentioned", "subscribed", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["open", "closed", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "labels", - "description": "A list of comma separated label names. Example: `bug,ui,@high`", + "name": "all", + "description": "If `true`, show notifications marked as read.", "in": "QUERY", - "type": "string", + "type": "boolean", "required": false, "enum": null, "allowNull": false, @@ -3235,12 +2750,12 @@ "deprecated": null }, { - "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "name": "participating", + "description": "If `true`, only shows notifications in which the user is directly participating or mentioned.", "in": "QUERY", - "type": "string", + "type": "boolean", "required": false, - "enum": ["created", "updated", "comments"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -3248,12 +2763,12 @@ "deprecated": null }, { - "name": "direction", - "description": "The direction of the sort. Can be either `asc` or `desc`.", + "name": "since", + "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "QUERY", "type": "string", "required": false, - "enum": ["asc", "desc"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -3261,8 +2776,8 @@ "deprecated": null }, { - "name": "since", - "description": "Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "name": "before", + "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "QUERY", "type": "string", "required": false, @@ -3306,7 +2821,7 @@ "description": "response", "examples": [ { - "data": "[{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}]" + "data": "[{\"id\":\"1\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\"},\"subject\":{\"title\":\"Greetings\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/123\",\"latest_comment_url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/comments/123\",\"type\":\"Issue\"},\"reason\":\"subscribed\",\"unread\":true,\"updated_at\":\"2014-11-07T22:01:45Z\",\"last_read_at\":\"2014-11-07T22:01:45Z\",\"url\":\"https://api.github.com/notifications/threads/1\"}]" } ] } @@ -3314,434 +2829,21 @@ "renamed": null }, { - "name": "Search issues", - "scope": "search", - "id": "issuesLegacy", - "method": "GET", - "url": "/legacy/issues/search/{owner}/{repository}/{state}/{keyword}", - "isDeprecated": true, - "isLegacy": true, - "description": "Find issues by state and keyword.", - "documentationUrl": "https://developer.github.com/v3/search/legacy/#search-issues", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "owner parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repository", - "description": "repository parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "Indicates the state of the issues to return. Can be either `open` or `closed`.", - "in": "PATH", - "type": "string", - "required": true, - "enum": ["open", "closed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "keyword", - "description": "The search term.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"issues\":[{\"gravatar_id\":\"\",\"position\":10,\"number\":10,\"votes\":2,\"created_at\":\"2010-06-04T23:20:33Z\",\"comments\":5,\"body\":\"Issue body goes here\",\"title\":\"This is is the issue title\",\"updated_at\":\"2010-06-04T23:20:33Z\",\"html_url\":\"https://github.com/pengwynn/linkedin/issues/10\",\"user\":\"ckarbass\",\"labels\":[\"api\",\"feature request\",\"investigation\"],\"state\":\"open\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Search repositories", - "scope": "search", - "id": "reposLegacy", - "method": "GET", - "url": "/legacy/repos/search/{keyword}", - "isDeprecated": true, - "isLegacy": true, - "description": "Find repositories by keyword. Note, this legacy method does not follow the v3 pagination pattern. This method returns up to 100 results per page and pages can be fetched using the `start_page` parameter.", - "documentationUrl": "https://developer.github.com/v3/search/legacy/#search-repositories", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "keyword", - "description": "The search term.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "language", - "description": "Filter results by language.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "start_page", - "description": "The page number to fetch.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["stars", "forks", "updated"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "order", - "description": "The sort field. if `sort` param is provided. Can be either `asc` or `desc`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"repositories\":[{\"type\":\"repo\",\"created\":\"2011-09-05T11:07:54Z\",\"watchers\":2913,\"has_downloads\":true,\"username\":\"mathiasbynens\",\"homepage\":\"http://mths.be/dotfiles\",\"url\":\"https://github.com/mathiasbynens/dotfiles\",\"fork\":false,\"has_issues\":true,\"has_wiki\":false,\"forks\":520,\"size\":192,\"private\":false,\"followers\":2913,\"name\":\"dotfiles\",\"owner\":\"mathiasbynens\",\"open_issues\":12,\"pushed_at\":\"2012-06-05T03:37:13Z\",\"score\":3.289718,\"pushed\":\"2012-06-05T03:37:13Z\",\"description\":\"sensible hacker defaults for OS X\",\"language\":\"VimL\",\"created_at\":\"2011-09-05T11:07:54Z\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Email search", - "scope": "search", - "id": "emailLegacy", - "method": "GET", - "url": "/legacy/user/email/{email}", - "isDeprecated": true, - "isLegacy": true, - "description": "This API call is added for compatibility reasons only. There's no guarantee that full email searches will always be available. The `@` character in the address must be left unencoded. Searches only against public email addresses (as configured on the user's GitHub profile).", - "documentationUrl": "https://developer.github.com/v3/search/legacy/#email-search", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "email", - "description": "The email address.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"user\":{\"public_repo_count\":2,\"public_gist_count\":1,\"followers_count\":20,\"following_count\":0,\"created\":\"2009-10-05T01:32:06Z\",\"created_at\":\"2009-10-05T01:32:06Z\",\"name\":\"monalisa octocat\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"id\":2,\"login\":\"octocat\",\"type\":\"User\",\"gravatar_id\":\"\"}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Search users", - "scope": "search", - "id": "usersLegacy", - "method": "GET", - "url": "/legacy/user/search/{keyword}", - "isDeprecated": true, - "isLegacy": true, - "description": "Find users by keyword.", - "documentationUrl": "https://developer.github.com/v3/search/legacy/#search-users", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "keyword", - "description": "The search term.", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "start_page", - "description": "The page number to fetch.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["stars", "forks", "updated"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "order", - "description": "The sort field. if `sort` param is provided. Can be either `asc` or `desc`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"users\":[{\"gravatar_id\":\"\",\"name\":\"Hirotaka Kawata\",\"created_at\":\"2009-10-05T01:32:06Z\",\"location\":\"Tsukuba, Ibaraki, Japan\",\"public_repo_count\":8,\"followers\":10,\"language\":\"Python\",\"fullname\":\"Hirotaka Kawata\",\"username\":\"techno\",\"id\":\"user-135050\",\"repos\":8,\"type\":\"user\",\"followers_count\":10,\"login\":\"techno\",\"score\":4.2559967,\"created\":\"2009-10-05T01:32:06Z\"}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List commonly used licenses", - "scope": "licenses", - "id": "listCommonlyUsed", - "method": "GET", - "url": "/licenses", - "isDeprecated": false, - "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/licenses/#list-commonly-used-licenses", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},{\"key\":\"lgpl-3.0\",\"name\":\"GNU Lesser General Public License v3.0\",\"spdx_id\":\"LGPL-3.0\",\"url\":\"https://api.github.com/licenses/lgpl-3.0\"},{\"key\":\"mpl-2.0\",\"name\":\"Mozilla Public License 2.0\",\"spdx_id\":\"MPL-2.0\",\"url\":\"https://api.github.com/licenses/mpl-2.0\"},{\"key\":\"agpl-3.0\",\"name\":\"GNU Affero General Public License v3.0\",\"spdx_id\":\"AGPL-3.0\",\"url\":\"https://api.github.com/licenses/agpl-3.0\"},{\"key\":\"unlicense\",\"name\":\"The Unlicense\",\"spdx_id\":\"Unlicense\",\"url\":\"https://api.github.com/licenses/unlicense\"},{\"key\":\"apache-2.0\",\"name\":\"Apache License 2.0\",\"spdx_id\":\"Apache-2.0\",\"url\":\"https://api.github.com/licenses/apache-2.0\"},{\"key\":\"gpl-3.0\",\"name\":\"GNU General Public License v3.0\",\"spdx_id\":\"GPL-3.0\",\"url\":\"https://api.github.com/licenses/gpl-3.0\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List commonly used licenses", - "scope": "licenses", - "id": "list", - "method": "GET", - "url": "/licenses", - "isDeprecated": false, - "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/licenses/#list-commonly-used-licenses", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},{\"key\":\"lgpl-3.0\",\"name\":\"GNU Lesser General Public License v3.0\",\"spdx_id\":\"LGPL-3.0\",\"url\":\"https://api.github.com/licenses/lgpl-3.0\"},{\"key\":\"mpl-2.0\",\"name\":\"Mozilla Public License 2.0\",\"spdx_id\":\"MPL-2.0\",\"url\":\"https://api.github.com/licenses/mpl-2.0\"},{\"key\":\"agpl-3.0\",\"name\":\"GNU Affero General Public License v3.0\",\"spdx_id\":\"AGPL-3.0\",\"url\":\"https://api.github.com/licenses/agpl-3.0\"},{\"key\":\"unlicense\",\"name\":\"The Unlicense\",\"spdx_id\":\"Unlicense\",\"url\":\"https://api.github.com/licenses/unlicense\"},{\"key\":\"apache-2.0\",\"name\":\"Apache License 2.0\",\"spdx_id\":\"Apache-2.0\",\"url\":\"https://api.github.com/licenses/apache-2.0\"},{\"key\":\"gpl-3.0\",\"name\":\"GNU General Public License v3.0\",\"spdx_id\":\"GPL-3.0\",\"url\":\"https://api.github.com/licenses/gpl-3.0\"}]" - } - ] - } - ], - "renamed": { - "before": { "scope": "licenses", "id": "list" }, - "after": { "scope": "licenses", "id": "listCommonlyUsed" }, - "date": "2019-03-05", - "note": "\"List all licenses\" renamed to \"List commonly used licenses\"" - } - }, - { - "name": "Get an individual license", - "scope": "licenses", - "id": "get", - "method": "GET", - "url": "/licenses/{license}", - "isDeprecated": false, - "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/licenses/#get-an-individual-license", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "license", - "description": "license parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\",\"html_url\":\"http://choosealicense.com/licenses/mit/\",\"description\":\"A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty.\",\"implementation\":\"Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders.\",\"permissions\":[\"commercial-use\",\"modifications\",\"distribution\",\"sublicense\",\"private-use\"],\"conditions\":[\"include-copyright\"],\"limitations\":[\"no-liability\"],\"body\":\"\\n\\nThe MIT License (MIT)\\n\\nCopyright (c) [year] [fullname]\\n\\nPermission is hereby granted, free of charge, to any person obtaining a copy\\nof this software and associated documentation files (the \\\"Software\\\"), to deal\\nin the Software without restriction, including without limitation the rights\\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\\ncopies of the Software, and to permit persons to whom the Software is\\nfurnished to do so, subject to the following conditions:\\n\\nThe above copyright notice and this permission notice shall be included in all\\ncopies or substantial portions of the Software.\\n\\nTHE SOFTWARE IS PROVIDED \\\"AS IS\\\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\\nSOFTWARE.\\n\",\"featured\":true}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Render an arbitrary Markdown document", - "scope": "markdown", - "id": "render", - "method": "POST", - "url": "/markdown", + "name": "Mark as read", + "scope": "activity", + "id": "markAsRead", + "method": "PUT", + "url": "/notifications", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/markdown/#render-an-arbitrary-markdown-document", + "description": "Marks a notification as \"read\" removes it from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List your notifications](https://developer.github.com/v3/activity/notifications/#list-your-notifications) endpoint and pass the query parameter `all=false`.", + "documentationUrl": "https://developer.github.com/v3/activity/notifications/#mark-as-read", "previews": [], "headers": [], "parameters": [ { - "name": "text", - "description": "The Markdown text to render in HTML. Markdown content must be 400 KB or less.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "mode", - "description": "The rendering mode. Can be either: \n\\* `markdown` to render a document in plain Markdown, just like README.md files are rendered. \n\\* `gfm` to render a document in [GitHub Flavored Markdown](https://github.github.com/gfm/), which creates links for user mentions as well as references to SHA-1 hashes, issues, and pull requests.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["markdown", "gfm"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "context", - "description": "The repository context to use when creating references in `gfm` mode. Omit this parameter when using `markdown` mode.", + "name": "last_read_at", + "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.", "in": "BODY", "type": "string", "required": false, @@ -3757,53 +2859,21 @@ "renamed": null }, { - "name": "Render a Markdown document in raw mode", - "scope": "markdown", - "id": "renderRaw", - "method": "POST", - "url": "/markdown/raw", - "isDeprecated": false, - "isLegacy": false, - "description": "You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.\n\n", - "documentationUrl": "https://developer.github.com/v3/markdown/#render-a-markdown-document-in-raw-mode", - "previews": [], - "headers": [ - { "name": "content-type", "value": "text/plain; charset=utf-8" } - ], - "parameters": [ - { - "name": "data", - "description": "data parameter", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "Check if a GitHub account is associated with any Marketplace listing", - "scope": "apps", - "id": "checkAccountIsAssociatedWithAny", + "name": "View a single thread", + "scope": "activity", + "id": "getThread", "method": "GET", - "url": "/marketplace_listing/accounts/{account_id}", + "url": "/notifications/threads/{thread_id}", "isDeprecated": false, "isLegacy": false, - "description": "Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://developer.github.com/v3/auth/#basic-authentication) with their client ID and client secret to access this endpoint.", - "documentationUrl": "https://developer.github.com/v3/apps/marketplace/#check-if-a-github-account-is-associated-with-any-marketplace-listing", + "description": "", + "documentationUrl": "https://developer.github.com/v3/activity/notifications/#view-a-single-thread", "previews": [], "headers": [], "parameters": [ { - "name": "account_id", - "description": "account_id parameter", + "name": "thread_id", + "description": "thread_id parameter", "in": "PATH", "type": "integer", "required": true, @@ -3821,60 +2891,7 @@ "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/orgs/github\",\"type\":\"Organization\",\"id\":4,\"login\":\"github\",\"email\":null,\"organization_billing_email\":\"billing@github.com\",\"marketplace_pending_change\":{\"effective_date\":\"2017-11-11T00:00:00Z\",\"unit_count\":null,\"id\":77,\"plan\":{\"url\":\"https://api.github.com/marketplace_listing/plans/1111\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1111/accounts\",\"id\":1111,\"number\":2,\"name\":\"Startup\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":699,\"yearly_price_in_cents\":7870,\"price_model\":\"flat-rate\",\"has_free_trial\":true,\"state\":\"published\",\"unit_name\":null,\"bullets\":[\"Up to 10 private repositories\",\"3 concurrent builds\"]}},\"marketplace_purchase\":{\"billing_cycle\":\"monthly\",\"next_billing_date\":\"2017-11-11T00:00:00Z\",\"unit_count\":null,\"on_free_trial\":true,\"free_trial_ends_on\":\"2017-11-11T00:00:00Z\",\"updated_at\":\"2017-11-02T01:12:12Z\",\"plan\":{\"url\":\"https://api.github.com/marketplace_listing/plans/1313\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1313/accounts\",\"id\":1313,\"number\":3,\"name\":\"Pro\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":1099,\"yearly_price_in_cents\":11870,\"price_model\":\"flat-rate\",\"has_free_trial\":true,\"unit_name\":null,\"state\":\"published\",\"bullets\":[\"Up to 25 private repositories\",\"11 concurrent builds\"]}}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List all plans for your Marketplace listing", - "scope": "apps", - "id": "listPlans", - "method": "GET", - "url": "/marketplace_listing/plans", - "isDeprecated": false, - "isLegacy": false, - "description": "GitHub Apps must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://developer.github.com/v3/auth/#basic-authentication) with their client ID and client secret to access this endpoint.", - "documentationUrl": "https://developer.github.com/v3/apps/marketplace/#list-all-plans-for-your-marketplace-listing", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/marketplace_listing/plans/1313\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1313/accounts\",\"id\":1313,\"number\":3,\"name\":\"Pro\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":1099,\"yearly_price_in_cents\":11870,\"price_model\":\"flat-rate\",\"has_free_trial\":true,\"unit_name\":null,\"state\":\"published\",\"bullets\":[\"Up to 25 private repositories\",\"11 concurrent builds\"]}]" + "data": "{\"id\":\"1\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\"},\"subject\":{\"title\":\"Greetings\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/123\",\"latest_comment_url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/comments/123\",\"type\":\"Issue\"},\"reason\":\"subscribed\",\"unread\":true,\"updated_at\":\"2014-11-07T22:01:45Z\",\"last_read_at\":\"2014-11-07T22:01:45Z\",\"url\":\"https://api.github.com/notifications/threads/1\"}" } ] } @@ -3882,4601 +2899,23 @@ "renamed": null }, { - "name": "List all GitHub accounts (user or organization) on a specific plan", - "scope": "apps", - "id": "listAccountsUserOrOrgOnPlan", - "method": "GET", - "url": "/marketplace_listing/plans/{plan_id}/accounts", - "isDeprecated": false, - "isLegacy": false, - "description": "Returns any accounts associated with a plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://developer.github.com/v3/auth/#basic-authentication) with their client ID and client secret to access this endpoint.", - "documentationUrl": "https://developer.github.com/v3/apps/marketplace/#list-all-github-accounts-user-or-organization-on-a-specific-plan", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "plan_id", - "description": "plan_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "Sorts the GitHub accounts by the date they were created or last updated. Can be one of `created` or `updated`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/orgs/github\",\"type\":\"Organization\",\"id\":4,\"login\":\"github\",\"email\":null,\"organization_billing_email\":\"billing@github.com\",\"marketplace_pending_change\":{\"effective_date\":\"2017-11-11T00:00:00Z\",\"unit_count\":null,\"id\":77,\"plan\":{\"url\":\"https://api.github.com/marketplace_listing/plans/1111\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1111/accounts\",\"id\":1111,\"number\":2,\"name\":\"Startup\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":699,\"yearly_price_in_cents\":7870,\"price_model\":\"flat-rate\",\"has_free_trial\":true,\"state\":\"published\",\"unit_name\":null,\"bullets\":[\"Up to 10 private repositories\",\"3 concurrent builds\"]}},\"marketplace_purchase\":{\"billing_cycle\":\"monthly\",\"next_billing_date\":\"2017-11-11T00:00:00Z\",\"unit_count\":null,\"on_free_trial\":true,\"free_trial_ends_on\":\"2017-11-11T00:00:00Z\",\"updated_at\":\"2017-11-02T01:12:12Z\",\"plan\":{\"url\":\"https://api.github.com/marketplace_listing/plans/1313\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1313/accounts\",\"id\":1313,\"number\":3,\"name\":\"Pro\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":1099,\"yearly_price_in_cents\":11870,\"price_model\":\"flat-rate\",\"has_free_trial\":true,\"unit_name\":null,\"state\":\"published\",\"bullets\":[\"Up to 25 private repositories\",\"11 concurrent builds\"]}}}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Check if a GitHub account is associated with any Marketplace listing (stubbed)", - "scope": "apps", - "id": "checkAccountIsAssociatedWithAnyStubbed", - "method": "GET", - "url": "/marketplace_listing/stubbed/accounts/{account_id}", - "isDeprecated": false, - "isLegacy": false, - "description": "Shows whether the user or organization account actively subscribes to a plan listed by the authenticated GitHub App. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://developer.github.com/v3/auth/#basic-authentication) with their client ID and client secret to access this endpoint.", - "documentationUrl": "https://developer.github.com/v3/apps/marketplace/#check-if-a-github-account-is-associated-with-any-marketplace-listing", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "account_id", - "description": "account_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/orgs/github\",\"type\":\"Organization\",\"id\":4,\"login\":\"github\",\"email\":null,\"organization_billing_email\":\"billing@github.com\",\"marketplace_pending_change\":{\"effective_date\":\"2017-11-11T00:00:00Z\",\"unit_count\":null,\"id\":77,\"plan\":{\"url\":\"https://api.github.com/marketplace_listing/plans/1111\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1111/accounts\",\"id\":1111,\"number\":2,\"name\":\"Startup\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":699,\"yearly_price_in_cents\":7870,\"price_model\":\"flat-rate\",\"has_free_trial\":true,\"state\":\"published\",\"unit_name\":null,\"bullets\":[\"Up to 10 private repositories\",\"3 concurrent builds\"]}},\"marketplace_purchase\":{\"billing_cycle\":\"monthly\",\"next_billing_date\":\"2017-11-11T00:00:00Z\",\"unit_count\":null,\"on_free_trial\":true,\"free_trial_ends_on\":\"2017-11-11T00:00:00Z\",\"updated_at\":\"2017-11-02T01:12:12Z\",\"plan\":{\"url\":\"https://api.github.com/marketplace_listing/plans/1313\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1313/accounts\",\"id\":1313,\"number\":3,\"name\":\"Pro\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":1099,\"yearly_price_in_cents\":11870,\"price_model\":\"flat-rate\",\"has_free_trial\":true,\"unit_name\":null,\"state\":\"published\",\"bullets\":[\"Up to 25 private repositories\",\"11 concurrent builds\"]}}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List all plans for your Marketplace listing (stubbed)", - "scope": "apps", - "id": "listPlansStubbed", - "method": "GET", - "url": "/marketplace_listing/stubbed/plans", - "isDeprecated": false, - "isLegacy": false, - "description": "GitHub Apps must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://developer.github.com/v3/auth/#basic-authentication) with their client ID and client secret to access this endpoint.", - "documentationUrl": "https://developer.github.com/v3/apps/marketplace/#list-all-plans-for-your-marketplace-listing", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/marketplace_listing/plans/1313\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1313/accounts\",\"id\":1313,\"number\":3,\"name\":\"Pro\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":1099,\"yearly_price_in_cents\":11870,\"price_model\":\"flat-rate\",\"has_free_trial\":true,\"unit_name\":null,\"state\":\"published\",\"bullets\":[\"Up to 25 private repositories\",\"11 concurrent builds\"]}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List all GitHub accounts (user or organization) on a specific plan (stubbed)", - "scope": "apps", - "id": "listAccountsUserOrOrgOnPlanStubbed", - "method": "GET", - "url": "/marketplace_listing/stubbed/plans/{plan_id}/accounts", - "isDeprecated": false, - "isLegacy": false, - "description": "Returns any accounts associated with a plan, including free plans. For per-seat pricing, you see the list of accounts that have purchased the plan, including the number of seats purchased. When someone submits a plan change that won't be processed until the end of their billing cycle, you will also see the upcoming pending change.\n\nGitHub Apps must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. OAuth Apps must use [basic authentication](https://developer.github.com/v3/auth/#basic-authentication) with their client ID and client secret to access this endpoint.", - "documentationUrl": "https://developer.github.com/v3/apps/marketplace/#list-all-github-accounts-user-or-organization-on-a-specific-plan", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "plan_id", - "description": "plan_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "Sorts the GitHub accounts by the date they were created or last updated. Can be one of `created` or `updated`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "To return the oldest accounts first, set to `asc`. Can be one of `asc` or `desc`. Ignored without the `sort` parameter.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/orgs/github\",\"type\":\"Organization\",\"id\":4,\"login\":\"github\",\"email\":null,\"organization_billing_email\":\"billing@github.com\",\"marketplace_pending_change\":{\"effective_date\":\"2017-11-11T00:00:00Z\",\"unit_count\":null,\"id\":77,\"plan\":{\"url\":\"https://api.github.com/marketplace_listing/plans/1111\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1111/accounts\",\"id\":1111,\"number\":2,\"name\":\"Startup\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":699,\"yearly_price_in_cents\":7870,\"price_model\":\"flat-rate\",\"has_free_trial\":true,\"state\":\"published\",\"unit_name\":null,\"bullets\":[\"Up to 10 private repositories\",\"3 concurrent builds\"]}},\"marketplace_purchase\":{\"billing_cycle\":\"monthly\",\"next_billing_date\":\"2017-11-11T00:00:00Z\",\"unit_count\":null,\"on_free_trial\":true,\"free_trial_ends_on\":\"2017-11-11T00:00:00Z\",\"updated_at\":\"2017-11-02T01:12:12Z\",\"plan\":{\"url\":\"https://api.github.com/marketplace_listing/plans/1313\",\"accounts_url\":\"https://api.github.com/marketplace_listing/plans/1313/accounts\",\"id\":1313,\"number\":3,\"name\":\"Pro\",\"description\":\"A professional-grade CI solution\",\"monthly_price_in_cents\":1099,\"yearly_price_in_cents\":11870,\"price_model\":\"flat-rate\",\"has_free_trial\":true,\"unit_name\":null,\"state\":\"published\",\"bullets\":[\"Up to 25 private repositories\",\"11 concurrent builds\"]}}}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get", - "scope": "meta", - "id": "get", - "method": "GET", - "url": "/meta", - "isDeprecated": false, - "isLegacy": false, - "description": "This endpoint provides a list of GitHub's IP addresses. For more information, see \"[About GitHub's IP addresses](https://help.github.com/articles/about-github-s-ip-addresses/).\"", - "documentationUrl": "https://developer.github.com/v3/meta/#meta", - "previews": [], - "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"verifiable_password_authentication\":true,\"ssh_key_fingerprints\":{\"MD5_RSA\":\"16:27:ac:a5:76:28:2d:36:63:1b:56:4d:eb:df:a6:48\",\"MD5_DSA\":\"ad:1c:08:a4:40:e3:6f:9c:f5:66:26:5d:4b:33:5d:8c\",\"SHA256_RSA\":\"nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8\",\"SHA256_DSA\":\"br9IjFspm1vxR3iA35FWE+4VTyz1hYVLIE2t1/CeyWQ\"},\"hooks\":[\"192.30.252.0/22\"],\"web\":[\"192.30.252.0/22\",\"185.199.108.0/22\"],\"api\":[\"192.30.252.0/22\",\"185.199.108.0/22\"],\"git\":[\"192.30.252.0/22\"],\"pages\":[\"192.30.252.153/32\",\"192.30.252.154/32\"],\"importer\":[\"54.158.161.132\",\"54.226.70.38\"]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List public events for a network of repositories", - "scope": "activity", - "id": "listPublicEventsForRepoNetwork", - "method": "GET", - "url": "/networks/{owner}/{repo}/events", - "isDeprecated": false, - "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/activity/events/#list-public-events-for-a-network-of-repositories", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "owner parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "repo parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "List your notifications", - "scope": "activity", - "id": "listNotifications", - "method": "GET", - "url": "/notifications", - "isDeprecated": false, - "isLegacy": false, - "description": "List all notifications for the current user, sorted by most recently updated.\n\nThe following example uses the `since` parameter to list notifications that have been updated after the specified time.", - "documentationUrl": "https://developer.github.com/v3/activity/notifications/#list-your-notifications", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "all", - "description": "If `true`, show notifications marked as read.", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "participating", - "description": "If `true`, only shows notifications in which the user is directly participating or mentioned.", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "before", - "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"id\":\"1\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\"},\"subject\":{\"title\":\"Greetings\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/123\",\"latest_comment_url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/comments/123\",\"type\":\"Issue\"},\"reason\":\"subscribed\",\"unread\":true,\"updated_at\":\"2014-11-07T22:01:45Z\",\"last_read_at\":\"2014-11-07T22:01:45Z\",\"url\":\"https://api.github.com/notifications/threads/1\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Mark as read", - "scope": "activity", - "id": "markAsRead", - "method": "PUT", - "url": "/notifications", - "isDeprecated": false, - "isLegacy": false, - "description": "Marks a notification as \"read\" removes it from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List your notifications](https://developer.github.com/v3/activity/notifications/#list-your-notifications) endpoint and pass the query parameter `all=false`.", - "documentationUrl": "https://developer.github.com/v3/activity/notifications/#mark-as-read", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "last_read_at", - "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "View a single thread", - "scope": "activity", - "id": "getThread", - "method": "GET", - "url": "/notifications/threads/{thread_id}", - "isDeprecated": false, - "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/activity/notifications/#view-a-single-thread", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "thread_id", - "description": "thread_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"id\":\"1\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\"},\"subject\":{\"title\":\"Greetings\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/123\",\"latest_comment_url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/comments/123\",\"type\":\"Issue\"},\"reason\":\"subscribed\",\"unread\":true,\"updated_at\":\"2014-11-07T22:01:45Z\",\"last_read_at\":\"2014-11-07T22:01:45Z\",\"url\":\"https://api.github.com/notifications/threads/1\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Mark a thread as read", - "scope": "activity", - "id": "markThreadAsRead", - "method": "PATCH", - "url": "/notifications/threads/{thread_id}", - "isDeprecated": false, - "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/activity/notifications/#mark-a-thread-as-read", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "thread_id", - "description": "thread_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "Get a thread subscription", - "scope": "activity", - "id": "getThreadSubscription", - "method": "GET", - "url": "/notifications/threads/{thread_id}/subscription", - "isDeprecated": false, - "isLegacy": false, - "description": "This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://developer.github.com/v3/activity/watching/#get-a-repository-subscription).\n\nNote that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread.", - "documentationUrl": "https://developer.github.com/v3/activity/notifications/#get-a-thread-subscription", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "thread_id", - "description": "thread_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"subscribed\":true,\"ignored\":false,\"reason\":null,\"created_at\":\"2012-10-06T21:34:12Z\",\"url\":\"https://api.github.com/notifications/threads/1/subscription\",\"thread_url\":\"https://api.github.com/notifications/threads/1\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Set a thread subscription", - "scope": "activity", - "id": "setThreadSubscription", - "method": "PUT", - "url": "/notifications/threads/{thread_id}/subscription", - "isDeprecated": false, - "isLegacy": false, - "description": "This lets you subscribe or unsubscribe from a conversation.", - "documentationUrl": "https://developer.github.com/v3/activity/notifications/#set-a-thread-subscription", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "thread_id", - "description": "thread_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ignored", - "description": "Unsubscribes and subscribes you to a conversation. Set `ignored` to `true` to block all notifications from this thread.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"subscribed\":true,\"ignored\":false,\"reason\":null,\"created_at\":\"2012-10-06T21:34:12Z\",\"url\":\"https://api.github.com/notifications/threads/1/subscription\",\"thread_url\":\"https://api.github.com/notifications/threads/1\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Delete a thread subscription", - "scope": "activity", - "id": "deleteThreadSubscription", - "method": "DELETE", - "url": "/notifications/threads/{thread_id}/subscription", - "isDeprecated": false, - "isLegacy": false, - "description": "Mutes all future notifications for a conversation until you comment on the thread or get **@mention**ed.", - "documentationUrl": "https://developer.github.com/v3/activity/notifications/#delete-a-thread-subscription", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "thread_id", - "description": "thread_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "List all organizations", - "scope": "orgs", - "id": "list", - "method": "GET", - "url": "/organizations", - "isDeprecated": false, - "isLegacy": false, - "description": "Lists all organizations, in the order that they were created on GitHub.\n\n**Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://developer.github.com/v3/#link-header) to get the URL for the next page of organizations.", - "documentationUrl": "https://developer.github.com/v3/orgs/#list-all-organizations", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "since", - "description": "The integer ID of the last organization that you've seen.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get an organization", - "scope": "orgs", - "id": "get", - "method": "GET", - "url": "/orgs/{org}", - "isDeprecated": false, - "isLegacy": false, - "description": "To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://help.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nGitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub plan. See \"[Authenticating with GitHub Apps](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/)\" for details. For an example response, see \"[Response with GitHub plan information](https://developer.github.com/v3/orgs/#response-with-github-plan-information).\"", - "documentationUrl": "https://developer.github.com/v3/orgs/#get-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"is_verified\":true,\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"type\":\"Organization\",\"total_private_repos\":100,\"owned_private_repos\":100,\"private_gists\":81,\"disk_usage\":10000,\"collaborators\":8,\"billing_email\":\"support@github.com\",\"plan\":{\"name\":\"Medium\",\"space\":400,\"private_repos\":20},\"default_repository_permission\":\"read\",\"members_can_create_repositories\":true,\"two_factor_requirement_enabled\":true,\"members_allowed_repository_creation_type\":\"all\",\"members_can_create_public_repositories\":false,\"members_can_create_private_repositories\":false,\"members_can_create_internal_repositories\":false}" - }, - { - "data": "{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"is_verified\":true,\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"type\":\"Organization\",\"plan\":{\"name\":\"team\",\"space\":976562499,\"private_repos\":999999,\"filled_seats\":4,\"seats\":5}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Edit an organization", - "scope": "orgs", - "id": "update", - "method": "PATCH", - "url": "/orgs/{org}", - "isDeprecated": false, - "isLegacy": false, - "description": "\n\n**Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nEnables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges.", - "documentationUrl": "https://developer.github.com/v3/orgs/#edit-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "billing_email", - "description": "Billing email address. This address is not publicized.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "company", - "description": "The company name.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "email", - "description": "The publicly visible email address.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "location", - "description": "The location.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The shorthand name of the company.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "The description of the company.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "has_organization_projects", - "description": "Toggles whether an organization can use organization projects.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "has_repository_projects", - "description": "Toggles whether repositories that belong to the organization can use repository projects.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "default_repository_permission", - "description": "Default permission level members have for organization repositories: \n\\* `read` - can pull, but not push to or administer this repository. \n\\* `write` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push, and administer this repository. \n\\* `none` - no permissions granted by default.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["read", "write", "admin", "none"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "members_can_create_repositories", - "description": "Toggles the ability of non-admin organization members to create repositories. Can be one of: \n\\* `true` - all organization members can create repositories. \n\\* `false` - only organization owners can create repositories. \nDefault: `true` \n**Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "members_can_create_internal_repositories", - "description": "Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud. Can be one of: \n\\* `true` - all organization members can create internal repositories. \n\\* `false` - only organization owners can create internal repositories. \nDefault: `true`. For more information, see \"[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "members_can_create_private_repositories", - "description": "Toggles whether organization members can create private repositories, which are visible to organization members with permission. Can be one of: \n\\* `true` - all organization members can create private repositories. \n\\* `false` - only organization owners can create private repositories. \nDefault: `true`. For more information, see \"[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "members_can_create_public_repositories", - "description": "Toggles whether organization members can create public repositories, which are visible to anyone. Can be one of: \n\\* `true` - all organization members can create public repositories. \n\\* `false` - only organization owners can create public repositories. \nDefault: `true`. For more information, see \"[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "members_allowed_repository_creation_type", - "description": "Specifies which types of repositories non-admin organization members can create. Can be one of: \n\\* `all` - all organization members can create public and private repositories. \n\\* `private` - members can create private repositories. This option is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n\\* `none` - only admin members can create repositories. \n**Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See [this note](https://developer.github.com/v3/orgs/#members_can_create_repositories) for details.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["all", "private", "none"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"is_verified\":true,\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"type\":\"Organization\",\"total_private_repos\":100,\"owned_private_repos\":100,\"private_gists\":81,\"disk_usage\":10000,\"collaborators\":8,\"billing_email\":\"support@github.com\",\"plan\":{\"name\":\"Medium\",\"space\":400,\"private_repos\":20},\"default_repository_permission\":\"read\",\"members_can_create_repositories\":true,\"two_factor_requirement_enabled\":true,\"members_allowed_repository_creation_type\":\"all\",\"members_can_create_public_repositories\":false,\"members_can_create_private_repositories\":false,\"members_can_create_internal_repositories\":false}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List blocked users", - "scope": "orgs", - "id": "listBlockedUsers", - "method": "GET", - "url": "/orgs/{org}/blocks", - "isDeprecated": false, - "isLegacy": false, - "description": "List the users blocked by an organization.", - "documentationUrl": "https://developer.github.com/v3/orgs/blocking/#list-blocked-users", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Check whether a user is blocked from an organization", - "scope": "orgs", - "id": "checkBlockedUser", - "method": "GET", - "url": "/orgs/{org}/blocks/{username}", - "isDeprecated": false, - "isLegacy": false, - "description": "If the user is blocked:\n\nIf the user is not blocked:", - "documentationUrl": "https://developer.github.com/v3/orgs/blocking/#check-whether-a-user-is-blocked-from-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "username parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "Block a user", - "scope": "orgs", - "id": "blockUser", - "method": "PUT", - "url": "/orgs/{org}/blocks/{username}", - "isDeprecated": false, - "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/orgs/blocking/#block-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "username parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "Unblock a user", - "scope": "orgs", - "id": "unblockUser", - "method": "DELETE", - "url": "/orgs/{org}/blocks/{username}", - "isDeprecated": false, - "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/orgs/blocking/#unblock-a-user", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "username parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "List public events for an organization", - "scope": "activity", - "id": "listPublicEventsForOrg", - "method": "GET", - "url": "/orgs/{org}/events", - "isDeprecated": false, - "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/activity/events/#list-public-events-for-an-organization", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "List hooks", - "scope": "orgs", - "id": "listHooks", - "method": "GET", - "url": "/orgs/{org}/hooks", - "isDeprecated": false, - "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/orgs/hooks/#list-hooks", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"id\":1,\"url\":\"https://api.github.com/orgs/octocat/hooks/1\",\"ping_url\":\"https://api.github.com/orgs/octocat/hooks/1/pings\",\"name\":\"web\",\"events\":[\"push\",\"pull_request\"],\"active\":true,\"config\":{\"url\":\"http://example.com\",\"content_type\":\"json\"},\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a hook", - "scope": "orgs", - "id": "createHook", - "method": "POST", - "url": "/orgs/{org}/hooks", - "isDeprecated": false, - "isLegacy": false, - "description": "Here's how you can create a hook that posts payloads in JSON format:", - "documentationUrl": "https://developer.github.com/v3/orgs/hooks/#create-a-hook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "Must be passed as \"web\".", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config", - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/orgs/hooks/#create-hook-config-params).", - "in": "BODY", - "type": "object", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.url", - "description": "The URL to which the payloads will be delivered.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.content_type", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.secret", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/webhooks/#delivery-headers) header.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.insecure_ssl", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "events", - "description": "Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "active", - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "response", - "examples": [ - { - "data": "{\"id\":1,\"url\":\"https://api.github.com/orgs/octocat/hooks/1\",\"ping_url\":\"https://api.github.com/orgs/octocat/hooks/1/pings\",\"name\":\"web\",\"events\":[\"push\",\"pull_request\"],\"active\":true,\"config\":{\"url\":\"http://example.com\",\"content_type\":\"json\"},\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get single hook", - "scope": "orgs", - "id": "getHook", - "method": "GET", - "url": "/orgs/{org}/hooks/{hook_id}", - "isDeprecated": false, - "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/orgs/hooks/#get-single-hook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "hook_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"id\":1,\"url\":\"https://api.github.com/orgs/octocat/hooks/1\",\"ping_url\":\"https://api.github.com/orgs/octocat/hooks/1/pings\",\"name\":\"web\",\"events\":[\"push\",\"pull_request\"],\"active\":true,\"config\":{\"url\":\"http://example.com\",\"content_type\":\"json\"},\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Edit a hook", - "scope": "orgs", - "id": "updateHook", - "method": "PATCH", - "url": "/orgs/{org}/hooks/{hook_id}", - "isDeprecated": false, - "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/orgs/hooks/#edit-a-hook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "hook_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config", - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/orgs/hooks/#update-hook-config-params).", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.url", - "description": "The URL to which the payloads will be delivered.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.content_type", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.secret", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/webhooks/#delivery-headers) header.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.insecure_ssl", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "events", - "description": "Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "active", - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"id\":1,\"url\":\"https://api.github.com/orgs/octocat/hooks/1\",\"ping_url\":\"https://api.github.com/orgs/octocat/hooks/1/pings\",\"name\":\"web\",\"events\":[\"pull_request\"],\"active\":true,\"config\":{\"url\":\"http://example.com\",\"content_type\":\"json\"},\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Delete a hook", - "scope": "orgs", - "id": "deleteHook", - "method": "DELETE", - "url": "/orgs/{org}/hooks/{hook_id}", - "isDeprecated": false, - "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/orgs/hooks/#delete-a-hook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "hook_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "Ping a hook", - "scope": "orgs", - "id": "pingHook", - "method": "POST", - "url": "/orgs/{org}/hooks/{hook_id}/pings", - "isDeprecated": false, - "isLegacy": false, - "description": "This will trigger a [ping event](https://developer.github.com/webhooks/#ping-event) to be sent to the hook.", - "documentationUrl": "https://developer.github.com/v3/orgs/hooks/#ping-a-hook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "hook_id", - "description": "hook_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "Get an organization installation", - "scope": "apps", - "id": "getOrgInstallation", - "method": "GET", - "url": "/orgs/{org}/installation", - "isDeprecated": false, - "isLegacy": false, - "description": "Enables an authenticated GitHub App to find the organization's installation information.\n\nYou must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://developer.github.com/v3/apps/#get-an-organization-installation", - "previews": [{ "name": "machine-man" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.machine-man-preview+json" - } - ], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"id\":1,\"account\":{\"login\":\"github\",\"id\":1,\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/orgs/github\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"repository_selection\":\"all\",\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"created_at\":\"2018-02-09T20:51:14Z\",\"updated_at\":\"2018-02-09T20:51:14Z\",\"single_file_name\":null}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get an organization installation", - "scope": "apps", - "id": "findOrgInstallation", - "method": "GET", - "url": "/orgs/{org}/installation", - "isDeprecated": false, - "isLegacy": false, - "description": "Enables an authenticated GitHub App to find the organization's installation information.\n\nYou must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://developer.github.com/v3/apps/#get-an-organization-installation", - "previews": [{ "name": "machine-man" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.machine-man-preview+json" - } - ], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"id\":1,\"account\":{\"login\":\"github\",\"id\":1,\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/orgs/github\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"repository_selection\":\"all\",\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"created_at\":\"2018-02-09T20:51:14Z\",\"updated_at\":\"2018-02-09T20:51:14Z\",\"single_file_name\":null}" - } - ] - } - ], - "renamed": { - "before": { "scope": "apps", "id": "findOrgInstallation" }, - "after": { "scope": "apps", "id": "getOrgInstallation" }, - "date": "2019-04-10", - "note": "\"Find organization installation\" renamed to \"Get an organization installation\"" - } - }, - { - "name": "List installations for an organization", - "scope": "orgs", - "id": "listInstallations", - "method": "GET", - "url": "/orgs/{org}/installations", - "isDeprecated": false, - "isLegacy": false, - "description": "Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint.", - "documentationUrl": "https://developer.github.com/v3/orgs/#list-installations-for-an-organization", - "previews": [{ "name": "machine-man" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.machine-man-preview+json" - } - ], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"total_count\":2,\"installations\":[{\"id\":25381,\"account\":{\"login\":\"octo-org\",\"id\":6811672,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=\",\"avatar_url\":\"https://avatars3.githubusercontent.com/u/6811672?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octo-org\",\"html_url\":\"https://github.com/octo-org\",\"followers_url\":\"https://api.github.com/users/octo-org/followers\",\"following_url\":\"https://api.github.com/users/octo-org/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octo-org/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octo-org/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octo-org/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octo-org/orgs\",\"repos_url\":\"https://api.github.com/users/octo-org/repos\",\"events_url\":\"https://api.github.com/users/octo-org/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octo-org/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"repository_selection\":\"selected\",\"access_tokens_url\":\"https://api.github.com/app/installations/25381/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/octo-org/settings/installations/25381\",\"app_id\":2218,\"target_id\":6811672,\"target_type\":\"Organization\",\"permissions\":{\"deployments\":\"write\",\"metadata\":\"read\",\"pull_requests\":\"read\",\"statuses\":\"read\"},\"events\":[\"deployment\",\"deployment_status\"],\"created_at\":\"2017-05-16T08:47:09.000-07:00\",\"updated_at\":\"2017-06-06T11:23:23.000-07:00\",\"single_file_name\":null}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get interaction restrictions for an organization", - "scope": "interactions", - "id": "getRestrictionsForOrg", - "method": "GET", - "url": "/orgs/{org}/interaction-limits", - "isDeprecated": false, - "isLegacy": false, - "description": "Shows which group of GitHub users can interact with this organization and when the restriction expires. If there are no restrictions, you will see an empty response.", - "documentationUrl": "https://developer.github.com/v3/interactions/orgs/#get-interaction-restrictions-for-an-organization", - "previews": [{ "name": "sombra" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.sombra-preview+json" - } - ], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"limit\":\"collaborators_only\",\"origin\":\"organization\",\"expires_at\":\"2018-08-17T04:18:39Z\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Add or update interaction restrictions for an organization", - "scope": "interactions", - "id": "addOrUpdateRestrictionsForOrg", - "method": "PUT", - "url": "/orgs/{org}/interaction-limits", - "isDeprecated": false, - "isLegacy": false, - "description": "Temporarily restricts interactions to certain GitHub users in any public repository in the given organization. You must be an organization owner to set these restrictions.", - "documentationUrl": "https://developer.github.com/v3/interactions/orgs/#add-or-update-interaction-restrictions-for-an-organization", - "previews": [{ "name": "sombra" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.sombra-preview+json" - } - ], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "limit", - "description": "Specifies the group of GitHub users who can comment, open issues, or create pull requests in public repositories for the given organization. Must be one of: `existing_users`, `contributors_only`, or `collaborators_only`.", - "in": "BODY", - "type": "string", - "required": true, - "enum": ["existing_users", "contributors_only", "collaborators_only"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"limit\":\"collaborators_only\",\"origin\":\"organization\",\"expires_at\":\"2018-08-17T04:18:39Z\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Remove interaction restrictions for an organization", - "scope": "interactions", - "id": "removeRestrictionsForOrg", - "method": "DELETE", - "url": "/orgs/{org}/interaction-limits", - "isDeprecated": false, - "isLegacy": false, - "description": "Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions.", - "documentationUrl": "https://developer.github.com/v3/interactions/orgs/#remove-interaction-restrictions-for-an-organization", - "previews": [{ "name": "sombra" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.sombra-preview+json" - } - ], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "List pending organization invitations", - "scope": "orgs", - "id": "listPendingInvitations", - "method": "GET", - "url": "/orgs/{org}/invitations", - "isDeprecated": false, - "isLegacy": false, - "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.", - "documentationUrl": "https://developer.github.com/v3/orgs/members/#list-pending-organization-invitations", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"id\":1,\"login\":\"monalisa\",\"email\":\"octocat@github.com\",\"role\":\"direct_member\",\"created_at\":\"2016-11-30T06:46:10-08:00\",\"inviter\":{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false},\"team_count\":2,\"invitation_team_url\":\"https://api.github.com/organizations/2/invitations/1/teams\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create organization invitation", - "scope": "orgs", - "id": "createInvitation", - "method": "POST", - "url": "/orgs/{org}/invitations", - "isDeprecated": false, - "isLegacy": false, - "description": "Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.", - "documentationUrl": "https://developer.github.com/v3/orgs/members/#create-organization-invitation", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "invitee_id", - "description": "**Required unless you provide `email`**. GitHub user ID for the person you are inviting.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "email", - "description": "**Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "role", - "description": "Specify role for new member. Can be one of: \n\\* `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. \n\\* `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. \n\\* `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["admin", "direct_member", "billing_manager"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_ids", - "description": "Specify IDs for the teams you want to invite new members to.", - "in": "BODY", - "type": "integer[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "response", - "examples": [ - { - "data": "{\"id\":1,\"login\":\"monalisa\",\"email\":\"octocat@github.com\",\"role\":\"direct_member\",\"created_at\":\"2016-11-30T06:46:10-08:00\",\"inviter\":{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false},\"team_count\":2,\"invitation_team_url\":\"https://api.github.com/organizations/2/invitations/1/teams\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List organization invitation teams", - "scope": "orgs", - "id": "listInvitationTeams", - "method": "GET", - "url": "/orgs/{org}/invitations/{invitation_id}/teams", - "isDeprecated": false, - "isLegacy": false, - "description": "List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner.", - "documentationUrl": "https://developer.github.com/v3/orgs/members/#list-organization-invitation-teams", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "invitation_id", - "description": "invitation_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List all issues for a given organization assigned to the authenticated user", - "scope": "issues", - "id": "listForOrg", - "method": "GET", - "url": "/orgs/{org}/issues", - "isDeprecated": false, - "isLegacy": false, - "description": "**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key.\n\nBe aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests)\" endpoint.\n\n", - "documentationUrl": "https://developer.github.com/v3/issues/#list-issues", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "filter", - "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all`: All issues the authenticated user can see, regardless of participation or creation", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["assigned", "created", "mentioned", "subscribed", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["open", "closed", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "labels", - "description": "A list of comma separated label names. Example: `bug,ui,@high`", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "comments"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The direction of the sort. Can be either `asc` or `desc`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Members list", - "scope": "orgs", - "id": "listMembers", - "method": "GET", - "url": "/orgs/{org}/members", - "isDeprecated": false, - "isLegacy": false, - "description": "List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.\n\n", - "documentationUrl": "https://developer.github.com/v3/orgs/members/#members-list", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "filter", - "description": "Filter members returned in the list. Can be one of: \n\\* `2fa_disabled` - Members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. Available for organization owners. \n\\* `all` - All members the authenticated user can see.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["2fa_disabled", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "role", - "description": "Filter members returned by their role. Can be one of: \n\\* `all` - All members of the organization, regardless of role. \n\\* `admin` - Organization owners. \n\\* `member` - Non-owner organization members.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["all", "admin", "member"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Check membership", - "scope": "orgs", - "id": "checkMembership", - "method": "GET", - "url": "/orgs/{org}/members/{username}", - "isDeprecated": false, - "isLegacy": false, - "description": "Check if a user is, publicly or privately, a member of the organization.", - "documentationUrl": "https://developer.github.com/v3/orgs/members/#check-membership", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "username parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "Remove a member", - "scope": "orgs", - "id": "removeMember", - "method": "DELETE", - "url": "/orgs/{org}/members/{username}", - "isDeprecated": false, - "isLegacy": false, - "description": "Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.", - "documentationUrl": "https://developer.github.com/v3/orgs/members/#remove-a-member", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "username parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "Get organization membership", - "scope": "orgs", - "id": "getMembership", - "method": "GET", - "url": "/orgs/{org}/memberships/{username}", - "isDeprecated": false, - "isLegacy": false, - "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member.", - "documentationUrl": "https://developer.github.com/v3/orgs/members/#get-organization-membership", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "username parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/orgs/octocat/memberships/defunkt\",\"state\":\"active\",\"role\":\"admin\",\"organization_url\":\"https://api.github.com/orgs/octocat\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" - }, - { - "data": "{\"url\":\"https://api.github.com/orgs/octocat/memberships/defunkt\",\"state\":\"active\",\"role\":\"member\",\"organization_url\":\"https://api.github.com/orgs/octocat\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" - }, - { - "data": "{\"url\":\"https://api.github.com/orgs/invitocat/memberships/defunkt\",\"state\":\"pending\",\"role\":\"member\",\"organization_url\":\"https://api.github.com/orgs/invitocat\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Add or update organization membership", - "scope": "orgs", - "id": "addOrUpdateMembership", - "method": "PUT", - "url": "/orgs/{org}/memberships/{username}", - "isDeprecated": false, - "isLegacy": false, - "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://developer.github.com/v3/orgs/members/#get-organization-membership) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", - "documentationUrl": "https://developer.github.com/v3/orgs/members/#add-or-update-organization-membership", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "username parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "role", - "description": "The role to give the user in the organization. Can be one of: \n\\* `admin` - The user will become an owner of the organization. \n\\* `member` - The user will become a non-owner member of the organization.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["admin", "member"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/orgs/invitocat/memberships/defunkt\",\"state\":\"pending\",\"role\":\"admin\",\"organization_url\":\"https://api.github.com/orgs/invitocat\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" - }, - { - "data": "{\"url\":\"https://api.github.com/orgs/octocat/memberships/defunkt\",\"state\":\"active\",\"role\":\"admin\",\"organization_url\":\"https://api.github.com/orgs/octocat\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Remove organization membership", - "scope": "orgs", - "id": "removeMembership", - "method": "DELETE", - "url": "/orgs/{org}/memberships/{username}", - "isDeprecated": false, - "isLegacy": false, - "description": "In order to remove a user's membership with an organization, the authenticated user must be an organization owner.\n\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.", - "documentationUrl": "https://developer.github.com/v3/orgs/members/#remove-organization-membership", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "username parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "Start an organization migration", - "scope": "migrations", - "id": "startForOrg", - "method": "POST", - "url": "/orgs/{org}/migrations", - "isDeprecated": false, - "isLegacy": false, - "description": "Initiates the generation of a migration archive.", - "documentationUrl": "https://developer.github.com/v3/migrations/orgs/#start-an-organization-migration", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repositories", - "description": "A list of arrays indicating which repositories should be migrated.", - "in": "BODY", - "type": "string[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "lock_repositories", - "description": "Indicates whether repositories should be locked (to prevent manipulation) while migrating data.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "exclude_attachments", - "description": "Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "response", - "examples": [ - { - "data": "{\"id\":79,\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"guid\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"state\":\"pending\",\"lock_repositories\":true,\"exclude_attachments\":false,\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}],\"url\":\"https://api.github.com/orgs/octo-org/migrations/79\",\"created_at\":\"2015-07-06T15:33:38-07:00\",\"updated_at\":\"2015-07-06T15:33:38-07:00\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List organization migrations", - "scope": "migrations", - "id": "listForOrg", - "method": "GET", - "url": "/orgs/{org}/migrations", - "isDeprecated": false, - "isLegacy": false, - "description": "Lists the most recent migrations.", - "documentationUrl": "https://developer.github.com/v3/migrations/orgs/#list-organization-migrations", - "previews": [{ "name": "wyandotte" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.wyandotte-preview+json" - } - ], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"id\":79,\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"guid\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"state\":\"pending\",\"lock_repositories\":true,\"exclude_attachments\":false,\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}],\"url\":\"https://api.github.com/orgs/octo-org/migrations/79\",\"created_at\":\"2015-07-06T15:33:38-07:00\",\"updated_at\":\"2015-07-06T15:33:38-07:00\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get the status of an organization migration", - "scope": "migrations", - "id": "getStatusForOrg", - "method": "GET", - "url": "/orgs/{org}/migrations/{migration_id}", - "isDeprecated": false, - "isLegacy": false, - "description": "Fetches the status of a migration.\n\nThe `state` of a migration can be one of the following values:\n\n* `pending`, which means the migration hasn't started yet.\n* `exporting`, which means the migration is in progress.\n* `exported`, which means the migration finished successfully.\n* `failed`, which means the migration failed.", - "documentationUrl": "https://developer.github.com/v3/migrations/orgs/#get-the-status-of-an-organization-migration", - "previews": [{ "name": "wyandotte" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.wyandotte-preview+json" - } - ], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "migration_id", - "description": "migration_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "* `pending`, which means the migration hasn't started yet.\n* `exporting`, which means the migration is in progress.\n* `exported`, which means the migration finished successfully.\n* `failed`, which means the migration failed.", - "examples": [ - { - "data": "{\"id\":79,\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"guid\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"state\":\"exported\",\"lock_repositories\":true,\"exclude_attachments\":false,\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}],\"url\":\"https://api.github.com/orgs/octo-org/migrations/79\",\"created_at\":\"2015-07-06T15:33:38-07:00\",\"updated_at\":\"2015-07-06T15:33:38-07:00\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Download an organization migration archive", - "scope": "migrations", - "id": "downloadArchiveForOrg", - "method": "GET", - "url": "/orgs/{org}/migrations/{migration_id}/archive", - "isDeprecated": false, - "isLegacy": false, - "description": "Fetches the URL to a migration archive.\n\n", - "documentationUrl": "https://developer.github.com/v3/migrations/orgs/#download-an-organization-migration-archive", - "previews": [{ "name": "wyandotte" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.wyandotte-preview+json" - } - ], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "migration_id", - "description": "migration_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "Download an organization migration archive", - "scope": "migrations", - "id": "getArchiveForOrg", - "method": "GET", - "url": "/orgs/{org}/migrations/{migration_id}/archive", - "isDeprecated": false, - "isLegacy": false, - "description": "Fetches the URL to a migration archive.\n\n", - "documentationUrl": "https://developer.github.com/v3/migrations/orgs/#download-an-organization-migration-archive", - "previews": [{ "name": "wyandotte" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.wyandotte-preview+json" - } - ], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "migration_id", - "description": "migration_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [], - "renamed": { - "before": { "scope": "migrations", "id": "getArchiveForOrg" }, - "after": { "scope": "migrations", "id": "downloadArchiveForOrg" }, - "date": "2020-01-27", - "note": "\"migrations/get-archive-for-org\" operation ID is now \"migrations/download-archive-for-org\"" - } - }, - { - "name": "Delete an organization migration archive", - "scope": "migrations", - "id": "deleteArchiveForOrg", - "method": "DELETE", - "url": "/orgs/{org}/migrations/{migration_id}/archive", - "isDeprecated": false, - "isLegacy": false, - "description": "Deletes a previous migration archive. Migration archives are automatically deleted after seven days.", - "documentationUrl": "https://developer.github.com/v3/migrations/orgs/#delete-an-organization-migration-archive", - "previews": [{ "name": "wyandotte" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.wyandotte-preview+json" - } - ], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "migration_id", - "description": "migration_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "Unlock an organization repository", - "scope": "migrations", - "id": "unlockRepoForOrg", - "method": "DELETE", - "url": "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock", - "isDeprecated": false, - "isLegacy": false, - "description": "Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://developer.github.com/v3/repos/#delete-a-repository) when the migration is complete and you no longer need the source data.", - "documentationUrl": "https://developer.github.com/v3/migrations/orgs/#unlock-an-organization-repository", - "previews": [{ "name": "wyandotte" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.wyandotte-preview+json" - } - ], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "migration_id", - "description": "migration_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo_name", - "description": "repo_name parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "List repositories in an organization migration", - "scope": "migrations", - "id": "listReposForOrg", - "method": "GET", - "url": "/orgs/{org}/migrations/{migration_id}/repositories", - "isDeprecated": false, - "isLegacy": false, - "description": "List all the repositories for this organization migration.", - "documentationUrl": "https://developer.github.com/v3/migrations/orgs/#list-repositories-in-an-organization-migration", - "previews": [{ "name": "wyandotte" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.wyandotte-preview+json" - } - ], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "migration_id", - "description": "migration_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"}}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List outside collaborators", - "scope": "orgs", - "id": "listOutsideCollaborators", - "method": "GET", - "url": "/orgs/{org}/outside_collaborators", - "isDeprecated": false, - "isLegacy": false, - "description": "List all users who are outside collaborators of an organization.\n\n", - "documentationUrl": "https://developer.github.com/v3/orgs/outside_collaborators/#list-outside-collaborators", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "filter", - "description": "Filter the list of outside collaborators. Can be one of: \n\\* `2fa_disabled`: Outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. \n\\* `all`: All outside collaborators.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["2fa_disabled", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Remove outside collaborator", - "scope": "orgs", - "id": "removeOutsideCollaborator", - "method": "DELETE", - "url": "/orgs/{org}/outside_collaborators/{username}", - "isDeprecated": false, - "isLegacy": false, - "description": "Removing a user from this list will remove them from all the organization's repositories.", - "documentationUrl": "https://developer.github.com/v3/orgs/outside_collaborators/#remove-outside-collaborator", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "username parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 422, - "description": "Response if user is a member of the organization", - "examples": [ - { - "data": "{\"message\":\"You cannot specify an organization member to remove as an outside collaborator.\",\"documentation_url\":\"https://developer.github.com/v3/orgs/outside_collaborators/#remove-outside-collaborator\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Convert member to outside collaborator", - "scope": "orgs", - "id": "convertMemberToOutsideCollaborator", - "method": "PUT", - "url": "/orgs/{org}/outside_collaborators/{username}", - "isDeprecated": false, - "isLegacy": false, - "description": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://help.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)\".", - "documentationUrl": "https://developer.github.com/v3/orgs/outside_collaborators/#convert-member-to-outside-collaborator", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "username parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 403, - "description": "response", - "examples": [ - { - "data": "{\"message\":\"Cannot convert the last owner to an outside collaborator\",\"documentation_url\":\"https://developer.github.com/v3/orgs/outside_collaborators/#convert-member-to-outside-collaborator\"}" - }, - { - "data": "{\"message\":\" is not a member of the organization.\",\"documentation_url\":\"https://developer.github.com/v3/orgs/outside_collaborators/#convert-member-to-outside-collaborator\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List organization projects", - "scope": "projects", - "id": "listForOrg", - "method": "GET", - "url": "/orgs/{org}/projects", - "isDeprecated": false, - "isLegacy": false, - "description": "Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.\n\ns", - "documentationUrl": "https://developer.github.com/v3/projects/#list-organization-projects", - "previews": [{ "name": "inertia" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.inertia-preview+json" - } - ], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["open", "closed", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"owner_url\":\"https://api.github.com/orgs/octocat\",\"url\":\"https://api.github.com/projects/1002605\",\"html_url\":\"https://github.com/orgs/api-playground/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002605/columns\",\"id\":1002605,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDU=\",\"name\":\"Organization Roadmap\",\"body\":\"High-level roadmap for the upcoming year.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-11T20:09:31Z\",\"updated_at\":\"2014-03-04T18:58:10Z\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create an organization project", - "scope": "projects", - "id": "createForOrg", - "method": "POST", - "url": "/orgs/{org}/projects", - "isDeprecated": false, - "isLegacy": false, - "description": "Creates an organization project board. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", - "documentationUrl": "https://developer.github.com/v3/projects/#create-an-organization-project", - "previews": [{ "name": "inertia" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.inertia-preview+json" - } - ], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The name of the project.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The description of the project.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "response", - "examples": [ - { - "data": "{\"owner_url\":\"https://api.github.com/orgs/octocat\",\"url\":\"https://api.github.com/projects/1002605\",\"html_url\":\"https://github.com/orgs/api-playground/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002605/columns\",\"id\":1002605,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDU=\",\"name\":\"Organization Roadmap\",\"body\":\"High-level roadmap for the upcoming year.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-11T20:09:31Z\",\"updated_at\":\"2014-03-04T18:58:10Z\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Public members list", - "scope": "orgs", - "id": "listPublicMembers", - "method": "GET", - "url": "/orgs/{org}/public_members", - "isDeprecated": false, - "isLegacy": false, - "description": "Members of an organization can choose to have their membership publicized or not.", - "documentationUrl": "https://developer.github.com/v3/orgs/members/#public-members-list", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Check public membership", - "scope": "orgs", - "id": "checkPublicMembership", - "method": "GET", - "url": "/orgs/{org}/public_members/{username}", - "isDeprecated": false, - "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/orgs/members/#check-public-membership", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "username parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "Publicize a user's membership", - "scope": "orgs", - "id": "publicizeMembership", - "method": "PUT", - "url": "/orgs/{org}/public_members/{username}", - "isDeprecated": false, - "isLegacy": false, - "description": "The user can publicize their own membership. (A user cannot publicize the membership for another user.)\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\"", - "documentationUrl": "https://developer.github.com/v3/orgs/members/#publicize-a-users-membership", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "username parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "Conceal a user's membership", - "scope": "orgs", - "id": "concealMembership", - "method": "DELETE", - "url": "/orgs/{org}/public_members/{username}", - "isDeprecated": false, - "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/orgs/members/#conceal-a-users-membership", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "username parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "List organization repositories", - "scope": "repos", - "id": "listForOrg", - "method": "GET", - "url": "/orgs/{org}/repos", - "isDeprecated": false, - "isLegacy": false, - "description": "Lists repositories for the specified organization.", - "documentationUrl": "https://developer.github.com/v3/repos/#list-organization-repositories", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "type", - "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud, `type` can also be `internal`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "all", - "public", - "private", - "forks", - "sources", - "member", - "internal" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated", "pushed", "full_name"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "Can be one of `asc` or `desc`. Default: when using `full_name`: `asc`, otherwise `desc`", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"}}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Creates a new repository in the specified organization", - "scope": "repos", - "id": "createInOrg", - "method": "POST", - "url": "/orgs/{org}/repos", - "isDeprecated": false, - "isLegacy": false, - "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", - "documentationUrl": "https://developer.github.com/v3/repos/#create", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The name of the repository.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "A short description of the repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "homepage", - "description": "A URL with more information about the repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "private", - "description": "Either `true` to create a private repository or `false` to create a public one. Creating private repositories requires a paid GitHub account.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "visibility", - "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/github/creating-cloning-and-archiving-repositories/creating-an-internal-repository)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["public", "private", "visibility", "internal"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "has_issues", - "description": "Either `true` to enable issues for this repository or `false` to disable them.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "has_projects", - "description": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "has_wiki", - "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "is_template", - "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_id", - "description": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "auto_init", - "description": "Pass `true` to create an initial commit with empty README.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "gitignore_template", - "description": "Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, \"Haskell\".", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "license_template", - "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://help.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\".", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_squash_merge", - "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_merge_commit", - "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_rebase_merge", - "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "delete_branch_on_merge", - "description": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "response", - "examples": [ - { - "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List teams", - "scope": "teams", - "id": "list", - "method": "GET", - "url": "/orgs/{org}/teams", - "isDeprecated": false, - "isLegacy": false, - "description": "Lists all teams in an organization that are visible to the authenticated user.", - "documentationUrl": "https://developer.github.com/v3/teams/#list-teams", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create team", - "scope": "teams", - "id": "create", - "method": "POST", - "url": "/orgs/{org}/teams", - "isDeprecated": false, - "isLegacy": false, - "description": "To create a team, the authenticated user must be a member or owner of `:org`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://help.github.com/en/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)\" in the GitHub Help documentation.", - "documentationUrl": "https://developer.github.com/v3/teams/#create-team", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The name of the team.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "The description of the team.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "maintainers", - "description": "List GitHub IDs for organization members who will become team maintainers.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo_names", - "description": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "privacy", - "description": "The level of privacy this team should have. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \nDefault: `secret` \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization. \nDefault for child team: `closed`", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["secret", "closed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permission", - "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer newly-added repositories. \n\\* `push` - team members can pull and push, but not administer newly-added repositories. \n\\* `admin` - team members can pull, push and administer newly-added repositories.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["pull", "push", "admin"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "parent_team_id", - "description": "The ID of a team to set as the parent team.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null,\"members_count\":3,\"repos_count\":10,\"created_at\":\"2017-07-14T16:53:42Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"is_verified\":true,\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"type\":\"Organization\"}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get team by name", - "scope": "teams", - "id": "getByName", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}", - "isDeprecated": false, - "isLegacy": false, - "description": "Gets a team using the team's `slug`. GitHub generates the `slug` from the team `name`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id`.", - "documentationUrl": "https://developer.github.com/v3/teams/#get-team-by-name", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null,\"members_count\":3,\"repos_count\":10,\"created_at\":\"2017-07-14T16:53:42Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"is_verified\":true,\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"type\":\"Organization\"}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Edit team", - "scope": "teams", - "id": "updateInOrg", - "method": "PATCH", - "url": "/orgs/{org}/teams/{team_slug}", - "isDeprecated": false, - "isLegacy": false, - "description": "To edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/:org_id/team/:team_id`.", - "documentationUrl": "https://developer.github.com/v3/teams/#edit-team", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The name of the team.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "The description of the team.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "privacy", - "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["secret", "closed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permission", - "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer newly-added repositories. \n\\* `push` - team members can pull and push, but not administer newly-added repositories. \n\\* `admin` - team members can pull, push and administer newly-added repositories.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["pull", "push", "admin"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "parent_team_id", - "description": "The ID of a team to set as the parent team.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null,\"members_count\":3,\"repos_count\":10,\"created_at\":\"2017-07-14T16:53:42Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"is_verified\":true,\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"type\":\"Organization\"}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Delete team", - "scope": "teams", - "id": "deleteInOrg", - "method": "DELETE", - "url": "/orgs/{org}/teams/{team_slug}", - "isDeprecated": false, - "isLegacy": false, - "description": "To delete a team, the authenticated user must be an organization owner or team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/:org_id/team/:team_id`.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.", - "documentationUrl": "https://developer.github.com/v3/teams/#delete-team", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, + "name": "Mark a thread as read", + "scope": "activity", + "id": "markThreadAsRead", + "method": "PATCH", + "url": "/notifications/threads/{thread_id}", + "isDeprecated": false, + "isLegacy": false, + "description": "", + "documentationUrl": "https://developer.github.com/v3/activity/notifications/#mark-a-thread-as-read", + "previews": [], + "headers": [], + "parameters": [ { - "name": "team_slug", - "description": "team_slug parameter", + "name": "thread_id", + "description": "thread_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -8490,36 +2929,23 @@ "renamed": null }, { - "name": "List discussions", - "scope": "teams", - "id": "listDiscussionsInOrg", + "name": "Get a thread subscription", + "scope": "activity", + "id": "getThreadSubscription", "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/discussions", + "url": "/notifications/threads/{thread_id}/subscription", "isDeprecated": false, "isLegacy": false, - "description": "List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions`.", - "documentationUrl": "https://developer.github.com/v3/teams/discussions/#list-discussions", + "description": "This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://developer.github.com/v3/activity/watching/#get-a-repository-subscription).\n\nNote that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread.", + "documentationUrl": "https://developer.github.com/v3/activity/notifications/#get-a-thread-subscription", "previews": [], "headers": [], "parameters": [ { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_slug", - "description": "team_slug parameter", + "name": "thread_id", + "description": "thread_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -8527,26 +2953,40 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "direction", - "description": "Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, + "code": 200, + "description": "response", + "examples": [ + { + "data": "{\"subscribed\":true,\"ignored\":false,\"reason\":null,\"created_at\":\"2012-10-06T21:34:12Z\",\"url\":\"https://api.github.com/notifications/threads/1/subscription\",\"thread_url\":\"https://api.github.com/notifications/threads/1\"}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Set a thread subscription", + "scope": "activity", + "id": "setThreadSubscription", + "method": "PUT", + "url": "/notifications/threads/{thread_id}/subscription", + "isDeprecated": false, + "isLegacy": false, + "description": "This lets you subscribe or unsubscribe from a conversation.", + "documentationUrl": "https://developer.github.com/v3/activity/notifications/#set-a-thread-subscription", + "previews": [], + "headers": [], + "parameters": [ { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", + "name": "thread_id", + "description": "thread_id parameter", + "in": "PATH", "type": "integer", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -8555,10 +2995,10 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", + "name": "ignored", + "description": "Unsubscribes and subscribes you to a conversation. Set `ignored` to `true` to block all notifications from this thread.", + "in": "BODY", + "type": "boolean", "required": false, "enum": null, "allowNull": false, @@ -8574,7 +3014,7 @@ "description": "response", "examples": [ { - "data": "[{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"

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

\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":0,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":null,\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Our first team post\",\"updated_at\":\"2018-01-25T18:56:31Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0}}]" + "data": "{\"subscribed\":true,\"ignored\":false,\"reason\":null,\"created_at\":\"2012-10-06T21:34:12Z\",\"url\":\"https://api.github.com/notifications/threads/1/subscription\",\"thread_url\":\"https://api.github.com/notifications/threads/1\"}" } ] } @@ -8582,36 +3022,23 @@ "renamed": null }, { - "name": "Create a discussion", - "scope": "teams", - "id": "createDiscussionInOrg", - "method": "POST", - "url": "/orgs/{org}/teams/{team_slug}/discussions", + "name": "Delete a thread subscription", + "scope": "activity", + "id": "deleteThreadSubscription", + "method": "DELETE", + "url": "/notifications/threads/{thread_id}/subscription", "isDeprecated": false, "isLegacy": false, - "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions`.", - "documentationUrl": "https://developer.github.com/v3/teams/discussions/#create-a-discussion", + "description": "Mutes all future notifications for a conversation until you comment on the thread or get **@mention**ed.", + "documentationUrl": "https://developer.github.com/v3/activity/notifications/#delete-a-thread-subscription", "previews": [], "headers": [], "parameters": [ { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_slug", - "description": "team_slug parameter", + "name": "thread_id", + "description": "thread_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -8619,13 +3046,30 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [], + "renamed": null + }, + { + "name": "List all organizations", + "scope": "orgs", + "id": "list", + "method": "GET", + "url": "/organizations", + "isDeprecated": false, + "isLegacy": false, + "description": "Lists all organizations, in the order that they were created on GitHub.\n\n**Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://developer.github.com/v3/#link-header) to get the URL for the next page of organizations.", + "documentationUrl": "https://developer.github.com/v3/orgs/#list-all-organizations", + "previews": [], + "headers": [], + "parameters": [ { - "name": "title", - "description": "The discussion post's title.", - "in": "BODY", - "type": "string", - "required": true, + "name": "since", + "description": "The integer ID of the last organization that you've seen.", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -8634,11 +3078,11 @@ "deprecated": null }, { - "name": "body", - "description": "The discussion post's body text.", - "in": "BODY", - "type": "string", - "required": true, + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -8647,10 +3091,10 @@ "deprecated": null }, { - "name": "private", - "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.", - "in": "BODY", - "type": "boolean", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -8662,11 +3106,11 @@ ], "responses": [ { - "code": 201, + "code": 200, "description": "response", "examples": [ { - "data": "{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"

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

\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":0,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":null,\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Our first team post\",\"updated_at\":\"2018-01-25T18:56:31Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0}}" + "data": "[{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"}]" } ] } @@ -8674,15 +3118,15 @@ "renamed": null }, { - "name": "Get a single discussion", - "scope": "teams", - "id": "getDiscussionInOrg", + "name": "Get an organization", + "scope": "orgs", + "id": "get", "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", + "url": "/orgs/{org}", "isDeprecated": false, "isLegacy": false, - "description": "Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number`.", - "documentationUrl": "https://developer.github.com/v3/teams/discussions/#get-a-single-discussion", + "description": "To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://help.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nGitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub plan. See \"[Authenticating with GitHub Apps](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/)\" for details. For an example response, see \"[Response with GitHub plan information](https://developer.github.com/v3/orgs/#response-with-github-plan-information).\"", + "documentationUrl": "https://developer.github.com/v3/orgs/#get-an-organization", "previews": [], "headers": [], "parameters": [ @@ -8698,32 +3142,6 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "discussion_number parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null } ], "responses": [ @@ -8732,7 +3150,10 @@ "description": "response", "examples": [ { - "data": "{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"

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

\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":0,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":null,\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Our first team post\",\"updated_at\":\"2018-01-25T18:56:31Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0}}" + "data": "{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"is_verified\":true,\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"type\":\"Organization\",\"total_private_repos\":100,\"owned_private_repos\":100,\"private_gists\":81,\"disk_usage\":10000,\"collaborators\":8,\"billing_email\":\"support@github.com\",\"plan\":{\"name\":\"Medium\",\"space\":400,\"private_repos\":20},\"default_repository_permission\":\"read\",\"members_can_create_repositories\":true,\"two_factor_requirement_enabled\":true,\"members_allowed_repository_creation_type\":\"all\",\"members_can_create_public_repositories\":false,\"members_can_create_private_repositories\":false,\"members_can_create_internal_repositories\":false}" + }, + { + "data": "{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"is_verified\":true,\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"type\":\"Organization\",\"plan\":{\"name\":\"team\",\"space\":976562499,\"private_repos\":999999,\"filled_seats\":4,\"seats\":5}}" } ] } @@ -8740,15 +3161,15 @@ "renamed": null }, { - "name": "Edit a discussion", - "scope": "teams", - "id": "updateDiscussionInOrg", + "name": "Edit an organization", + "scope": "orgs", + "id": "update", "method": "PATCH", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", + "url": "/orgs/{org}", "isDeprecated": false, "isLegacy": false, - "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/:org_id/team/:team_id/discussions/:discussion_number`.", - "documentationUrl": "https://developer.github.com/v3/teams/discussions/#edit-a-discussion", + "description": "\n\n**Parameter Deprecation Notice:** GitHub will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nEnables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges.", + "documentationUrl": "https://developer.github.com/v3/orgs/#edit-an-organization", "previews": [], "headers": [], "parameters": [ @@ -8766,11 +3187,11 @@ "deprecated": null }, { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", + "name": "billing_email", + "description": "Billing email address. This address is not publicized.", + "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -8779,11 +3200,11 @@ "deprecated": null }, { - "name": "discussion_number", - "description": "discussion_number parameter", - "in": "PATH", - "type": "integer", - "required": true, + "name": "company", + "description": "The company name.", + "in": "BODY", + "type": "string", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -8792,8 +3213,8 @@ "deprecated": null }, { - "name": "title", - "description": "The discussion post's title.", + "name": "email", + "description": "The publicly visible email address.", "in": "BODY", "type": "string", "required": false, @@ -8805,8 +3226,8 @@ "deprecated": null }, { - "name": "body", - "description": "The discussion post's body text.", + "name": "location", + "description": "The location.", "in": "BODY", "type": "string", "required": false, @@ -8816,40 +3237,13 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"

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

\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":1,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":\"2018-01-26T18:22:20Z\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Welcome to our first team post\",\"updated_at\":\"2018-01-26T18:22:20Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Delete a discussion", - "scope": "teams", - "id": "deleteDiscussionInOrg", - "method": "DELETE", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", - "isDeprecated": false, - "isLegacy": false, - "description": "Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number`.", - "documentationUrl": "https://developer.github.com/v3/teams/discussions/#delete-a-discussion", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "org", - "description": "org parameter", - "in": "PATH", + "name": "name", + "description": "The shorthand name of the company.", + "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -8858,11 +3252,11 @@ "deprecated": null }, { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", + "name": "description", + "description": "The description of the company.", + "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -8871,41 +3265,24 @@ "deprecated": null }, { - "name": "discussion_number", - "description": "discussion_number parameter", - "in": "PATH", - "type": "integer", - "required": true, + "name": "has_organization_projects", + "description": "Toggles whether an organization can use organization projects.", + "in": "BODY", + "type": "boolean", + "required": false, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "List comments", - "scope": "teams", - "id": "listDiscussionCommentsInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", - "isDeprecated": false, - "isLegacy": false, - "description": "List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments`.", - "documentationUrl": "https://developer.github.com/v3/teams/discussion_comments/#list-comments", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "org", - "description": "org parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "has_repository_projects", + "description": "Toggles whether repositories that belong to the organization can use repository projects.", + "in": "BODY", + "type": "boolean", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -8914,12 +3291,12 @@ "deprecated": null }, { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", + "name": "default_repository_permission", + "description": "Default permission level members have for organization repositories: \n\\* `read` - can pull, but not push to or administer this repository. \n\\* `write` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push, and administer this repository. \n\\* `none` - no permissions granted by default.", + "in": "BODY", "type": "string", - "required": true, - "enum": null, + "required": false, + "enum": ["read", "write", "admin", "none"], "allowNull": false, "mapToData": null, "validation": null, @@ -8927,11 +3304,11 @@ "deprecated": null }, { - "name": "discussion_number", - "description": "discussion_number parameter", - "in": "PATH", - "type": "integer", - "required": true, + "name": "members_can_create_repositories", + "description": "Toggles the ability of non-admin organization members to create repositories. Can be one of: \n\\* `true` - all organization members can create repositories. \n\\* `false` - only organization owners can create repositories. \nDefault: `true` \n**Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.", + "in": "BODY", + "type": "boolean", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -8940,12 +3317,12 @@ "deprecated": null }, { - "name": "direction", - "description": "Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`.", - "in": "QUERY", - "type": "string", + "name": "members_can_create_internal_repositories", + "description": "Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud. Can be one of: \n\\* `true` - all organization members can create internal repositories. \n\\* `false` - only organization owners can create internal repositories. \nDefault: `true`. For more information, see \"[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", + "in": "BODY", + "type": "boolean", "required": false, - "enum": ["asc", "desc"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -8953,10 +3330,10 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", + "name": "members_can_create_private_repositories", + "description": "Toggles whether organization members can create private repositories, which are visible to organization members with permission. Can be one of: \n\\* `true` - all organization members can create private repositories. \n\\* `false` - only organization owners can create private repositories. \nDefault: `true`. For more information, see \"[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", + "in": "BODY", + "type": "boolean", "required": false, "enum": null, "allowNull": false, @@ -8966,10 +3343,10 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", + "name": "members_can_create_public_repositories", + "description": "Toggles whether organization members can create public repositories, which are visible to anyone. Can be one of: \n\\* `true` - all organization members can create public repositories. \n\\* `false` - only organization owners can create public repositories. \nDefault: `true`. For more information, see \"[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", + "in": "BODY", + "type": "boolean", "required": false, "enum": null, "allowNull": false, @@ -8977,6 +3354,19 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "members_allowed_repository_creation_type", + "description": "Specifies which types of repositories non-admin organization members can create. Can be one of: \n\\* `all` - all organization members can create public and private repositories. \n\\* `private` - members can create private repositories. This option is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n\\* `none` - only admin members can create repositories. \n**Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See [this note](https://developer.github.com/v3/orgs/#members_can_create_repositories) for details.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["all", "private", "none"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -8985,7 +3375,7 @@ "description": "response", "examples": [ { - "data": "[{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Do you like apples?\",\"body_html\":\"

Do you like apples?

\",\"body_version\":\"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":null,\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-15T23:53:58Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0}}]" + "data": "{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"is_verified\":true,\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"type\":\"Organization\",\"total_private_repos\":100,\"owned_private_repos\":100,\"private_gists\":81,\"disk_usage\":10000,\"collaborators\":8,\"billing_email\":\"support@github.com\",\"plan\":{\"name\":\"Medium\",\"space\":400,\"private_repos\":20},\"default_repository_permission\":\"read\",\"members_can_create_repositories\":true,\"two_factor_requirement_enabled\":true,\"members_allowed_repository_creation_type\":\"all\",\"members_can_create_public_repositories\":false,\"members_can_create_private_repositories\":false,\"members_can_create_internal_repositories\":false}" } ] } @@ -8993,15 +3383,15 @@ "renamed": null }, { - "name": "Create a comment", - "scope": "teams", - "id": "createDiscussionCommentInOrg", - "method": "POST", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", + "name": "List blocked users", + "scope": "orgs", + "id": "listBlockedUsers", + "method": "GET", + "url": "/orgs/{org}/blocks", "isDeprecated": false, "isLegacy": false, - "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments`.", - "documentationUrl": "https://developer.github.com/v3/teams/discussion_comments/#create-a-comment", + "description": "List the users blocked by an organization.", + "documentationUrl": "https://developer.github.com/v3/orgs/blocking/#list-blocked-users", "previews": [], "headers": [], "parameters": [ @@ -9017,54 +3407,15 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "discussion_number parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The discussion comment's body text.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null } ], "responses": [ { - "code": 201, + "code": 200, "description": "response", "examples": [ { - "data": "{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Do you like apples?\",\"body_html\":\"

Do you like apples?

\",\"body_version\":\"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":null,\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-15T23:53:58Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0}}" + "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" } ] } @@ -9072,15 +3423,15 @@ "renamed": null }, { - "name": "Get a single comment", - "scope": "teams", - "id": "getDiscussionCommentInOrg", + "name": "Check whether a user is blocked from an organization", + "scope": "orgs", + "id": "checkBlockedUser", "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", + "url": "/orgs/{org}/blocks/{username}", "isDeprecated": false, "isLegacy": false, - "description": "Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number`.", - "documentationUrl": "https://developer.github.com/v3/teams/discussion_comments/#get-a-single-comment", + "description": "If the user is blocked:\n\nIf the user is not blocked:", + "documentationUrl": "https://developer.github.com/v3/orgs/blocking/#check-whether-a-user-is-blocked-from-an-organization", "previews": [], "headers": [], "parameters": [ @@ -9098,8 +3449,8 @@ "deprecated": null }, { - "name": "team_slug", - "description": "team_slug parameter", + "name": "username", + "description": "username parameter", "in": "PATH", "type": "string", "required": true, @@ -9109,12 +3460,29 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [], + "renamed": null + }, + { + "name": "Block a user", + "scope": "orgs", + "id": "blockUser", + "method": "PUT", + "url": "/orgs/{org}/blocks/{username}", + "isDeprecated": false, + "isLegacy": false, + "description": "", + "documentationUrl": "https://developer.github.com/v3/orgs/blocking/#block-a-user", + "previews": [], + "headers": [], + "parameters": [ { - "name": "discussion_number", - "description": "discussion_number parameter", + "name": "org", + "description": "org parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -9124,10 +3492,10 @@ "deprecated": null }, { - "name": "comment_number", - "description": "comment_number parameter", + "name": "username", + "description": "username parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -9137,29 +3505,19 @@ "deprecated": null } ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Do you like apples?\",\"body_html\":\"

Do you like apples?

\",\"body_version\":\"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":null,\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-15T23:53:58Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0}}" - } - ] - } - ], + "responses": [], "renamed": null }, { - "name": "Edit a comment", - "scope": "teams", - "id": "updateDiscussionCommentInOrg", - "method": "PATCH", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", + "name": "Unblock a user", + "scope": "orgs", + "id": "unblockUser", + "method": "DELETE", + "url": "/orgs/{org}/blocks/{username}", "isDeprecated": false, "isLegacy": false, - "description": "Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number`.", - "documentationUrl": "https://developer.github.com/v3/teams/discussion_comments/#edit-a-comment", + "description": "", + "documentationUrl": "https://developer.github.com/v3/orgs/blocking/#unblock-a-user", "previews": [], "headers": [], "parameters": [ @@ -9177,8 +3535,8 @@ "deprecated": null }, { - "name": "team_slug", - "description": "team_slug parameter", + "name": "username", + "description": "username parameter", "in": "PATH", "type": "string", "required": true, @@ -9188,12 +3546,29 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [], + "renamed": null + }, + { + "name": "List public events for an organization", + "scope": "activity", + "id": "listPublicEventsForOrg", + "method": "GET", + "url": "/orgs/{org}/events", + "isDeprecated": false, + "isLegacy": false, + "description": "", + "documentationUrl": "https://developer.github.com/v3/activity/events/#list-public-events-for-an-organization", + "previews": [], + "headers": [], + "parameters": [ { - "name": "discussion_number", - "description": "discussion_number parameter", + "name": "org", + "description": "org parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -9203,11 +3578,11 @@ "deprecated": null }, { - "name": "comment_number", - "description": "comment_number parameter", - "in": "PATH", + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", "type": "integer", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -9216,11 +3591,11 @@ "deprecated": null }, { - "name": "body", - "description": "The discussion comment's body text.", - "in": "BODY", - "type": "string", - "required": true, + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -9229,29 +3604,19 @@ "deprecated": null } ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Do you like pineapples?\",\"body_html\":\"

Do you like pineapples?

\",\"body_version\":\"e6907b24d9c93cc0c5024a7af5888116\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":\"2018-01-26T18:22:20Z\",\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-26T18:22:20Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0}}" - } - ] - } - ], + "responses": [], "renamed": null }, { - "name": "Delete a comment", - "scope": "teams", - "id": "deleteDiscussionCommentInOrg", - "method": "DELETE", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", + "name": "List hooks", + "scope": "orgs", + "id": "listHooks", + "method": "GET", + "url": "/orgs/{org}/hooks", "isDeprecated": false, "isLegacy": false, - "description": "Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number`.", - "documentationUrl": "https://developer.github.com/v3/teams/discussion_comments/#delete-a-comment", + "description": "", + "documentationUrl": "https://developer.github.com/v3/orgs/hooks/#list-hooks", "previews": [], "headers": [], "parameters": [ @@ -9269,24 +3634,11 @@ "deprecated": null }, { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "discussion_number parameter", - "in": "PATH", + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", "type": "integer", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -9295,11 +3647,11 @@ "deprecated": null }, { - "name": "comment_number", - "description": "comment_number parameter", - "in": "PATH", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", "type": "integer", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -9308,26 +3660,31 @@ "deprecated": null } ], - "responses": [], + "responses": [ + { + "code": 200, + "description": "response", + "examples": [ + { + "data": "[{\"id\":1,\"url\":\"https://api.github.com/orgs/octocat/hooks/1\",\"ping_url\":\"https://api.github.com/orgs/octocat/hooks/1/pings\",\"name\":\"web\",\"events\":[\"push\",\"pull_request\"],\"active\":true,\"config\":{\"url\":\"http://example.com\",\"content_type\":\"json\"},\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\"}]" + } + ] + } + ], "renamed": null }, { - "name": "List reactions for a team discussion comment", - "scope": "reactions", - "id": "listForTeamDiscussionCommentInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", + "name": "Create a hook", + "scope": "orgs", + "id": "createHook", + "method": "POST", + "url": "/orgs/{org}/hooks", "isDeprecated": false, "isLegacy": false, - "description": "List the reactions to a [team discussion comment](https://developer.github.com/v3/teams/discussion_comments/). OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.", - "documentationUrl": "https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-comment", - "previews": [{ "name": "squirrel-girl" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.squirrel-girl-preview+json" - } - ], + "description": "Here's how you can create a hook that posts payloads in JSON format:", + "documentationUrl": "https://developer.github.com/v3/orgs/hooks/#create-a-hook", + "previews": [], + "headers": [], "parameters": [ { "name": "org", @@ -9343,9 +3700,9 @@ "deprecated": null }, { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", + "name": "name", + "description": "Must be passed as \"web\".", + "in": "BODY", "type": "string", "required": true, "enum": null, @@ -9356,10 +3713,10 @@ "deprecated": null }, { - "name": "discussion_number", - "description": "discussion_number parameter", - "in": "PATH", - "type": "integer", + "name": "config", + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/orgs/hooks/#create-hook-config-params).", + "in": "BODY", + "type": "object", "required": true, "enum": null, "allowNull": false, @@ -9369,10 +3726,10 @@ "deprecated": null }, { - "name": "comment_number", - "description": "comment_number parameter", - "in": "PATH", - "type": "integer", + "name": "config.url", + "description": "The URL to which the payloads will be delivered.", + "in": "BODY", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -9382,21 +3739,12 @@ "deprecated": null }, { - "name": "content", - "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion comment.", - "in": "QUERY", + "name": "config.content_type", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "in": "BODY", "type": "string", "required": false, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -9404,10 +3752,10 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", + "name": "config.secret", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/webhooks/#delivery-headers) header.", + "in": "BODY", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -9417,10 +3765,36 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", + "name": "config.insecure_ssl", + "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "events", + "description": "Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for.", + "in": "BODY", + "type": "string[]", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "active", + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "in": "BODY", + "type": "boolean", "required": false, "enum": null, "allowNull": false, @@ -9432,11 +3806,11 @@ ], "responses": [ { - "code": 200, + "code": 201, "description": "response", "examples": [ { - "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" + "data": "{\"id\":1,\"url\":\"https://api.github.com/orgs/octocat/hooks/1\",\"ping_url\":\"https://api.github.com/orgs/octocat/hooks/1/pings\",\"name\":\"web\",\"events\":[\"push\",\"pull_request\"],\"active\":true,\"config\":{\"url\":\"http://example.com\",\"content_type\":\"json\"},\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\"}" } ] } @@ -9444,22 +3818,17 @@ "renamed": null }, { - "name": "Create reaction for a team discussion comment", - "scope": "reactions", - "id": "createForTeamDiscussionCommentInOrg", - "method": "POST", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", + "name": "Get single hook", + "scope": "orgs", + "id": "getHook", + "method": "GET", + "url": "/orgs/{org}/hooks/{hook_id}", "isDeprecated": false, "isLegacy": false, - "description": "Create a reaction to a [team discussion comment](https://developer.github.com/v3/teams/discussion_comments/). OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.", - "documentationUrl": "https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-comment", - "previews": [{ "name": "squirrel-girl" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.squirrel-girl-preview+json" - } - ], + "description": "", + "documentationUrl": "https://developer.github.com/v3/orgs/hooks/#get-single-hook", + "previews": [], + "headers": [], "parameters": [ { "name": "org", @@ -9475,10 +3844,10 @@ "deprecated": null }, { - "name": "team_slug", - "description": "team_slug parameter", + "name": "hook_id", + "description": "hook_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -9486,12 +3855,39 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "discussion_number", - "description": "discussion_number parameter", + "code": 200, + "description": "response", + "examples": [ + { + "data": "{\"id\":1,\"url\":\"https://api.github.com/orgs/octocat/hooks/1\",\"ping_url\":\"https://api.github.com/orgs/octocat/hooks/1/pings\",\"name\":\"web\",\"events\":[\"push\",\"pull_request\"],\"active\":true,\"config\":{\"url\":\"http://example.com\",\"content_type\":\"json\"},\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\"}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Edit a hook", + "scope": "orgs", + "id": "updateHook", + "method": "PATCH", + "url": "/orgs/{org}/hooks/{hook_id}", + "isDeprecated": false, + "isLegacy": false, + "description": "", + "documentationUrl": "https://developer.github.com/v3/orgs/hooks/#edit-a-hook", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "org parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -9501,8 +3897,8 @@ "deprecated": null }, { - "name": "comment_number", - "description": "comment_number parameter", + "name": "hook_id", + "description": "hook_id parameter", "in": "PATH", "type": "integer", "required": true, @@ -9514,63 +3910,22 @@ "deprecated": null }, { - "name": "content", - "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion comment.", + "name": "config", + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/orgs/hooks/#update-hook-config-params).", "in": "BODY", - "type": "string", - "required": true, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], + "type": "object", + "required": false, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List reactions for a team discussion", - "scope": "reactions", - "id": "listForTeamDiscussionInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", - "isDeprecated": false, - "isLegacy": false, - "description": "List the reactions to a [team discussion](https://developer.github.com/v3/teams/discussions/). OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.", - "documentationUrl": "https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion", - "previews": [{ "name": "squirrel-girl" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.squirrel-girl-preview+json" - } - ], - "parameters": [ + }, { - "name": "org", - "description": "org parameter", - "in": "PATH", + "name": "config.url", + "description": "The URL to which the payloads will be delivered.", + "in": "BODY", "type": "string", "required": true, "enum": null, @@ -9581,11 +3936,11 @@ "deprecated": null }, { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", + "name": "config.content_type", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -9594,11 +3949,11 @@ "deprecated": null }, { - "name": "discussion_number", - "description": "discussion_number parameter", - "in": "PATH", - "type": "integer", - "required": true, + "name": "config.secret", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/webhooks/#delivery-headers) header.", + "in": "BODY", + "type": "string", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -9607,21 +3962,12 @@ "deprecated": null }, { - "name": "content", - "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion.", - "in": "QUERY", + "name": "config.insecure_ssl", + "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "in": "BODY", "type": "string", "required": false, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -9629,10 +3975,10 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", + "name": "events", + "description": "Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for.", + "in": "BODY", + "type": "string[]", "required": false, "enum": null, "allowNull": false, @@ -9642,10 +3988,10 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", + "name": "active", + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "in": "BODY", + "type": "boolean", "required": false, "enum": null, "allowNull": false, @@ -9661,7 +4007,7 @@ "description": "response", "examples": [ { - "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" + "data": "{\"id\":1,\"url\":\"https://api.github.com/orgs/octocat/hooks/1\",\"ping_url\":\"https://api.github.com/orgs/octocat/hooks/1/pings\",\"name\":\"web\",\"events\":[\"pull_request\"],\"active\":true,\"config\":{\"url\":\"http://example.com\",\"content_type\":\"json\"},\"updated_at\":\"2011-09-06T20:39:23Z\",\"created_at\":\"2011-09-06T17:26:27Z\"}" } ] } @@ -9669,22 +4015,17 @@ "renamed": null }, { - "name": "Create reaction for a team discussion", - "scope": "reactions", - "id": "createForTeamDiscussionInOrg", - "method": "POST", - "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", + "name": "Delete a hook", + "scope": "orgs", + "id": "deleteHook", + "method": "DELETE", + "url": "/orgs/{org}/hooks/{hook_id}", "isDeprecated": false, "isLegacy": false, - "description": "Create a reaction to a [team discussion](https://developer.github.com/v3/teams/discussions/). OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.", - "documentationUrl": "https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion", - "previews": [{ "name": "squirrel-girl" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.squirrel-girl-preview+json" - } - ], + "description": "", + "documentationUrl": "https://developer.github.com/v3/orgs/hooks/#delete-a-hook", + "previews": [], + "headers": [], "parameters": [ { "name": "org", @@ -9700,21 +4041,8 @@ "deprecated": null }, { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "discussion_number parameter", + "name": "hook_id", + "description": "hook_id parameter", "in": "PATH", "type": "integer", "required": true, @@ -9724,53 +4052,21 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "content", - "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion.", - "in": "BODY", - "type": "string", - "required": true, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] } ], + "responses": [], "renamed": null }, { - "name": "List pending team invitations", - "scope": "teams", - "id": "listPendingInvitationsInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/invitations", + "name": "Ping a hook", + "scope": "orgs", + "id": "pingHook", + "method": "POST", + "url": "/orgs/{org}/hooks/{hook_id}/pings", "isDeprecated": false, "isLegacy": false, - "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/invitations`.", - "documentationUrl": "https://developer.github.com/v3/teams/members/#list-pending-team-invitations", + "description": "This will trigger a [ping event](https://developer.github.com/webhooks/#ping-event) to be sent to the hook.", + "documentationUrl": "https://developer.github.com/v3/orgs/hooks/#ping-a-hook", "previews": [], "headers": [], "parameters": [ @@ -9788,10 +4084,10 @@ "deprecated": null }, { - "name": "team_slug", - "description": "team_slug parameter", + "name": "hook_id", + "description": "hook_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -9799,26 +4095,36 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [], + "renamed": null + }, + { + "name": "Get an organization installation", + "scope": "apps", + "id": "getOrgInstallation", + "method": "GET", + "url": "/orgs/{org}/installation", + "isDeprecated": false, + "isLegacy": false, + "description": "Enables an authenticated GitHub App to find the organization's installation information.\n\nYou must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "documentationUrl": "https://developer.github.com/v3/apps/#get-an-organization-installation", + "previews": [{ "name": "machine-man" }], + "headers": [ { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, + "name": "accept", + "value": "application/vnd.github.machine-man-preview+json", + "required": true + } + ], + "parameters": [ { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "org", + "description": "org parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -9833,7 +4139,7 @@ "description": "response", "examples": [ { - "data": "[{\"id\":1,\"login\":\"monalisa\",\"email\":\"octocat@github.com\",\"role\":\"direct_member\",\"created_at\":\"2016-11-30T06:46:10-08:00\",\"inviter\":{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false},\"team_count\":2,\"invitation_team_url\":\"https://api.github.com/organizations/2/invitations/1/teams\"}]" + "data": "{\"id\":1,\"account\":{\"login\":\"github\",\"id\":1,\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/orgs/github\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"repository_selection\":\"all\",\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"created_at\":\"2018-02-09T20:51:14Z\",\"updated_at\":\"2018-02-09T20:51:14Z\",\"single_file_name\":null}" } ] } @@ -9841,17 +4147,23 @@ "renamed": null }, { - "name": "List team members", - "scope": "teams", - "id": "listMembersInOrg", + "name": "List installations for an organization", + "scope": "orgs", + "id": "listInstallations", "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/members", + "url": "/orgs/{org}/installations", "isDeprecated": false, "isLegacy": false, - "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.", - "documentationUrl": "https://developer.github.com/v3/teams/members/#list-team-members", - "previews": [], - "headers": [], + "description": "Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint.", + "documentationUrl": "https://developer.github.com/v3/orgs/#list-installations-for-an-organization", + "previews": [{ "name": "machine-man" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.machine-man-preview+json", + "required": true + } + ], "parameters": [ { "name": "org", @@ -9866,32 +4178,6 @@ "alias": null, "deprecated": null }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "role", - "description": "Filters members returned by their role in the team. Can be one of: \n\\* `member` - normal members of the team. \n\\* `maintainer` - team maintainers. \n\\* `all` - all members of the team.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["member", "maintainer", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, { "name": "per_page", "description": "Results per page (max 100)", @@ -9925,7 +4211,7 @@ "description": "response", "examples": [ { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" + "data": "{\"total_count\":2,\"installations\":[{\"id\":25381,\"account\":{\"login\":\"octo-org\",\"id\":6811672,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=\",\"avatar_url\":\"https://avatars3.githubusercontent.com/u/6811672?v=4\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octo-org\",\"html_url\":\"https://github.com/octo-org\",\"followers_url\":\"https://api.github.com/users/octo-org/followers\",\"following_url\":\"https://api.github.com/users/octo-org/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octo-org/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octo-org/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octo-org/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octo-org/orgs\",\"repos_url\":\"https://api.github.com/users/octo-org/repos\",\"events_url\":\"https://api.github.com/users/octo-org/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octo-org/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"repository_selection\":\"selected\",\"access_tokens_url\":\"https://api.github.com/app/installations/25381/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/octo-org/settings/installations/25381\",\"app_id\":2218,\"target_id\":6811672,\"target_type\":\"Organization\",\"permissions\":{\"deployments\":\"write\",\"metadata\":\"read\",\"pull_requests\":\"read\",\"statuses\":\"read\"},\"events\":[\"deployment\",\"deployment_status\"],\"created_at\":\"2017-05-16T08:47:09.000-07:00\",\"updated_at\":\"2017-06-06T11:23:23.000-07:00\",\"single_file_name\":null}]}" } ] } @@ -9933,17 +4219,23 @@ "renamed": null }, { - "name": "Get team membership", - "scope": "teams", - "id": "getMembershipInOrg", + "name": "Get interaction restrictions for an organization", + "scope": "interactions", + "id": "getRestrictionsForOrg", "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/memberships/{username}", + "url": "/orgs/{org}/interaction-limits", "isDeprecated": false, "isLegacy": false, - "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/memberships/:username`.\n\n**Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create team](https://developer.github.com/v3/teams#create-team).", - "documentationUrl": "https://developer.github.com/v3/teams/members/#get-team-membership", - "previews": [], - "headers": [], + "description": "Shows which group of GitHub users can interact with this organization and when the restriction expires. If there are no restrictions, you will see an empty response.", + "documentationUrl": "https://developer.github.com/v3/interactions/orgs/#get-interaction-restrictions-for-an-organization", + "previews": [{ "name": "sombra" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.sombra-preview+json", + "required": true + } + ], "parameters": [ { "name": "org", @@ -9957,10 +4249,43 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "team_slug", - "description": "team_slug parameter", + "code": 200, + "description": "response", + "examples": [ + { + "data": "{\"limit\":\"collaborators_only\",\"origin\":\"organization\",\"expires_at\":\"2018-08-17T04:18:39Z\"}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Add or update interaction restrictions for an organization", + "scope": "interactions", + "id": "addOrUpdateRestrictionsForOrg", + "method": "PUT", + "url": "/orgs/{org}/interaction-limits", + "isDeprecated": false, + "isLegacy": false, + "description": "Temporarily restricts interactions to certain GitHub users in any public repository in the given organization. You must be an organization owner to set these restrictions.", + "documentationUrl": "https://developer.github.com/v3/interactions/orgs/#add-or-update-interaction-restrictions-for-an-organization", + "previews": [{ "name": "sombra" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.sombra-preview+json", + "required": true + } + ], + "parameters": [ + { + "name": "org", + "description": "org parameter", "in": "PATH", "type": "string", "required": true, @@ -9972,12 +4297,12 @@ "deprecated": null }, { - "name": "username", - "description": "username parameter", - "in": "PATH", + "name": "limit", + "description": "Specifies the group of GitHub users who can comment, open issues, or create pull requests in public repositories for the given organization. Must be one of: `existing_users`, `contributors_only`, or `collaborators_only`.", + "in": "BODY", "type": "string", "required": true, - "enum": null, + "enum": ["existing_users", "contributors_only", "collaborators_only"], "allowNull": false, "mapToData": null, "validation": null, @@ -9991,13 +4316,7 @@ "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/teams/1/memberships/octocat\",\"role\":\"member\",\"state\":\"active\"}" - }, - { - "data": "{\"url\":\"https://api.github.com/teams/1/memberships/octocat\",\"role\":\"maintainer\",\"state\":\"active\"}" - }, - { - "data": "{\"url\":\"https://api.github.com/teams/1/memberships/octocat\",\"role\":\"member\",\"state\":\"pending\"}" + "data": "{\"limit\":\"collaborators_only\",\"origin\":\"organization\",\"expires_at\":\"2018-08-17T04:18:39Z\"}" } ] } @@ -10005,17 +4324,23 @@ "renamed": null }, { - "name": "Add or update team membership", - "scope": "teams", - "id": "addOrUpdateMembershipInOrg", - "method": "PUT", - "url": "/orgs/{org}/teams/{team_slug}/memberships/{username}", + "name": "Remove interaction restrictions for an organization", + "scope": "interactions", + "id": "removeRestrictionsForOrg", + "method": "DELETE", + "url": "/orgs/{org}/interaction-limits", "isDeprecated": false, "isLegacy": false, - "description": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/:org_id/team/:team_id/memberships/:username`.", - "documentationUrl": "https://developer.github.com/v3/teams/members/#add-or-update-team-membership", - "previews": [], - "headers": [], + "description": "Removes all interaction restrictions from public repositories in the given organization. You must be an organization owner to remove restrictions.", + "documentationUrl": "https://developer.github.com/v3/interactions/orgs/#remove-interaction-restrictions-for-an-organization", + "previews": [{ "name": "sombra" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.sombra-preview+json", + "required": true + } + ], "parameters": [ { "name": "org", @@ -10029,10 +4354,27 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [], + "renamed": null + }, + { + "name": "List pending organization invitations", + "scope": "orgs", + "id": "listPendingInvitations", + "method": "GET", + "url": "/orgs/{org}/invitations", + "isDeprecated": false, + "isLegacy": false, + "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.", + "documentationUrl": "https://developer.github.com/v3/orgs/members/#list-pending-organization-invitations", + "previews": [], + "headers": [], + "parameters": [ { - "name": "team_slug", - "description": "team_slug parameter", + "name": "org", + "description": "org parameter", "in": "PATH", "type": "string", "required": true, @@ -10044,11 +4386,11 @@ "deprecated": null }, { - "name": "username", - "description": "username parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -10057,12 +4399,12 @@ "deprecated": null }, { - "name": "role", - "description": "The role that this user should have in the team. Can be one of: \n\\* `member` - a normal member of the team. \n\\* `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description.", - "in": "BODY", - "type": "string", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", "required": false, - "enum": ["member", "maintainer"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -10076,19 +4418,7 @@ "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/teams/1/memberships/octocat\",\"role\":\"member\",\"state\":\"active\"}" - }, - { - "data": "{\"url\":\"https://api.github.com/teams/1/memberships/octocat\",\"role\":\"member\",\"state\":\"pending\"}" - } - ] - }, - { - "code": 422, - "description": "Response if you attempt to add an organization to a team", - "examples": [ - { - "data": "{\"message\":\"Cannot add an organization as a member.\",\"errors\":[{\"code\":\"org\",\"field\":\"user\",\"resource\":\"TeamMember\"}]}" + "data": "[{\"id\":1,\"login\":\"monalisa\",\"email\":\"octocat@github.com\",\"role\":\"direct_member\",\"created_at\":\"2016-11-30T06:46:10-08:00\",\"inviter\":{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false},\"team_count\":2,\"invitation_team_url\":\"https://api.github.com/organizations/2/invitations/1/teams\"}]" } ] } @@ -10096,15 +4426,15 @@ "renamed": null }, { - "name": "Remove team membership", - "scope": "teams", - "id": "removeMembershipInOrg", - "method": "DELETE", - "url": "/orgs/{org}/teams/{team_slug}/memberships/{username}", + "name": "Create organization invitation", + "scope": "orgs", + "id": "createInvitation", + "method": "POST", + "url": "/orgs/{org}/invitations", "isDeprecated": false, "isLegacy": false, - "description": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/:org_id/team/:team_id/memberships/:username`.", - "documentationUrl": "https://developer.github.com/v3/teams/members/#remove-team-membership", + "description": "Invite people to an organization by using their GitHub user ID or their email address. In order to create invitations in an organization, the authenticated user must be an organization owner.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.", + "documentationUrl": "https://developer.github.com/v3/orgs/members/#create-organization-invitation", "previews": [], "headers": [], "parameters": [ @@ -10122,11 +4452,24 @@ "deprecated": null }, { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", + "name": "invitee_id", + "description": "**Required unless you provide `email`**. GitHub user ID for the person you are inviting.", + "in": "BODY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "email", + "description": "**Required unless you provide `invitee_id`**. Email address of the person you are inviting, which can be an existing GitHub user.", + "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -10135,11 +4478,24 @@ "deprecated": null }, { - "name": "username", - "description": "username parameter", - "in": "PATH", + "name": "role", + "description": "Specify role for new member. Can be one of: \n\\* `admin` - Organization owners with full administrative rights to the organization and complete access to all repositories and teams. \n\\* `direct_member` - Non-owner organization members with ability to see other members and join teams by invitation. \n\\* `billing_manager` - Non-owner organization members with ability to manage the billing settings of your organization.", + "in": "BODY", "type": "string", - "required": true, + "required": false, + "enum": ["admin", "direct_member", "billing_manager"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "team_ids", + "description": "Specify IDs for the teams you want to invite new members to.", + "in": "BODY", + "type": "integer[]", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -10148,26 +4504,31 @@ "deprecated": null } ], - "responses": [], + "responses": [ + { + "code": 201, + "description": "response", + "examples": [ + { + "data": "{\"id\":1,\"login\":\"monalisa\",\"email\":\"octocat@github.com\",\"role\":\"direct_member\",\"created_at\":\"2016-11-30T06:46:10-08:00\",\"inviter\":{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false},\"team_count\":2,\"invitation_team_url\":\"https://api.github.com/organizations/2/invitations/1/teams\"}" + } + ] + } + ], "renamed": null }, { - "name": "List team projects", - "scope": "teams", - "id": "listProjectsInOrg", + "name": "List organization invitation teams", + "scope": "orgs", + "id": "listInvitationTeams", "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/projects", + "url": "/orgs/{org}/invitations/{invitation_id}/teams", "isDeprecated": false, "isLegacy": false, - "description": "Lists the organization projects for a team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/projects`.", - "documentationUrl": "https://developer.github.com/v3/teams/#list-team-projects", - "previews": [{ "name": "inertia" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.inertia-preview+json" - } - ], + "description": "List all teams associated with an invitation. In order to see invitations in an organization, the authenticated user must be an organization owner.", + "documentationUrl": "https://developer.github.com/v3/orgs/members/#list-organization-invitation-teams", + "previews": [], + "headers": [], "parameters": [ { "name": "org", @@ -10183,10 +4544,10 @@ "deprecated": null }, { - "name": "team_slug", - "description": "team_slug parameter", + "name": "invitation_id", + "description": "invitation_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -10228,7 +4589,7 @@ "description": "response", "examples": [ { - "data": "[{\"owner_url\":\"https://api.github.com/orgs/octocat\",\"url\":\"https://api.github.com/projects/1002605\",\"html_url\":\"https://github.com/orgs/api-playground/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002605/columns\",\"id\":1002605,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDU=\",\"name\":\"Organization Roadmap\",\"body\":\"High-level roadmap for the upcoming year.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-11T20:09:31Z\",\"updated_at\":\"2014-03-04T18:58:10Z\",\"organization_permission\":\"write\",\"private\":false,\"permissions\":{\"read\":true,\"write\":true,\"admin\":false}}]" + "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]" } ] } @@ -10236,22 +4597,17 @@ "renamed": null }, { - "name": "Review a team project", - "scope": "teams", - "id": "reviewProjectInOrg", + "name": "List all issues for a given organization assigned to the authenticated user", + "scope": "issues", + "id": "listForOrg", "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", + "url": "/orgs/{org}/issues", "isDeprecated": false, "isLegacy": false, - "description": "Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/projects/:project_id`.", - "documentationUrl": "https://developer.github.com/v3/teams/#review-a-team-project", - "previews": [{ "name": "inertia" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.inertia-preview+json" - } - ], + "description": "**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key.\n\nBe aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests)\" endpoint.\n\n", + "documentationUrl": "https://developer.github.com/v3/issues/#list-issues", + "previews": [], + "headers": [], "parameters": [ { "name": "org", @@ -10267,12 +4623,12 @@ "deprecated": null }, { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", + "name": "filter", + "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all`: All issues the authenticated user can see, regardless of participation or creation", + "in": "QUERY", "type": "string", - "required": true, - "enum": null, + "required": false, + "enum": ["assigned", "created", "mentioned", "subscribed", "all"], "allowNull": false, "mapToData": null, "validation": null, @@ -10280,57 +4636,12 @@ "deprecated": null }, { - "name": "project_id", - "description": "project_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"owner_url\":\"https://api.github.com/orgs/octocat\",\"url\":\"https://api.github.com/projects/1002605\",\"html_url\":\"https://github.com/orgs/api-playground/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002605/columns\",\"id\":1002605,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDU=\",\"name\":\"Organization Roadmap\",\"body\":\"High-level roadmap for the upcoming year.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-11T20:09:31Z\",\"updated_at\":\"2014-03-04T18:58:10Z\",\"organization_permission\":\"write\",\"private\":false,\"permissions\":{\"read\":true,\"write\":true,\"admin\":false}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Add or update team project", - "scope": "teams", - "id": "addOrUpdateProjectInOrg", - "method": "PUT", - "url": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", - "isDeprecated": false, - "isLegacy": false, - "description": "Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/:org_id/team/:team_id/projects/:project_id`.", - "documentationUrl": "https://developer.github.com/v3/teams/#add-or-update-team-project", - "previews": [{ "name": "inertia" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.inertia-preview+json" - } - ], - "parameters": [ - { - "name": "org", - "description": "org parameter", - "in": "PATH", + "name": "state", + "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "in": "QUERY", "type": "string", - "required": true, - "enum": null, + "required": false, + "enum": ["open", "closed", "all"], "allowNull": false, "mapToData": null, "validation": null, @@ -10338,11 +4649,11 @@ "deprecated": null }, { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", + "name": "labels", + "description": "A list of comma separated label names. Example: `bug,ui,@high`", + "in": "QUERY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -10351,12 +4662,12 @@ "deprecated": null }, { - "name": "project_id", - "description": "project_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, + "name": "sort", + "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["created", "updated", "comments"], "allowNull": false, "mapToData": null, "validation": null, @@ -10364,51 +4675,24 @@ "deprecated": null }, { - "name": "permission", - "description": "The permission to grant to the team for this project. Can be one of: \n\\* `read` - team members can read, but not write to or administer this project. \n\\* `write` - team members can read and write, but not administer this project. \n\\* `admin` - team members can read, write and administer this project. \nDefault: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\"", - "in": "BODY", + "name": "direction", + "description": "The direction of the sort. Can be either `asc` or `desc`.", + "in": "QUERY", "type": "string", "required": false, - "enum": ["read", "write", "admin"], + "enum": ["asc", "desc"], "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 403, - "description": "Response if the project is not owned by the organization", - "examples": [ - { - "data": "{\"message\":\"Must have admin rights to Repository.\",\"documentation_url\":\"https://developer.github.com/v3/teams/#add-or-update-team-project\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Remove team project", - "scope": "teams", - "id": "removeProjectInOrg", - "method": "DELETE", - "url": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", - "isDeprecated": false, - "isLegacy": false, - "description": "Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/:org_id/team/:team_id/projects/:project_id`.", - "documentationUrl": "https://developer.github.com/v3/teams/#remove-team-project", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "org", - "description": "org parameter", - "in": "PATH", + "name": "since", + "description": "Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "QUERY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -10417,11 +4701,11 @@ "deprecated": null }, { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -10430,11 +4714,11 @@ "deprecated": null }, { - "name": "project_id", - "description": "project_id parameter", - "in": "PATH", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", "type": "integer", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -10443,19 +4727,29 @@ "deprecated": null } ], - "responses": [], + "responses": [ + { + "code": 200, + "description": "response", + "examples": [ + { + "data": "[{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}]" + } + ] + } + ], "renamed": null }, { - "name": "List team repos", - "scope": "teams", - "id": "listReposInOrg", + "name": "Members list", + "scope": "orgs", + "id": "listMembers", "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/repos", + "url": "/orgs/{org}/members", "isDeprecated": false, "isLegacy": false, - "description": "Lists a team's repositories visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/repos`.", - "documentationUrl": "https://developer.github.com/v3/teams/#list-team-repos", + "description": "List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.\n\n", + "documentationUrl": "https://developer.github.com/v3/orgs/members/#members-list", "previews": [], "headers": [], "parameters": [ @@ -10473,12 +4767,25 @@ "deprecated": null }, { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", + "name": "filter", + "description": "Filter members returned in the list. Can be one of: \n\\* `2fa_disabled` - Members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. Available for organization owners. \n\\* `all` - All members the authenticated user can see.", + "in": "QUERY", "type": "string", - "required": true, - "enum": null, + "required": false, + "enum": ["2fa_disabled", "all"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "role", + "description": "Filter members returned by their role. Can be one of: \n\\* `all` - All members of the organization, regardless of role. \n\\* `admin` - Organization owners. \n\\* `member` - Non-owner organization members.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["all", "admin", "member"], "allowNull": false, "mapToData": null, "validation": null, @@ -10518,7 +4825,7 @@ "description": "response", "examples": [ { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"}}]" + "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" } ] } @@ -10526,15 +4833,15 @@ "renamed": null }, { - "name": "Check if a team manages a repository", - "scope": "teams", - "id": "checkManagesRepoInOrg", + "name": "Check membership", + "scope": "orgs", + "id": "checkMembership", "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", + "url": "/orgs/{org}/members/{username}", "isDeprecated": false, "isLegacy": false, - "description": "Checks whether a team has `admin`, `push`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/repos/:owner/:repo`.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://developer.github.com/v3/media/) via the `Accept` header:", - "documentationUrl": "https://developer.github.com/v3/teams/#check-if-a-team-manages-a-repository", + "description": "Check if a user is, publicly or privately, a member of the organization.", + "documentationUrl": "https://developer.github.com/v3/orgs/members/#check-membership", "previews": [], "headers": [], "parameters": [ @@ -10552,8 +4859,8 @@ "deprecated": null }, { - "name": "team_slug", - "description": "team_slug parameter", + "name": "username", + "description": "username parameter", "in": "PATH", "type": "string", "required": true, @@ -10563,10 +4870,27 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [], + "renamed": null + }, + { + "name": "Remove a member", + "scope": "orgs", + "id": "removeMember", + "method": "DELETE", + "url": "/orgs/{org}/members/{username}", + "isDeprecated": false, + "isLegacy": false, + "description": "Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.", + "documentationUrl": "https://developer.github.com/v3/orgs/members/#remove-a-member", + "previews": [], + "headers": [], + "parameters": [ { - "name": "owner", - "description": "owner parameter", + "name": "org", + "description": "org parameter", "in": "PATH", "type": "string", "required": true, @@ -10578,8 +4902,8 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", + "name": "username", + "description": "username parameter", "in": "PATH", "type": "string", "required": true, @@ -10591,29 +4915,19 @@ "deprecated": null } ], - "responses": [ - { - "code": 200, - "description": "Alternative response with repository permissions", - "examples": [ - { - "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}" - } - ] - } - ], + "responses": [], "renamed": null }, { - "name": "Add or update team repository", - "scope": "teams", - "id": "addOrUpdateRepoInOrg", - "method": "PUT", - "url": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", + "name": "Get organization membership", + "scope": "orgs", + "id": "getMembership", + "method": "GET", + "url": "/orgs/{org}/memberships/{username}", "isDeprecated": false, "isLegacy": false, - "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/:org_id/team/:team_id/repos/:owner/:repo`.", - "documentationUrl": "https://developer.github.com/v3/teams/#add-or-update-team-repository", + "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member.", + "documentationUrl": "https://developer.github.com/v3/orgs/members/#get-organization-membership", "previews": [], "headers": [], "parameters": [ @@ -10631,8 +4945,8 @@ "deprecated": null }, { - "name": "team_slug", - "description": "team_slug parameter", + "name": "username", + "description": "username parameter", "in": "PATH", "type": "string", "required": true, @@ -10642,10 +4956,43 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "owner", - "description": "owner parameter", + "code": 200, + "description": "response", + "examples": [ + { + "data": "{\"url\":\"https://api.github.com/orgs/octocat/memberships/defunkt\",\"state\":\"active\",\"role\":\"admin\",\"organization_url\":\"https://api.github.com/orgs/octocat\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" + }, + { + "data": "{\"url\":\"https://api.github.com/orgs/octocat/memberships/defunkt\",\"state\":\"active\",\"role\":\"member\",\"organization_url\":\"https://api.github.com/orgs/octocat\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" + }, + { + "data": "{\"url\":\"https://api.github.com/orgs/invitocat/memberships/defunkt\",\"state\":\"pending\",\"role\":\"member\",\"organization_url\":\"https://api.github.com/orgs/invitocat\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Add or update organization membership", + "scope": "orgs", + "id": "addOrUpdateMembership", + "method": "PUT", + "url": "/orgs/{org}/memberships/{username}", + "isDeprecated": false, + "isLegacy": false, + "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://developer.github.com/v3/orgs/members/#get-organization-membership) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", + "documentationUrl": "https://developer.github.com/v3/orgs/members/#add-or-update-organization-membership", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "org parameter", "in": "PATH", "type": "string", "required": true, @@ -10657,8 +5004,8 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", + "name": "username", + "description": "username parameter", "in": "PATH", "type": "string", "required": true, @@ -10670,12 +5017,12 @@ "deprecated": null }, { - "name": "permission", - "description": "The permission to grant the team on this repository. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer this repository. \n\\* `push` - team members can pull and push, but not administer this repository. \n\\* `admin` - team members can pull, push and administer this repository. \n \nIf no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.", + "name": "role", + "description": "The role to give the user in the organization. Can be one of: \n\\* `admin` - The user will become an owner of the organization. \n\\* `member` - The user will become a non-owner member of the organization.", "in": "BODY", "type": "string", "required": false, - "enum": ["pull", "push", "admin"], + "enum": ["admin", "member"], "allowNull": false, "mapToData": null, "validation": null, @@ -10683,19 +5030,32 @@ "deprecated": null } ], - "responses": [], + "responses": [ + { + "code": 200, + "description": "response", + "examples": [ + { + "data": "{\"url\":\"https://api.github.com/orgs/invitocat/memberships/defunkt\",\"state\":\"pending\",\"role\":\"admin\",\"organization_url\":\"https://api.github.com/orgs/invitocat\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" + }, + { + "data": "{\"url\":\"https://api.github.com/orgs/octocat/memberships/defunkt\",\"state\":\"active\",\"role\":\"admin\",\"organization_url\":\"https://api.github.com/orgs/octocat\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" + } + ] + } + ], "renamed": null }, { - "name": "Remove team repository", - "scope": "teams", - "id": "removeRepoInOrg", + "name": "Remove organization membership", + "scope": "orgs", + "id": "removeMembership", "method": "DELETE", - "url": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", + "url": "/orgs/{org}/memberships/{username}", "isDeprecated": false, "isLegacy": false, - "description": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/:org_id/team/:team_id/repos/:owner/:repo`.", - "documentationUrl": "https://developer.github.com/v3/teams/#remove-team-repository", + "description": "In order to remove a user's membership with an organization, the authenticated user must be an organization owner.\n\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.", + "documentationUrl": "https://developer.github.com/v3/orgs/members/#remove-organization-membership", "previews": [], "headers": [], "parameters": [ @@ -10713,34 +5073,8 @@ "deprecated": null }, { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "owner", - "description": "owner parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "repo parameter", + "name": "username", + "description": "username parameter", "in": "PATH", "type": "string", "required": true, @@ -10756,15 +5090,15 @@ "renamed": null }, { - "name": "List child teams", - "scope": "teams", - "id": "listChildInOrg", - "method": "GET", - "url": "/orgs/{org}/teams/{team_slug}/teams", + "name": "Start an organization migration", + "scope": "migrations", + "id": "startForOrg", + "method": "POST", + "url": "/orgs/{org}/migrations", "isDeprecated": false, "isLegacy": false, - "description": "Lists the child teams of the team requested by `:team_slug`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/teams`.\n\n", - "documentationUrl": "https://developer.github.com/v3/teams/#list-child-teams", + "description": "Initiates the generation of a migration archive.", + "documentationUrl": "https://developer.github.com/v3/migrations/orgs/#start-an-organization-migration", "previews": [], "headers": [], "parameters": [ @@ -10782,10 +5116,10 @@ "deprecated": null }, { - "name": "team_slug", - "description": "team_slug parameter", - "in": "PATH", - "type": "string", + "name": "repositories", + "description": "A list of arrays indicating which repositories should be migrated.", + "in": "BODY", + "type": "string[]", "required": true, "enum": null, "allowNull": false, @@ -10795,10 +5129,10 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", + "name": "lock_repositories", + "description": "Indicates whether repositories should be locked (to prevent manipulation) while migrating data.", + "in": "BODY", + "type": "boolean", "required": false, "enum": null, "allowNull": false, @@ -10808,10 +5142,10 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", + "name": "exclude_attachments", + "description": "Indicates whether attachments should be excluded from the migration (to reduce migration archive file size).", + "in": "BODY", + "type": "boolean", "required": false, "enum": null, "allowNull": false, @@ -10823,56 +5157,11 @@ ], "responses": [ { - "code": 200, - "description": "Response if child teams exist", - "examples": [ - { - "data": "[{\"id\":2,\"node_id\":\"MDQ6VGVhbTI=\",\"url\":\"https://api.github.com/teams/2\",\"name\":\"Original Roster\",\"slug\":\"original-roster\",\"description\":\"Started it all.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/2/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/2/repos\",\"parent\":{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"}}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a project card", - "scope": "projects", - "id": "getCard", - "method": "GET", - "url": "/projects/columns/cards/{card_id}", - "isDeprecated": false, - "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/projects/cards/#get-a-project-card", - "previews": [{ "name": "inertia" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.inertia-preview+json" - } - ], - "parameters": [ - { - "name": "card_id", - "description": "card_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, + "code": 201, "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/projects/columns/cards/1478\",\"id\":1478,\"node_id\":\"MDExOlByb2plY3RDYXJkMTQ3OA==\",\"note\":\"Add payload for delete Project column\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2016-09-05T14:21:06Z\",\"updated_at\":\"2016-09-05T14:20:22Z\",\"archived\":false,\"column_url\":\"https://api.github.com/projects/columns/367\",\"content_url\":\"https://api.github.com/repos/api-playground/projects-test/issues/3\",\"project_url\":\"https://api.github.com/projects/120\"}" + "data": "{\"id\":79,\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"guid\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"state\":\"pending\",\"lock_repositories\":true,\"exclude_attachments\":false,\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}],\"url\":\"https://api.github.com/orgs/octo-org/migrations/79\",\"created_at\":\"2015-07-06T15:33:38-07:00\",\"updated_at\":\"2015-07-06T15:33:38-07:00\"}" } ] } @@ -10880,28 +5169,29 @@ "renamed": null }, { - "name": "Update a project card", - "scope": "projects", - "id": "updateCard", - "method": "PATCH", - "url": "/projects/columns/cards/{card_id}", + "name": "List organization migrations", + "scope": "migrations", + "id": "listForOrg", + "method": "GET", + "url": "/orgs/{org}/migrations", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/projects/cards/#update-a-project-card", - "previews": [{ "name": "inertia" }], + "description": "Lists the most recent migrations.", + "documentationUrl": "https://developer.github.com/v3/migrations/orgs/#list-organization-migrations", + "previews": [{ "name": "wyandotte" }], "headers": [ { "name": "accept", - "value": "application/vnd.github.inertia-preview+json" + "value": "application/vnd.github.wyandotte-preview+json", + "required": true } ], "parameters": [ { - "name": "card_id", - "description": "card_id parameter", + "name": "org", + "description": "org parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -10911,10 +5201,10 @@ "deprecated": null }, { - "name": "note", - "description": "The card's note content. Only valid for cards without another type of content, so this cannot be specified if the card already has a `content_id` and `content_type`.", - "in": "BODY", - "type": "string", + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -10924,10 +5214,10 @@ "deprecated": null }, { - "name": "archived", - "description": "Use `true` to archive a project card. Specify `false` if you need to restore a previously archived project card.", - "in": "BODY", - "type": "boolean", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -10943,7 +5233,7 @@ "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/projects/columns/cards/1478\",\"id\":1478,\"node_id\":\"MDExOlByb2plY3RDYXJkMTQ3OA==\",\"note\":\"Add payload for delete Project column\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2016-09-05T14:21:06Z\",\"updated_at\":\"2016-09-05T14:20:22Z\",\"archived\":false,\"column_url\":\"https://api.github.com/projects/columns/367\",\"content_url\":\"https://api.github.com/repos/api-playground/projects-test/issues/3\",\"project_url\":\"https://api.github.com/projects/120\"}" + "data": "[{\"id\":79,\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"guid\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"state\":\"pending\",\"lock_repositories\":true,\"exclude_attachments\":false,\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}],\"url\":\"https://api.github.com/orgs/octo-org/migrations/79\",\"created_at\":\"2015-07-06T15:33:38-07:00\",\"updated_at\":\"2015-07-06T15:33:38-07:00\"}]" } ] } @@ -10951,26 +5241,40 @@ "renamed": null }, { - "name": "Delete a project card", - "scope": "projects", - "id": "deleteCard", - "method": "DELETE", - "url": "/projects/columns/cards/{card_id}", + "name": "Get the status of an organization migration", + "scope": "migrations", + "id": "getStatusForOrg", + "method": "GET", + "url": "/orgs/{org}/migrations/{migration_id}", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/projects/cards/#delete-a-project-card", - "previews": [{ "name": "inertia" }], + "description": "Fetches the status of a migration.\n\nThe `state` of a migration can be one of the following values:\n\n* `pending`, which means the migration hasn't started yet.\n* `exporting`, which means the migration is in progress.\n* `exported`, which means the migration finished successfully.\n* `failed`, which means the migration failed.", + "documentationUrl": "https://developer.github.com/v3/migrations/orgs/#get-the-status-of-an-organization-migration", + "previews": [{ "name": "wyandotte" }], "headers": [ { "name": "accept", - "value": "application/vnd.github.inertia-preview+json" + "value": "application/vnd.github.wyandotte-preview+json", + "required": true } ], "parameters": [ { - "name": "card_id", - "description": "card_id parameter", + "name": "org", + "description": "org parameter", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "migration_id", + "description": "migration_id parameter", "in": "PATH", "type": "integer", "required": true, @@ -10982,59 +5286,57 @@ "deprecated": null } ], - "responses": [], + "responses": [ + { + "code": 200, + "description": "* `pending`, which means the migration hasn't started yet.\n* `exporting`, which means the migration is in progress.\n* `exported`, which means the migration finished successfully.\n* `failed`, which means the migration failed.", + "examples": [ + { + "data": "{\"id\":79,\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"guid\":\"0b989ba4-242f-11e5-81e1-c7b6966d2516\",\"state\":\"exported\",\"lock_repositories\":true,\"exclude_attachments\":false,\"repositories\":[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}],\"url\":\"https://api.github.com/orgs/octo-org/migrations/79\",\"created_at\":\"2015-07-06T15:33:38-07:00\",\"updated_at\":\"2015-07-06T15:33:38-07:00\"}" + } + ] + } + ], "renamed": null }, { - "name": "Move a project card", - "scope": "projects", - "id": "moveCard", - "method": "POST", - "url": "/projects/columns/cards/{card_id}/moves", + "name": "Download an organization migration archive", + "scope": "migrations", + "id": "downloadArchiveForOrg", + "method": "GET", + "url": "/orgs/{org}/migrations/{migration_id}/archive", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/projects/cards/#move-a-project-card", - "previews": [{ "name": "inertia" }], + "description": "Fetches the URL to a migration archive.\n\n", + "documentationUrl": "https://developer.github.com/v3/migrations/orgs/#download-an-organization-migration-archive", + "previews": [{ "name": "wyandotte" }], "headers": [ { "name": "accept", - "value": "application/vnd.github.inertia-preview+json" + "value": "application/vnd.github.wyandotte-preview+json", + "required": true } ], "parameters": [ { - "name": "card_id", - "description": "card_id parameter", + "name": "org", + "description": "org parameter", "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "position", - "description": "Can be one of `top`, `bottom`, or `after:`, where `` is the `id` value of a card in the same column, or in the new column specified by `column_id`.", - "in": "BODY", "type": "string", "required": true, "enum": null, "allowNull": false, "mapToData": null, - "validation": "^(top|bottom|after:\\d+)$", + "validation": null, "alias": null, "deprecated": null }, { - "name": "column_id", - "description": "The `id` value of a column in the same project.", - "in": "BODY", + "name": "migration_id", + "description": "migration_id parameter", + "in": "PATH", "type": "integer", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -11047,28 +5349,29 @@ "renamed": null }, { - "name": "Get a project column", - "scope": "projects", - "id": "getColumn", - "method": "GET", - "url": "/projects/columns/{column_id}", + "name": "Delete an organization migration archive", + "scope": "migrations", + "id": "deleteArchiveForOrg", + "method": "DELETE", + "url": "/orgs/{org}/migrations/{migration_id}/archive", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/projects/columns/#get-a-project-column", - "previews": [{ "name": "inertia" }], + "description": "Deletes a previous migration archive. Migration archives are automatically deleted after seven days.", + "documentationUrl": "https://developer.github.com/v3/migrations/orgs/#delete-an-organization-migration-archive", + "previews": [{ "name": "wyandotte" }], "headers": [ { "name": "accept", - "value": "application/vnd.github.inertia-preview+json" + "value": "application/vnd.github.wyandotte-preview+json", + "required": true } ], "parameters": [ { - "name": "column_id", - "description": "column_id parameter", + "name": "org", + "description": "org parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -11076,44 +5379,48 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ + }, { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/projects/columns/367\",\"project_url\":\"https://api.github.com/projects/120\",\"cards_url\":\"https://api.github.com/projects/columns/367/cards\",\"id\":367,\"node_id\":\"MDEzOlByb2plY3RDb2x1bW4zNjc=\",\"name\":\"To Do\",\"created_at\":\"2016-09-05T14:18:44Z\",\"updated_at\":\"2016-09-05T14:22:28Z\"}" - } - ] + "name": "migration_id", + "description": "migration_id parameter", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], + "responses": [], "renamed": null }, { - "name": "Update a project column", - "scope": "projects", - "id": "updateColumn", - "method": "PATCH", - "url": "/projects/columns/{column_id}", + "name": "Unlock an organization repository", + "scope": "migrations", + "id": "unlockRepoForOrg", + "method": "DELETE", + "url": "/orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/projects/columns/#update-a-project-column", - "previews": [{ "name": "inertia" }], + "description": "Unlocks a repository that was locked for migration. You should unlock each migrated repository and [delete them](https://developer.github.com/v3/repos/#delete-a-repository) when the migration is complete and you no longer need the source data.", + "documentationUrl": "https://developer.github.com/v3/migrations/orgs/#unlock-an-organization-repository", + "previews": [{ "name": "wyandotte" }], "headers": [ { "name": "accept", - "value": "application/vnd.github.inertia-preview+json" + "value": "application/vnd.github.wyandotte-preview+json", + "required": true } ], "parameters": [ { - "name": "column_id", - "description": "column_id parameter", + "name": "org", + "description": "org parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -11123,10 +5430,10 @@ "deprecated": null }, { - "name": "name", - "description": "The new name of the column.", - "in": "BODY", - "type": "string", + "name": "migration_id", + "description": "migration_id parameter", + "in": "PATH", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -11134,44 +5441,12 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/projects/columns/367\",\"project_url\":\"https://api.github.com/projects/120\",\"cards_url\":\"https://api.github.com/projects/columns/367/cards\",\"id\":367,\"node_id\":\"MDEzOlByb2plY3RDb2x1bW4zNjc=\",\"name\":\"To Do\",\"created_at\":\"2016-09-05T14:18:44Z\",\"updated_at\":\"2016-09-05T14:22:28Z\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Delete a project column", - "scope": "projects", - "id": "deleteColumn", - "method": "DELETE", - "url": "/projects/columns/{column_id}", - "isDeprecated": false, - "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/projects/columns/#delete-a-project-column", - "previews": [{ "name": "inertia" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.inertia-preview+json" - } - ], - "parameters": [ + }, { - "name": "column_id", - "description": "column_id parameter", + "name": "repo_name", + "description": "repo_name parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -11185,28 +5460,29 @@ "renamed": null }, { - "name": "List project cards", - "scope": "projects", - "id": "listCards", + "name": "List repositories in an organization migration", + "scope": "migrations", + "id": "listReposForOrg", "method": "GET", - "url": "/projects/columns/{column_id}/cards", + "url": "/orgs/{org}/migrations/{migration_id}/repositories", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/projects/cards/#list-project-cards", - "previews": [{ "name": "inertia" }], + "description": "List all the repositories for this organization migration.", + "documentationUrl": "https://developer.github.com/v3/migrations/orgs/#list-repositories-in-an-organization-migration", + "previews": [{ "name": "wyandotte" }], "headers": [ { "name": "accept", - "value": "application/vnd.github.inertia-preview+json" + "value": "application/vnd.github.wyandotte-preview+json", + "required": true } ], "parameters": [ { - "name": "column_id", - "description": "column_id parameter", + "name": "org", + "description": "org parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -11216,12 +5492,12 @@ "deprecated": null }, { - "name": "archived_state", - "description": "Filters the project cards that are returned by the card's state. Can be one of `all`,`archived`, or `not_archived`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["all", "archived", "not_archived"], + "name": "migration_id", + "description": "migration_id parameter", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -11261,7 +5537,7 @@ "description": "response", "examples": [ { - "data": "[{\"url\":\"https://api.github.com/projects/columns/cards/1478\",\"id\":1478,\"node_id\":\"MDExOlByb2plY3RDYXJkMTQ3OA==\",\"note\":\"Add payload for delete Project column\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2016-09-05T14:21:06Z\",\"updated_at\":\"2016-09-05T14:20:22Z\",\"archived\":false,\"column_url\":\"https://api.github.com/projects/columns/367\",\"content_url\":\"https://api.github.com/repos/api-playground/projects-test/issues/3\",\"project_url\":\"https://api.github.com/projects/120\"}]" + "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"}}]" } ] } @@ -11269,28 +5545,23 @@ "renamed": null }, { - "name": "Create a project card", - "scope": "projects", - "id": "createCard", - "method": "POST", - "url": "/projects/columns/{column_id}/cards", + "name": "List outside collaborators", + "scope": "orgs", + "id": "listOutsideCollaborators", + "method": "GET", + "url": "/orgs/{org}/outside_collaborators", "isDeprecated": false, "isLegacy": false, - "description": "**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key.\n\nBe aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests)\" endpoint.", - "documentationUrl": "https://developer.github.com/v3/projects/cards/#create-a-project-card", - "previews": [{ "name": "inertia" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.inertia-preview+json" - } - ], + "description": "List all users who are outside collaborators of an organization.\n\n", + "documentationUrl": "https://developer.github.com/v3/orgs/outside_collaborators/#list-outside-collaborators", + "previews": [], + "headers": [], "parameters": [ { - "name": "column_id", - "description": "column_id parameter", + "name": "org", + "description": "org parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -11300,12 +5571,12 @@ "deprecated": null }, { - "name": "note", - "description": "The card's note content. Only valid for cards without another type of content, so you must omit when specifying `content_id` and `content_type`.", - "in": "BODY", + "name": "filter", + "description": "Filter the list of outside collaborators. Can be one of: \n\\* `2fa_disabled`: Outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. \n\\* `all`: All outside collaborators.", + "in": "QUERY", "type": "string", "required": false, - "enum": null, + "enum": ["2fa_disabled", "all"], "allowNull": false, "mapToData": null, "validation": null, @@ -11313,9 +5584,9 @@ "deprecated": null }, { - "name": "content_id", - "description": "The issue or pull request id you want to associate with this card. You can use the [List issues for a repository](https://developer.github.com/v3/issues/#list-issues-for-a-repository) and [List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests) endpoints to find this id. \n**Note:** Depending on whether you use the issue id or pull request id, you will need to specify `Issue` or `PullRequest` as the `content_type`.", - "in": "BODY", + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", "type": "integer", "required": false, "enum": null, @@ -11326,10 +5597,10 @@ "deprecated": null }, { - "name": "content_type", - "description": "**Required if you provide `content_id`**. The type of content you want to associate with this card. Use `Issue` when `content_id` is an issue id and use `PullRequest` when `content_id` is a pull request id.", - "in": "BODY", - "type": "string", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -11341,11 +5612,11 @@ ], "responses": [ { - "code": 201, + "code": 200, "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/projects/columns/cards/1478\",\"id\":1478,\"node_id\":\"MDExOlByb2plY3RDYXJkMTQ3OA==\",\"note\":\"Add payload for delete Project column\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2016-09-05T14:21:06Z\",\"updated_at\":\"2016-09-05T14:20:22Z\",\"archived\":false,\"column_url\":\"https://api.github.com/projects/columns/367\",\"content_url\":\"https://api.github.com/repos/api-playground/projects-test/issues/3\",\"project_url\":\"https://api.github.com/projects/120\"}" + "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" } ] } @@ -11353,28 +5624,23 @@ "renamed": null }, { - "name": "Move a project column", - "scope": "projects", - "id": "moveColumn", - "method": "POST", - "url": "/projects/columns/{column_id}/moves", + "name": "Remove outside collaborator", + "scope": "orgs", + "id": "removeOutsideCollaborator", + "method": "DELETE", + "url": "/orgs/{org}/outside_collaborators/{username}", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/projects/columns/#move-a-project-column", - "previews": [{ "name": "inertia" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.inertia-preview+json" - } - ], + "description": "Removing a user from this list will remove them from all the organization's repositories.", + "documentationUrl": "https://developer.github.com/v3/orgs/outside_collaborators/#remove-outside-collaborator", + "previews": [], + "headers": [], "parameters": [ { - "name": "column_id", - "description": "column_id parameter", + "name": "org", + "description": "org parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -11384,45 +5650,10 @@ "deprecated": null }, { - "name": "position", - "description": "Can be one of `first`, `last`, or `after:`, where `` is the `id` value of a column in the same project.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": "^(first|last|after:\\d+)$", - "alias": null, - "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "Get a project", - "scope": "projects", - "id": "get", - "method": "GET", - "url": "/projects/{project_id}", - "isDeprecated": false, - "isLegacy": false, - "description": "Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", - "documentationUrl": "https://developer.github.com/v3/projects/#get-a-project", - "previews": [{ "name": "inertia" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.inertia-preview+json" - } - ], - "parameters": [ - { - "name": "project_id", - "description": "project_id parameter", + "name": "username", + "description": "username parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -11434,11 +5665,11 @@ ], "responses": [ { - "code": 200, - "description": "response", + "code": 422, + "description": "Response if user is a member of the organization", "examples": [ { - "data": "{\"owner_url\":\"https://api.github.com/repos/api-playground/projects-test\",\"url\":\"https://api.github.com/projects/1002604\",\"html_url\":\"https://github.com/api-playground/projects-test/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002604/columns\",\"id\":1002604,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDQ=\",\"name\":\"Projects Documentation\",\"body\":\"Developer documentation project for the developer site.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\"}" + "data": "{\"message\":\"You cannot specify an organization member to remove as an outside collaborator.\",\"documentation_url\":\"https://developer.github.com/v3/orgs/outside_collaborators/#remove-outside-collaborator\"}" } ] } @@ -11446,55 +5677,24 @@ "renamed": null }, { - "name": "Update a project", - "scope": "projects", - "id": "update", - "method": "PATCH", - "url": "/projects/{project_id}", + "name": "Convert member to outside collaborator", + "scope": "orgs", + "id": "convertMemberToOutsideCollaborator", + "method": "PUT", + "url": "/orgs/{org}/outside_collaborators/{username}", "isDeprecated": false, "isLegacy": false, - "description": "Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", - "documentationUrl": "https://developer.github.com/v3/projects/#update-a-project", - "previews": [{ "name": "inertia" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.inertia-preview+json" - } - ], + "description": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://help.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)\".", + "documentationUrl": "https://developer.github.com/v3/orgs/outside_collaborators/#convert-member-to-outside-collaborator", + "previews": [], + "headers": [], "parameters": [ { - "name": "project_id", - "description": "project_id parameter", + "name": "org", + "description": "org parameter", "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The name of the project.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The description of the project.", - "in": "BODY", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -11503,37 +5703,11 @@ "deprecated": null }, { - "name": "state", - "description": "State of the project. Either `open` or `closed`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["open", "closed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "organization_permission", - "description": "The permission level that determines whether all members of the project's organization can see and/or make changes to the project. Setting `organization_permission` is only available for organization projects. If an organization member belongs to a team with a higher level of access or is a collaborator with a higher level of access, their permission level is not lowered by `organization_permission`. For information on changing access for a team or collaborator, see [Add or update team project](https://developer.github.com/v3/teams/#add-or-update-team-project) or [Add user as a collaborator](https://developer.github.com/v3/projects/collaborators/#add-user-as-a-collaborator). \n \n**Note:** Updating a project's `organization_permission` requires `admin` access to the project. \n \nCan be one of: \n\\* `read` - Organization members can read, but not write to or administer this project. \n\\* `write` - Organization members can read and write, but not administer this project. \n\\* `admin` - Organization members can read, write and administer this project. \n\\* `none` - Organization members can only see this project if it is public.", - "in": "BODY", + "name": "username", + "description": "username parameter", + "in": "PATH", "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "private", - "description": "Sets the visibility of a project board. Setting `private` is only available for organization and user projects. **Note:** Updating a project's visibility requires `admin` access to the project. \n \nCan be one of: \n\\* `false` - Anyone can see the project. \n\\* `true` - Only the user can view a project board created on a user account. Organization members with the appropriate `organization_permission` can see project boards in an organization account.", - "in": "BODY", - "type": "boolean", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -11544,11 +5718,14 @@ ], "responses": [ { - "code": 200, + "code": 403, "description": "response", "examples": [ { - "data": "{\"owner_url\":\"https://api.github.com/repos/api-playground/projects-test\",\"url\":\"https://api.github.com/projects/1002604\",\"html_url\":\"https://github.com/api-playground/projects-test/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002604/columns\",\"id\":1002604,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDQ=\",\"name\":\"Projects Documentation\",\"body\":\"Developer documentation project for the developer site.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\"}" + "data": "{\"message\":\"Cannot convert the last owner to an outside collaborator\",\"documentation_url\":\"https://developer.github.com/v3/orgs/outside_collaborators/#convert-member-to-outside-collaborator\"}" + }, + { + "data": "{\"message\":\" is not a member of the organization.\",\"documentation_url\":\"https://developer.github.com/v3/orgs/outside_collaborators/#convert-member-to-outside-collaborator\"}" } ] } @@ -11556,63 +5733,29 @@ "renamed": null }, { - "name": "Delete a project", - "scope": "projects", - "id": "delete", - "method": "DELETE", - "url": "/projects/{project_id}", - "isDeprecated": false, - "isLegacy": false, - "description": "Deletes a project board. Returns a `404 Not Found` status if projects are disabled.", - "documentationUrl": "https://developer.github.com/v3/projects/#delete-a-project", - "previews": [{ "name": "inertia" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.inertia-preview+json" - } - ], - "parameters": [ - { - "name": "project_id", - "description": "project_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "List collaborators", + "name": "List organization projects", "scope": "projects", - "id": "listCollaborators", + "id": "listForOrg", "method": "GET", - "url": "/projects/{project_id}/collaborators", + "url": "/orgs/{org}/projects", "isDeprecated": false, "isLegacy": false, - "description": "Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators.", - "documentationUrl": "https://developer.github.com/v3/projects/collaborators/#list-collaborators", + "description": "Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.\n\ns", + "documentationUrl": "https://developer.github.com/v3/projects/#list-organization-projects", "previews": [{ "name": "inertia" }], "headers": [ { "name": "accept", - "value": "application/vnd.github.inertia-preview+json" + "value": "application/vnd.github.inertia-preview+json", + "required": true } ], "parameters": [ { - "name": "project_id", - "description": "project_id parameter", + "name": "org", + "description": "org parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -11622,12 +5765,12 @@ "deprecated": null }, { - "name": "affiliation", - "description": "Filters the collaborators by their affiliation. Can be one of: \n\\* `outside`: Outside collaborators of a project that are not a member of the project's organization. \n\\* `direct`: Collaborators with permissions to a project, regardless of organization membership status. \n\\* `all`: All collaborators the authenticated user can see.", + "name": "state", + "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", "in": "QUERY", "type": "string", "required": false, - "enum": ["outside", "direct", "all"], + "enum": ["open", "closed", "all"], "allowNull": false, "mapToData": null, "validation": null, @@ -11667,7 +5810,7 @@ "description": "response", "examples": [ { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" + "data": "[{\"owner_url\":\"https://api.github.com/orgs/octocat\",\"url\":\"https://api.github.com/projects/1002605\",\"html_url\":\"https://github.com/orgs/api-playground/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002605/columns\",\"id\":1002605,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDU=\",\"name\":\"Organization Roadmap\",\"body\":\"High-level roadmap for the upcoming year.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-11T20:09:31Z\",\"updated_at\":\"2014-03-04T18:58:10Z\"}]" } ] } @@ -11675,39 +5818,27 @@ "renamed": null }, { - "name": "Add user as a collaborator", + "name": "Create an organization project", "scope": "projects", - "id": "addCollaborator", - "method": "PUT", - "url": "/projects/{project_id}/collaborators/{username}", + "id": "createForOrg", + "method": "POST", + "url": "/orgs/{org}/projects", "isDeprecated": false, "isLegacy": false, - "description": "Adds a collaborator to a an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator.", - "documentationUrl": "https://developer.github.com/v3/projects/collaborators/#add-user-as-a-collaborator", + "description": "Creates an organization project board. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", + "documentationUrl": "https://developer.github.com/v3/projects/#create-an-organization-project", "previews": [{ "name": "inertia" }], "headers": [ { "name": "accept", - "value": "application/vnd.github.inertia-preview+json" + "value": "application/vnd.github.inertia-preview+json", + "required": true } ], "parameters": [ { - "name": "project_id", - "description": "project_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "username parameter", + "name": "org", + "description": "org parameter", "in": "PATH", "type": "string", "required": true, @@ -11719,93 +5850,10 @@ "deprecated": null }, { - "name": "permission", - "description": "The permission to grant the collaborator. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\" Can be one of: \n\\* `read` - can read, but not write to or administer this project. \n\\* `write` - can read and write, but not administer this project. \n\\* `admin` - can read, write and administer this project.", + "name": "name", + "description": "The name of the project.", "in": "BODY", "type": "string", - "required": false, - "enum": ["read", "write", "admin"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "Remove user as a collaborator", - "scope": "projects", - "id": "removeCollaborator", - "method": "DELETE", - "url": "/projects/{project_id}/collaborators/{username}", - "isDeprecated": false, - "isLegacy": false, - "description": "Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator.", - "documentationUrl": "https://developer.github.com/v3/projects/collaborators/#remove-user-as-a-collaborator", - "previews": [{ "name": "inertia" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.inertia-preview+json" - } - ], - "parameters": [ - { - "name": "project_id", - "description": "project_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "username", - "description": "username parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "Review a user's permission level", - "scope": "projects", - "id": "reviewUserPermissionLevel", - "method": "GET", - "url": "/projects/{project_id}/collaborators/{username}/permission", - "isDeprecated": false, - "isLegacy": false, - "description": "Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level.", - "documentationUrl": "https://developer.github.com/v3/projects/collaborators/#review-a-users-permission-level", - "previews": [{ "name": "inertia" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.inertia-preview+json" - } - ], - "parameters": [ - { - "name": "project_id", - "description": "project_id parameter", - "in": "PATH", - "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -11815,11 +5863,11 @@ "deprecated": null }, { - "name": "username", - "description": "username parameter", - "in": "PATH", + "name": "body", + "description": "The description of the project.", + "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -11830,11 +5878,11 @@ ], "responses": [ { - "code": 200, + "code": 201, "description": "response", "examples": [ { - "data": "{\"permission\":\"admin\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" + "data": "{\"owner_url\":\"https://api.github.com/orgs/octocat\",\"url\":\"https://api.github.com/projects/1002605\",\"html_url\":\"https://github.com/orgs/api-playground/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002605/columns\",\"id\":1002605,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDU=\",\"name\":\"Organization Roadmap\",\"body\":\"High-level roadmap for the upcoming year.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-11T20:09:31Z\",\"updated_at\":\"2014-03-04T18:58:10Z\"}" } ] } @@ -11842,28 +5890,23 @@ "renamed": null }, { - "name": "List project columns", - "scope": "projects", - "id": "listColumns", - "method": "GET", - "url": "/projects/{project_id}/columns", - "isDeprecated": false, - "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/projects/columns/#list-project-columns", - "previews": [{ "name": "inertia" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.inertia-preview+json" - } - ], + "name": "Public members list", + "scope": "orgs", + "id": "listPublicMembers", + "method": "GET", + "url": "/orgs/{org}/public_members", + "isDeprecated": false, + "isLegacy": false, + "description": "Members of an organization can choose to have their membership publicized or not.", + "documentationUrl": "https://developer.github.com/v3/orgs/members/#public-members-list", + "previews": [], + "headers": [], "parameters": [ { - "name": "project_id", - "description": "project_id parameter", + "name": "org", + "description": "org parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -11905,7 +5948,7 @@ "description": "response", "examples": [ { - "data": "[{\"url\":\"https://api.github.com/projects/columns/367\",\"project_url\":\"https://api.github.com/projects/120\",\"cards_url\":\"https://api.github.com/projects/columns/367/cards\",\"id\":367,\"node_id\":\"MDEzOlByb2plY3RDb2x1bW4zNjc=\",\"name\":\"To Do\",\"created_at\":\"2016-09-05T14:18:44Z\",\"updated_at\":\"2016-09-05T14:22:28Z\"}]" + "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" } ] } @@ -11913,28 +5956,23 @@ "renamed": null }, { - "name": "Create a project column", - "scope": "projects", - "id": "createColumn", - "method": "POST", - "url": "/projects/{project_id}/columns", + "name": "Check public membership", + "scope": "orgs", + "id": "checkPublicMembership", + "method": "GET", + "url": "/orgs/{org}/public_members/{username}", "isDeprecated": false, "isLegacy": false, "description": "", - "documentationUrl": "https://developer.github.com/v3/projects/columns/#create-a-project-column", - "previews": [{ "name": "inertia" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.inertia-preview+json" - } - ], + "documentationUrl": "https://developer.github.com/v3/orgs/members/#check-public-membership", + "previews": [], + "headers": [], "parameters": [ { - "name": "project_id", - "description": "project_id parameter", + "name": "org", + "description": "org parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -11944,9 +5982,9 @@ "deprecated": null }, { - "name": "name", - "description": "The name of the column.", - "in": "BODY", + "name": "username", + "description": "username parameter", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -11957,68 +5995,40 @@ "deprecated": null } ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/projects/columns/367\",\"project_url\":\"https://api.github.com/projects/120\",\"cards_url\":\"https://api.github.com/projects/columns/367/cards\",\"id\":367,\"node_id\":\"MDEzOlByb2plY3RDb2x1bW4zNjc=\",\"name\":\"To Do\",\"created_at\":\"2016-09-05T14:18:44Z\",\"updated_at\":\"2016-09-05T14:22:28Z\"}" - } - ] - } - ], + "responses": [], "renamed": null }, { - "name": "Get your current rate limit status", - "scope": "rateLimit", - "id": "get", - "method": "GET", - "url": "/rate_limit", + "name": "Publicize a user's membership", + "scope": "orgs", + "id": "publicizeMembership", + "method": "PUT", + "url": "/orgs/{org}/public_members/{username}", "isDeprecated": false, "isLegacy": false, - "description": "**Note:** Accessing this endpoint does not count against your REST API rate limit.\n\n**Understanding your rate limit status**\n\nThe Search API has a [custom rate limit](https://developer.github.com/v3/search/#rate-limit), separate from the rate limit governing the rest of the REST API. The GraphQL API also has a [custom rate limit](https://developer.github.com/v4/guides/resource-limitations/#rate-limit) that is separate from and calculated differently than rate limits in the REST API.\n\nFor these reasons, the Rate Limit API response categorizes your rate limit. Under `resources`, you'll see four objects:\n\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the [Search API](https://developer.github.com/v3/search/).\n* The `graphql` object provides your rate limit status for the [GraphQL API](https://developer.github.com/v4/).\n* The `integration_manifest` object provides your rate limit status for the [GitHub App Manifest code conversion](https://developer.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration) endpoint.\n\nFor more information on the headers and values in the rate limit response, see \"[Rate limiting](https://developer.github.com/v3/#rate-limiting).\"\n\nThe `rate` object (shown at the bottom of the response above) is deprecated.\n\nIf you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", - "documentationUrl": "https://developer.github.com/v3/rate_limit/#get-your-current-rate-limit-status", + "description": "The user can publicize their own membership. (A user cannot publicize the membership for another user.)\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\"", + "documentationUrl": "https://developer.github.com/v3/orgs/members/#publicize-a-users-membership", "previews": [], "headers": [], - "parameters": [], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"resources\":{\"core\":{\"limit\":5000,\"remaining\":4999,\"reset\":1372700873},\"search\":{\"limit\":30,\"remaining\":18,\"reset\":1372697452},\"graphql\":{\"limit\":5000,\"remaining\":4993,\"reset\":1372700389},\"integration_manifest\":{\"limit\":5000,\"remaining\":4999,\"reset\":1551806725}},\"rate\":{\"limit\":5000,\"remaining\":4999,\"reset\":1372700873}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Delete a reaction", - "scope": "reactions", - "id": "delete", - "method": "DELETE", - "url": "/reactions/{reaction_id}", - "isDeprecated": false, - "isLegacy": false, - "description": "OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), when deleting a [team discussion](https://developer.github.com/v3/teams/discussions/) or [team discussion comment](https://developer.github.com/v3/teams/discussion_comments/).", - "documentationUrl": "https://developer.github.com/v3/reactions/#delete-a-reaction", - "previews": [{ "name": "squirrel-girl" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.squirrel-girl-preview+json" - } - ], "parameters": [ { - "name": "reaction_id", - "description": "reaction_id parameter", + "name": "org", + "description": "org parameter", "in": "PATH", - "type": "integer", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "username", + "description": "username parameter", + "in": "PATH", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -12032,21 +6042,21 @@ "renamed": null }, { - "name": "Get", - "scope": "repos", - "id": "get", - "method": "GET", - "url": "/repos/{owner}/{repo}", + "name": "Conceal a user's membership", + "scope": "orgs", + "id": "concealMembership", + "method": "DELETE", + "url": "/orgs/{org}/public_members/{username}", "isDeprecated": false, "isLegacy": false, - "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.", - "documentationUrl": "https://developer.github.com/v3/repos/#get", + "description": "", + "documentationUrl": "https://developer.github.com/v3/orgs/members/#conceal-a-users-membership", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "owner parameter", + "name": "org", + "description": "org parameter", "in": "PATH", "type": "string", "required": true, @@ -12058,8 +6068,8 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", + "name": "username", + "description": "username parameter", "in": "PATH", "type": "string", "required": true, @@ -12071,35 +6081,25 @@ "deprecated": null } ], - "responses": [ - { - "code": 200, - "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.", - "examples": [ - { - "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"organization\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"parent\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"source\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}" - } - ] - } - ], + "responses": [], "renamed": null }, { - "name": "Edit", + "name": "List organization repositories", "scope": "repos", - "id": "update", - "method": "PATCH", - "url": "/repos/{owner}/{repo}", + "id": "listForOrg", + "method": "GET", + "url": "/orgs/{org}/repos", "isDeprecated": false, "isLegacy": false, - "description": "**Note**: To edit a repository's topics, use the [`topics` endpoint](https://developer.github.com/v3/repos/#replace-all-topics-for-a-repository).", - "documentationUrl": "https://developer.github.com/v3/repos/#edit", + "description": "Lists repositories for the specified organization.", + "documentationUrl": "https://developer.github.com/v3/repos/#list-organization-repositories", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "owner parameter", + "name": "org", + "description": "org parameter", "in": "PATH", "type": "string", "required": true, @@ -12111,12 +6111,20 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "type", + "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud, `type` can also be `internal`.", + "in": "QUERY", "type": "string", - "required": true, - "enum": null, + "required": false, + "enum": [ + "all", + "public", + "private", + "forks", + "sources", + "member", + "internal" + ], "allowNull": false, "mapToData": null, "validation": null, @@ -12124,12 +6132,12 @@ "deprecated": null }, { - "name": "name", - "description": "The name of the repository.", - "in": "BODY", + "name": "sort", + "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.", + "in": "QUERY", "type": "string", "required": false, - "enum": null, + "enum": ["created", "updated", "pushed", "full_name"], "allowNull": false, "mapToData": null, "validation": null, @@ -12137,12 +6145,12 @@ "deprecated": null }, { - "name": "description", - "description": "A short description of the repository.", - "in": "BODY", + "name": "direction", + "description": "Can be one of `asc` or `desc`. Default: when using `full_name`: `asc`, otherwise `desc`", + "in": "QUERY", "type": "string", "required": false, - "enum": null, + "enum": ["asc", "desc"], "allowNull": false, "mapToData": null, "validation": null, @@ -12150,10 +6158,10 @@ "deprecated": null }, { - "name": "homepage", - "description": "A URL with more information about the repository.", - "in": "BODY", - "type": "string", + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -12163,10 +6171,10 @@ "deprecated": null }, { - "name": "private", - "description": "Either `true` to make the repository private or `false` to make it public. Creating private repositories requires a paid GitHub account. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", - "in": "BODY", - "type": "boolean", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -12174,14 +6182,41 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "visibility", - "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud, `visibility` can also be `internal`. The `visibility` parameter overrides the `private` parameter when you use both along with the `nebula-preview` preview header.", - "in": "BODY", + "code": 200, + "description": "response", + "examples": [ + { + "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"}}]" + } + ] + } + ], + "renamed": null + }, + { + "name": "Creates a new repository in the specified organization", + "scope": "repos", + "id": "createInOrg", + "method": "POST", + "url": "/orgs/{org}/repos", + "isDeprecated": false, + "isLegacy": false, + "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "documentationUrl": "https://developer.github.com/v3/repos/#create", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "org parameter", + "in": "PATH", "type": "string", - "required": false, - "enum": ["public", "private", "visibility", "internal"], + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -12189,11 +6224,11 @@ "deprecated": null }, { - "name": "has_issues", - "description": "Either `true` to enable issues for this repository or `false` to disable them.", + "name": "name", + "description": "The name of the repository.", "in": "BODY", - "type": "boolean", - "required": false, + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -12202,10 +6237,10 @@ "deprecated": null }, { - "name": "has_projects", - "description": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", + "name": "description", + "description": "A short description of the repository.", "in": "BODY", - "type": "boolean", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -12215,10 +6250,10 @@ "deprecated": null }, { - "name": "has_wiki", - "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", + "name": "homepage", + "description": "A URL with more information about the repository.", "in": "BODY", - "type": "boolean", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -12228,8 +6263,8 @@ "deprecated": null }, { - "name": "is_template", - "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", + "name": "private", + "description": "Either `true` to create a private repository or `false` to create a public one. Creating private repositories requires a paid GitHub account.", "in": "BODY", "type": "boolean", "required": false, @@ -12241,12 +6276,12 @@ "deprecated": null }, { - "name": "default_branch", - "description": "Updates the default branch for this repository.", + "name": "visibility", + "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/github/creating-cloning-and-archiving-repositories/creating-an-internal-repository)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", "in": "BODY", "type": "string", "required": false, - "enum": null, + "enum": ["public", "private", "visibility", "internal"], "allowNull": false, "mapToData": null, "validation": null, @@ -12254,8 +6289,8 @@ "deprecated": null }, { - "name": "allow_squash_merge", - "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", + "name": "has_issues", + "description": "Either `true` to enable issues for this repository or `false` to disable them.", "in": "BODY", "type": "boolean", "required": false, @@ -12267,8 +6302,8 @@ "deprecated": null }, { - "name": "allow_merge_commit", - "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", + "name": "has_projects", + "description": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", "in": "BODY", "type": "boolean", "required": false, @@ -12280,8 +6315,8 @@ "deprecated": null }, { - "name": "allow_rebase_merge", - "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", + "name": "has_wiki", + "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", "in": "BODY", "type": "boolean", "required": false, @@ -12293,8 +6328,8 @@ "deprecated": null }, { - "name": "delete_branch_on_merge", - "description": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", + "name": "is_template", + "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", "in": "BODY", "type": "boolean", "required": false, @@ -12306,10 +6341,10 @@ "deprecated": null }, { - "name": "archived", - "description": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.", + "name": "team_id", + "description": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.", "in": "BODY", - "type": "boolean", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -12317,159 +6352,13 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"organization\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"parent\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"source\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Delete a repository", - "scope": "repos", - "id": "delete", - "method": "DELETE", - "url": "/repos/{owner}/{repo}", - "isDeprecated": false, - "isLegacy": false, - "description": "Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required.\n\nIf an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response:", - "documentationUrl": "https://developer.github.com/v3/repos/#delete-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "owner parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "repo parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 403, - "description": "If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response:", - "examples": [ - { - "data": "{\"message\":\"Organization members cannot delete repositories.\",\"documentation_url\":\"https://developer.github.com/v3/repos/#delete-a-repository\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get an artifact", - "scope": "actions", - "id": "getArtifact", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}", - "isDeprecated": false, - "isLegacy": false, - "description": "Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.", - "documentationUrl": "https://developer.github.com/v3/actions/artifacts/#get-an-artifact", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "owner parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "repo parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null }, { - "name": "artifact_id", - "description": "artifact_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"id\":11,\"node_id\":\"MDg6QXJ0aWZhY3QxMQ==\",\"name\":\"Rails\",\"size_in_bytes\":556,\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/5/zip\",\"expired\":\"false\",\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-01-21T14:59:22Z\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Delete an artifact", - "scope": "actions", - "id": "deleteArtifact", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}", - "isDeprecated": false, - "isLegacy": false, - "description": "Deletes an artifact for a workflow run. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.", - "documentationUrl": "https://developer.github.com/v3/actions/artifacts/#delete-an-artifact", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "owner parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "auto_init", + "description": "Pass `true` to create an initial commit with empty README.", + "in": "BODY", + "type": "boolean", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -12478,54 +6367,24 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "gitignore_template", + "description": "Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, \"Haskell\".", + "in": "BODY", "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "artifact_id", - "description": "artifact_id parameter", - "in": "PATH", - "type": "integer", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "Download an artifact", - "scope": "actions", - "id": "downloadArtifact", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}", - "isDeprecated": false, - "isLegacy": false, - "description": "Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in the response header to find the URL for the download. The `:archive_format` must be `zip`. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.\n\nCall this endpoint using the `-v` flag, which enables verbose output and allows you to see the download URL in the header. To download the file into the current working directory, specify the filename using the `-o` flag.", - "documentationUrl": "https://developer.github.com/v3/actions/artifacts/#download-an-artifact", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "owner", - "description": "owner parameter", - "in": "PATH", + "name": "license_template", + "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://help.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\".", + "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -12534,11 +6393,11 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "allow_squash_merge", + "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", + "in": "BODY", + "type": "boolean", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -12547,11 +6406,11 @@ "deprecated": null }, { - "name": "artifact_id", - "description": "artifact_id parameter", - "in": "PATH", - "type": "integer", - "required": true, + "name": "allow_merge_commit", + "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", + "in": "BODY", + "type": "boolean", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -12560,11 +6419,24 @@ "deprecated": null }, { - "name": "archive_format", - "description": "archive_format parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "allow_rebase_merge", + "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", + "in": "BODY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "delete_branch_on_merge", + "description": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", + "in": "BODY", + "type": "boolean", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -12573,25 +6445,35 @@ "deprecated": null } ], - "responses": [], + "responses": [ + { + "code": 201, + "description": "response", + "examples": [ + { + "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}" + } + ] + } + ], "renamed": null }, { - "name": "Get a workflow job", - "scope": "actions", - "id": "getWorkflowJob", + "name": "List teams", + "scope": "teams", + "id": "list", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/jobs/{job_id}", + "url": "/orgs/{org}/teams", "isDeprecated": false, "isLegacy": false, - "description": "Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.", - "documentationUrl": "https://developer.github.com/v3/actions/workflow_jobs/#get-a-workflow-job", + "description": "Lists all teams in an organization that are visible to the authenticated user.", + "documentationUrl": "https://developer.github.com/v3/teams/#list-teams", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "owner parameter", + "name": "org", + "description": "org parameter", "in": "PATH", "type": "string", "required": true, @@ -12603,11 +6485,11 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -12616,11 +6498,11 @@ "deprecated": null }, { - "name": "job_id", - "description": "job_id parameter", - "in": "PATH", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", "type": "integer", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -12631,11 +6513,11 @@ ], "responses": [ { - "code": 202, + "code": 200, "description": "response", "examples": [ { - "data": "{\"id\":399444496,\"run_id\":29679449,\"run_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449\",\"node_id\":\"MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==\",\"head_sha\":\"f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496\",\"html_url\":\"https://github.com/octo-org/octo-repo/runs/399444496\",\"status\":\"completed\",\"conclusion\":\"success\",\"started_at\":\"2020-01-20T17:42:40Z\",\"completed_at\":\"2020-01-20T17:44:39Z\",\"name\":\"build\",\"steps\":[{\"name\":\"Set up job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":1,\"started_at\":\"2020-01-20T09:42:40.000-08:00\",\"completed_at\":\"2020-01-20T09:42:41.000-08:00\"},{\"name\":\"Run actions/checkout@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":2,\"started_at\":\"2020-01-20T09:42:41.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Set up Ruby\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":3,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Run actions/cache@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":4,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:48.000-08:00\"},{\"name\":\"Install Bundler\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":5,\"started_at\":\"2020-01-20T09:42:48.000-08:00\",\"completed_at\":\"2020-01-20T09:42:52.000-08:00\"},{\"name\":\"Install Gems\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":6,\"started_at\":\"2020-01-20T09:42:52.000-08:00\",\"completed_at\":\"2020-01-20T09:42:53.000-08:00\"},{\"name\":\"Run Tests\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":7,\"started_at\":\"2020-01-20T09:42:53.000-08:00\",\"completed_at\":\"2020-01-20T09:42:59.000-08:00\"},{\"name\":\"Deploy to Heroku\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":8,\"started_at\":\"2020-01-20T09:42:59.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Post actions/cache@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":16,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Complete job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":17,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"}],\"check_run_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496\"}" + "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]" } ] } @@ -12643,21 +6525,21 @@ "renamed": null }, { - "name": "List workflow job logs", - "scope": "actions", - "id": "listWorkflowJobLogs", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs", + "name": "Create team", + "scope": "teams", + "id": "create", + "method": "POST", + "url": "/orgs/{org}/teams", "isDeprecated": false, "isLegacy": false, - "description": "Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.\n\nCall this endpoint using the `-v` flag, which enables verbose output and allows you to see the download URL in the header. To download the file into the current working directory, specify the filename using the `-o` flag.", - "documentationUrl": "https://developer.github.com/v3/actions/workflow_jobs/#list-workflow-job-logs", + "description": "To create a team, the authenticated user must be a member or owner of `:org`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://help.github.com/en/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)\" in the GitHub Help documentation.", + "documentationUrl": "https://developer.github.com/v3/teams/#create-team", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "owner parameter", + "name": "org", + "description": "org parameter", "in": "PATH", "type": "string", "required": true, @@ -12669,9 +6551,9 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "name", + "description": "The name of the team.", + "in": "BODY", "type": "string", "required": true, "enum": null, @@ -12682,11 +6564,11 @@ "deprecated": null }, { - "name": "job_id", - "description": "job_id parameter", - "in": "PATH", - "type": "integer", - "required": true, + "name": "description", + "description": "The description of the team.", + "in": "BODY", + "type": "string", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -12695,10 +6577,10 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", + "name": "maintainers", + "description": "List GitHub IDs for organization members who will become team maintainers.", + "in": "BODY", + "type": "string[]", "required": false, "enum": null, "allowNull": false, @@ -12708,10 +6590,10 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", + "name": "repo_names", + "description": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.", + "in": "BODY", + "type": "string[]", "required": false, "enum": null, "allowNull": false, @@ -12719,44 +6601,14 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "List self-hosted runners for a repository", - "scope": "actions", - "id": "listSelfHostedRunnersForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runners", - "isDeprecated": false, - "isLegacy": false, - "description": "Lists all self-hosted runners for a repository. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the `administration` permission to use this endpoint.", - "documentationUrl": "https://developer.github.com/v3/actions/self_hosted_runners/#list-self-hosted-runners-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "owner parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "privacy", + "description": "The level of privacy this team should have. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \nDefault: `secret` \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization. \nDefault for child team: `closed`", + "in": "BODY", "type": "string", - "required": true, - "enum": null, + "required": false, + "enum": ["secret", "closed"], "allowNull": false, "mapToData": null, "validation": null, @@ -12764,12 +6616,12 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", + "name": "permission", + "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer newly-added repositories. \n\\* `push` - team members can pull and push, but not administer newly-added repositories. \n\\* `admin` - team members can pull, push and administer newly-added repositories.", + "in": "BODY", + "type": "string", "required": false, - "enum": null, + "enum": ["pull", "push", "admin"], "allowNull": false, "mapToData": null, "validation": null, @@ -12777,9 +6629,9 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", + "name": "parent_team_id", + "description": "The ID of a team to set as the parent team.", + "in": "BODY", "type": "integer", "required": false, "enum": null, @@ -12792,11 +6644,11 @@ ], "responses": [ { - "code": 200, + "code": 201, "description": "response", "examples": [ { - "data": "[[{\"id\":23,\"name\":\"MBP\",\"os\":\"macos\",\"status\":\"online\"},{\"id\":24,\"name\":\"iMac\",\"os\":\"macos\",\"status\":\"offline\"}]]" + "data": "{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null,\"members_count\":3,\"repos_count\":10,\"created_at\":\"2017-07-14T16:53:42Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"is_verified\":true,\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"type\":\"Organization\"}}" } ] } @@ -12804,21 +6656,21 @@ "renamed": null }, { - "name": "List downloads for the self-hosted runner application", - "scope": "actions", - "id": "listDownloadsForSelfHostedRunnerApplication", + "name": "Get team by name", + "scope": "teams", + "id": "getByName", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runners/downloads", + "url": "/orgs/{org}/teams/{team_slug}", "isDeprecated": false, "isLegacy": false, - "description": "Lists binaries for the self-hosted runner application that you can download and run. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the `administration` permission to use this endpoint.", - "documentationUrl": "https://developer.github.com/v3/actions/self_hosted_runners/#list-downloads-for-the-self-hosted-runner-application", + "description": "Gets a team using the team's `slug`. GitHub generates the `slug` from the team `name`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id`.", + "documentationUrl": "https://developer.github.com/v3/teams/#get-team-by-name", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "owner parameter", + "name": "org", + "description": "org parameter", "in": "PATH", "type": "string", "required": true, @@ -12830,8 +6682,8 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", + "name": "team_slug", + "description": "team_slug parameter", "in": "PATH", "type": "string", "required": true, @@ -12849,7 +6701,7 @@ "description": "response", "examples": [ { - "data": "[{\"os\":\"osx\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz\",\"filename\":\"actions-runner-osx-x64-2.164.0.tar.gz\"},{\"os\":\"linux\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-x64-2.164.0.tar.gz\"},{\"os\":\"linux\",\"architecture\":\"arm\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-arm-2.164.0.tar.gz\"},{\"os\":\"win\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip\",\"filename\":\"actions-runner-win-x64-2.164.0.zip\"},{\"os\":\"linux\",\"architecture\":\"arm64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-arm64-2.164.0.tar.gz\"}]" + "data": "{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null,\"members_count\":3,\"repos_count\":10,\"created_at\":\"2017-07-14T16:53:42Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"is_verified\":true,\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"type\":\"Organization\"}}" } ] } @@ -12857,21 +6709,21 @@ "renamed": null }, { - "name": "Create a registration token", - "scope": "actions", - "id": "createRegistrationToken", - "method": "POST", - "url": "/repos/{owner}/{repo}/actions/runners/registration-token", + "name": "Edit team", + "scope": "teams", + "id": "updateInOrg", + "method": "PATCH", + "url": "/orgs/{org}/teams/{team_slug}", "isDeprecated": false, "isLegacy": false, - "description": "Returns a token that you can pass to the `config` script. The token expires after one hour. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the `administration` permission to use this endpoint.\n\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.\n\n", - "documentationUrl": "https://developer.github.com/v3/actions/self_hosted_runners/#create-a-registration-token", + "description": "To edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/:org_id/team/:team_id`.", + "documentationUrl": "https://developer.github.com/v3/teams/#edit-team", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "owner parameter", + "name": "org", + "description": "org parameter", "in": "PATH", "type": "string", "required": true, @@ -12883,8 +6735,8 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", + "name": "team_slug", + "description": "team_slug parameter", "in": "PATH", "type": "string", "required": true, @@ -12894,38 +6746,11 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "response", - "examples": [ - { - "data": "{\"token\":\"LLBF3JGZDX3P5PMEXLND6TS6FCWO6\",\"expires_at\":\"2020-01-22T12:13:35.123-08:00\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a remove token", - "scope": "actions", - "id": "createRemoveToken", - "method": "POST", - "url": "/repos/{owner}/{repo}/actions/runners/remove-token", - "isDeprecated": false, - "isLegacy": false, - "description": "Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the `administration` permission to use this endpoint.\n\nRemove your self-hosted runner from a repository, replacing TOKEN with the remove token provided by this endpoint.\n\n", - "documentationUrl": "https://developer.github.com/v3/actions/self_hosted_runners/#create-a-remove-token", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "owner", - "description": "owner parameter", - "in": "PATH", + "name": "name", + "description": "The name of the team.", + "in": "BODY", "type": "string", "required": true, "enum": null, @@ -12936,52 +6761,25 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "description", + "description": "The description of the team.", + "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "response", - "examples": [ - { - "data": "{\"token\":\"AABF3JGZDX3P5PMEXLND6TS6FCWO6\",\"expires_at\":\"2020-01-29T12:13:35.123-08:00\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a self-hosted runner", - "scope": "actions", - "id": "getSelfHostedRunner", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runners/{runner_id}", - "isDeprecated": false, - "isLegacy": false, - "description": "Gets a specific self-hosted runner. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the `administration` permission to use this endpoint.", - "documentationUrl": "https://developer.github.com/v3/actions/self_hosted_runners/#get-a-self-hosted-runner", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "owner", - "description": "owner parameter", - "in": "PATH", + "name": "privacy", + "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.", + "in": "BODY", "type": "string", - "required": true, - "enum": null, + "required": false, + "enum": ["secret", "closed"], "allowNull": false, "mapToData": null, "validation": null, @@ -12989,12 +6787,12 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "permission", + "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer newly-added repositories. \n\\* `push` - team members can pull and push, but not administer newly-added repositories. \n\\* `admin` - team members can pull, push and administer newly-added repositories.", + "in": "BODY", "type": "string", - "required": true, - "enum": null, + "required": false, + "enum": ["pull", "push", "admin"], "allowNull": false, "mapToData": null, "validation": null, @@ -13002,11 +6800,11 @@ "deprecated": null }, { - "name": "runner_id", - "description": "runner_id parameter", - "in": "PATH", + "name": "parent_team_id", + "description": "The ID of a team to set as the parent team.", + "in": "BODY", "type": "integer", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -13017,11 +6815,11 @@ ], "responses": [ { - "code": 200, + "code": 201, "description": "response", "examples": [ { - "data": "{\"id\":23,\"name\":\"MBP\",\"os\":\"macos\",\"status\":\"online\"}" + "data": "{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null,\"members_count\":3,\"repos_count\":10,\"created_at\":\"2017-07-14T16:53:42Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"is_verified\":true,\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"type\":\"Organization\"}}" } ] } @@ -13029,21 +6827,21 @@ "renamed": null }, { - "name": "Remove a self-hosted runner", - "scope": "actions", - "id": "removeSelfHostedRunner", + "name": "Delete team", + "scope": "teams", + "id": "deleteInOrg", "method": "DELETE", - "url": "/repos/{owner}/{repo}/actions/runners/{runner_id}", + "url": "/orgs/{org}/teams/{team_slug}", "isDeprecated": false, "isLegacy": false, - "description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the `administration` permission to use this endpoint.", - "documentationUrl": "https://developer.github.com/v3/actions/self_hosted_runners/#remove-a-self-hosted-runner", + "description": "To delete a team, the authenticated user must be an organization owner or team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/:org_id/team/:team_id`.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.", + "documentationUrl": "https://developer.github.com/v3/teams/#delete-team", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "owner parameter", + "name": "org", + "description": "org parameter", "in": "PATH", "type": "string", "required": true, @@ -13055,8 +6853,8 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", + "name": "team_slug", + "description": "team_slug parameter", "in": "PATH", "type": "string", "required": true, @@ -13066,40 +6864,27 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "runner_id", - "description": "runner_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null } ], "responses": [], "renamed": null }, { - "name": "List repository workflow runs", - "scope": "actions", - "id": "listRepoWorkflowRuns", + "name": "List discussions", + "scope": "teams", + "id": "listDiscussionsInOrg", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runs", + "url": "/orgs/{org}/teams/{team_slug}/discussions", "isDeprecated": false, "isLegacy": false, - "description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://developer.github.com/v3/#parameters).\n\nAnyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.", - "documentationUrl": "https://developer.github.com/v3/actions/workflow_runs/#list-repository-workflow-runs", + "description": "List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions`.", + "documentationUrl": "https://developer.github.com/v3/teams/discussions/#list-discussions", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "owner parameter", + "name": "org", + "description": "org parameter", "in": "PATH", "type": "string", "required": true, @@ -13111,8 +6896,8 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", + "name": "team_slug", + "description": "team_slug parameter", "in": "PATH", "type": "string", "required": true, @@ -13124,12 +6909,12 @@ "deprecated": null }, { - "name": "actor", - "description": "Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run.", + "name": "direction", + "description": "Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`.", "in": "QUERY", "type": "string", "required": false, - "enum": null, + "enum": ["asc", "desc"], "allowNull": false, "mapToData": null, "validation": null, @@ -13137,10 +6922,10 @@ "deprecated": null }, { - "name": "branch", - "description": "Returns workflow runs associated with a branch. Use the name of the branch of the `push`.", + "name": "per_page", + "description": "Results per page (max 100)", "in": "QUERY", - "type": "string", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -13150,10 +6935,10 @@ "deprecated": null }, { - "name": "event", - "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)\" in the GitHub Help documentation.", + "name": "page", + "description": "Page number of the results to fetch.", "in": "QUERY", - "type": "string", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -13161,14 +6946,54 @@ "validation": null, "alias": null, "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "response", + "examples": [ + { + "data": "[{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"

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

\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":0,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":null,\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Our first team post\",\"updated_at\":\"2018-01-25T18:56:31Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0}}]" + } + ] + } + ], + "renamed": null + }, + { + "name": "Create a discussion", + "scope": "teams", + "id": "createDiscussionInOrg", + "method": "POST", + "url": "/orgs/{org}/teams/{team_slug}/discussions", + "isDeprecated": false, + "isLegacy": false, + "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions`.", + "documentationUrl": "https://developer.github.com/v3/teams/discussions/#create-a-discussion", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "org", + "description": "org parameter", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null }, { - "name": "status", - "description": "Returns workflow runs associated with the check run `status` or `conclusion` you specify. For example, a conclusion can be `success` or a status can be `completed`. For more information, see the `status` and `conclusion` options available in \"[Create a check run](https://developer.github.com/v3/checks/runs/#create-a-check-run).\"", - "in": "QUERY", + "name": "team_slug", + "description": "team_slug parameter", + "in": "PATH", "type": "string", - "required": false, - "enum": ["completed", "status", "conclusion"], + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -13176,11 +7001,11 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "title", + "description": "The discussion post's title.", + "in": "BODY", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -13189,10 +7014,23 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", + "name": "body", + "description": "The discussion post's body text.", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "private", + "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.", + "in": "BODY", + "type": "boolean", "required": false, "enum": null, "allowNull": false, @@ -13204,11 +7042,11 @@ ], "responses": [ { - "code": 200, + "code": 201, "description": "response", "examples": [ { - "data": "{\"total_count\":1,\"workflow_runs\":[{\"id\":30433642,\"node_id\":\"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\"head_branch\":\"master\",\"head_sha\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"run_number\":562,\"check_suite_id\":414944374,\"event\":\"push\",\"status\":\"queued\",\"conclusion\":null,\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\"html_url\":\"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\"pull_requests\":[],\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"jobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\"logs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\"artifacts_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\"cancel_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\"rerun_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\"workflow_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/30433642\",\"head_commit\":{\"id\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"tree_id\":\"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\"message\":\"Create linter.yml\",\"timestamp\":\"2020-01-22T19:33:05Z\",\"author\":{\"name\":\"Octo Cat\",\"email\":\"octocat@github.com\"},\"committer\":{\"name\":\"GitHub\",\"email\":\"noreply@github.com\"}},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\"},\"head_repository\":{\"id\":217723378,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\"name\":\"octo-repo\",\"full_name\":\"octo-org/octo-repo\",\"private\":true,\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"html_url\":\"https://github.com/octo-org/octo-repo\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/octo-repo\",\"forks_url\":\"https://api.github.com/repos/octo-org/octo-repo/forks\",\"keys_url\":\"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octo-org/octo-repo/teams\",\"hooks_url\":\"https://api.github.com/repos/octo-org/octo-repo/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octo-org/octo-repo/events\",\"assignees_url\":\"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/tags\",\"blobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octo-org/octo-repo/languages\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octo-org/octo-repo/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscription\",\"commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octo-org/octo-repo/merges\",\"archive_url\":\"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octo-org/octo-repo/downloads\",\"issues_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octo-org/octo-repo/deployments\"}}]}" + "data": "{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"

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

\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":0,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":null,\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Our first team post\",\"updated_at\":\"2018-01-25T18:56:31Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0}}" } ] } @@ -13216,21 +7054,21 @@ "renamed": null }, { - "name": "Get a workflow run", - "scope": "actions", - "id": "getWorkflowRun", + "name": "Get a single discussion", + "scope": "teams", + "id": "getDiscussionInOrg", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}", + "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", "isDeprecated": false, "isLegacy": false, - "description": "Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.", - "documentationUrl": "https://developer.github.com/v3/actions/workflow_runs/#get-a-workflow-run", + "description": "Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number`.", + "documentationUrl": "https://developer.github.com/v3/teams/discussions/#get-a-single-discussion", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "owner parameter", + "name": "org", + "description": "org parameter", "in": "PATH", "type": "string", "required": true, @@ -13242,8 +7080,8 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", + "name": "team_slug", + "description": "team_slug parameter", "in": "PATH", "type": "string", "required": true, @@ -13255,8 +7093,8 @@ "deprecated": null }, { - "name": "run_id", - "description": "run_id parameter", + "name": "discussion_number", + "description": "discussion_number parameter", "in": "PATH", "type": "integer", "required": true, @@ -13274,7 +7112,7 @@ "description": "response", "examples": [ { - "data": "{\"id\":30433642,\"node_id\":\"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\"head_branch\":\"master\",\"head_sha\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"run_number\":562,\"check_suite_id\":414944374,\"event\":\"push\",\"status\":\"queued\",\"conclusion\":null,\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\"html_url\":\"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\"pull_requests\":[],\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"jobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\"logs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\"artifacts_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\"cancel_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\"rerun_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\"workflow_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/30433642\",\"head_commit\":{\"id\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"tree_id\":\"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\"message\":\"Create linter.yml\",\"timestamp\":\"2020-01-22T19:33:05Z\",\"author\":{\"name\":\"Octo Cat\",\"email\":\"octocat@github.com\"},\"committer\":{\"name\":\"GitHub\",\"email\":\"noreply@github.com\"}},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\"},\"head_repository\":{\"id\":217723378,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\"name\":\"octo-repo\",\"full_name\":\"octo-org/octo-repo\",\"private\":true,\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"html_url\":\"https://github.com/octo-org/octo-repo\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/octo-repo\",\"forks_url\":\"https://api.github.com/repos/octo-org/octo-repo/forks\",\"keys_url\":\"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octo-org/octo-repo/teams\",\"hooks_url\":\"https://api.github.com/repos/octo-org/octo-repo/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octo-org/octo-repo/events\",\"assignees_url\":\"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/tags\",\"blobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octo-org/octo-repo/languages\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octo-org/octo-repo/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscription\",\"commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octo-org/octo-repo/merges\",\"archive_url\":\"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octo-org/octo-repo/downloads\",\"issues_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octo-org/octo-repo/deployments\"}}" + "data": "{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"

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

\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":0,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":null,\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Our first team post\",\"updated_at\":\"2018-01-25T18:56:31Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0}}" } ] } @@ -13282,21 +7120,21 @@ "renamed": null }, { - "name": "List workflow run artifacts", - "scope": "actions", - "id": "listWorkflowRunArtifacts", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts", + "name": "Edit a discussion", + "scope": "teams", + "id": "updateDiscussionInOrg", + "method": "PATCH", + "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", "isDeprecated": false, "isLegacy": false, - "description": "Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.", - "documentationUrl": "https://developer.github.com/v3/actions/artifacts/#list-workflow-run-artifacts", + "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/:org_id/team/:team_id/discussions/:discussion_number`.", + "documentationUrl": "https://developer.github.com/v3/teams/discussions/#edit-a-discussion", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "owner parameter", + "name": "org", + "description": "org parameter", "in": "PATH", "type": "string", "required": true, @@ -13308,8 +7146,8 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", + "name": "team_slug", + "description": "team_slug parameter", "in": "PATH", "type": "string", "required": true, @@ -13321,8 +7159,8 @@ "deprecated": null }, { - "name": "run_id", - "description": "run_id parameter", + "name": "discussion_number", + "description": "discussion_number parameter", "in": "PATH", "type": "integer", "required": true, @@ -13334,10 +7172,10 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", + "name": "title", + "description": "The discussion post's title.", + "in": "BODY", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -13347,10 +7185,10 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", + "name": "body", + "description": "The discussion post's body text.", + "in": "BODY", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -13366,7 +7204,7 @@ "description": "response", "examples": [ { - "data": "{\"total_count\":2,\"artifacts\":[{\"id\":11,\"node_id\":\"MDg6QXJ0aWZhY3QxMQ==\",\"name\":\"Rails\",\"size_in_bytes\":556,\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/5/zip\",\"expired\":\"false\",\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-01-21T14:59:22Z\"},{\"id\":13,\"node_id\":\"MDg6QXJ0aWZhY3QxMw==\",\"name\":\"\",\"size_in_bytes\":453,\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/5/zip\",\"expired\":\"false\",\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-01-21T14:59:22Z\"}]}" + "data": "{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"

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

\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":1,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":\"2018-01-26T18:22:20Z\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Welcome to our first team post\",\"updated_at\":\"2018-01-26T18:22:20Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0}}" } ] } @@ -13374,21 +7212,21 @@ "renamed": null }, { - "name": "Cancel a workflow run", - "scope": "actions", - "id": "cancelWorkflowRun", - "method": "POST", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel", + "name": "Delete a discussion", + "scope": "teams", + "id": "deleteDiscussionInOrg", + "method": "DELETE", + "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", "isDeprecated": false, "isLegacy": false, - "description": "Cancels a workflow run using its `id`. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.", - "documentationUrl": "https://developer.github.com/v3/actions/workflow_runs/#cancel-a-workflow-run", + "description": "Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number`.", + "documentationUrl": "https://developer.github.com/v3/teams/discussions/#delete-a-discussion", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "owner parameter", + "name": "org", + "description": "org parameter", "in": "PATH", "type": "string", "required": true, @@ -13400,8 +7238,8 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", + "name": "team_slug", + "description": "team_slug parameter", "in": "PATH", "type": "string", "required": true, @@ -13413,8 +7251,8 @@ "deprecated": null }, { - "name": "run_id", - "description": "run_id parameter", + "name": "discussion_number", + "description": "discussion_number parameter", "in": "PATH", "type": "integer", "required": true, @@ -13430,21 +7268,21 @@ "renamed": null }, { - "name": "List jobs for a workflow run", - "scope": "actions", - "id": "listJobsForWorkflowRun", + "name": "List comments", + "scope": "teams", + "id": "listDiscussionCommentsInOrg", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs", + "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", "isDeprecated": false, "isLegacy": false, - "description": "Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.", - "documentationUrl": "https://developer.github.com/v3/actions/workflow_jobs/#list-jobs-for-a-workflow-run", + "description": "List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments`.", + "documentationUrl": "https://developer.github.com/v3/teams/discussion_comments/#list-comments", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "owner parameter", + "name": "org", + "description": "org parameter", "in": "PATH", "type": "string", "required": true, @@ -13456,8 +7294,8 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", + "name": "team_slug", + "description": "team_slug parameter", "in": "PATH", "type": "string", "required": true, @@ -13469,8 +7307,8 @@ "deprecated": null }, { - "name": "run_id", - "description": "run_id parameter", + "name": "discussion_number", + "description": "discussion_number parameter", "in": "PATH", "type": "integer", "required": true, @@ -13481,6 +7319,19 @@ "alias": null, "deprecated": null }, + { + "name": "direction", + "description": "Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["asc", "desc"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "per_page", "description": "Results per page (max 100)", @@ -13514,7 +7365,7 @@ "description": "response", "examples": [ { - "data": "{\"total_count\":1,\"jobs\":[{\"id\":399444496,\"run_id\":29679449,\"run_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449\",\"node_id\":\"MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==\",\"head_sha\":\"f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496\",\"html_url\":\"https://github.com/octo-org/octo-repo/runs/399444496\",\"status\":\"completed\",\"conclusion\":\"success\",\"started_at\":\"2020-01-20T17:42:40Z\",\"completed_at\":\"2020-01-20T17:44:39Z\",\"name\":\"build\",\"steps\":[{\"name\":\"Set up job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":1,\"started_at\":\"2020-01-20T09:42:40.000-08:00\",\"completed_at\":\"2020-01-20T09:42:41.000-08:00\"},{\"name\":\"Run actions/checkout@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":2,\"started_at\":\"2020-01-20T09:42:41.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Set up Ruby\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":3,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Run actions/cache@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":4,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:48.000-08:00\"},{\"name\":\"Install Bundler\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":5,\"started_at\":\"2020-01-20T09:42:48.000-08:00\",\"completed_at\":\"2020-01-20T09:42:52.000-08:00\"},{\"name\":\"Install Gems\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":6,\"started_at\":\"2020-01-20T09:42:52.000-08:00\",\"completed_at\":\"2020-01-20T09:42:53.000-08:00\"},{\"name\":\"Run Tests\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":7,\"started_at\":\"2020-01-20T09:42:53.000-08:00\",\"completed_at\":\"2020-01-20T09:42:59.000-08:00\"},{\"name\":\"Deploy to Heroku\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":8,\"started_at\":\"2020-01-20T09:42:59.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Post actions/cache@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":16,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Complete job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":17,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"}],\"check_run_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496\"}]}" + "data": "[{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Do you like apples?\",\"body_html\":\"

Do you like apples?

\",\"body_version\":\"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":null,\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-15T23:53:58Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0}}]" } ] } @@ -13522,21 +7373,21 @@ "renamed": null }, { - "name": "List workflow run logs", - "scope": "actions", - "id": "listWorkflowRunLogs", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/logs", + "name": "Create a comment", + "scope": "teams", + "id": "createDiscussionCommentInOrg", + "method": "POST", + "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", "isDeprecated": false, "isLegacy": false, - "description": "Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.\n\nCall this endpoint using the `-v` flag, which enables verbose output and allows you to see the download URL in the header. To download the file into the current working directory, specify the filename using the `-o` flag.", - "documentationUrl": "https://developer.github.com/v3/actions/workflow_runs/#list-workflow-run-logs", + "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments`.", + "documentationUrl": "https://developer.github.com/v3/teams/discussion_comments/#create-a-comment", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "owner parameter", + "name": "org", + "description": "org parameter", "in": "PATH", "type": "string", "required": true, @@ -13548,8 +7399,8 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", + "name": "team_slug", + "description": "team_slug parameter", "in": "PATH", "type": "string", "required": true, @@ -13561,8 +7412,8 @@ "deprecated": null }, { - "name": "run_id", - "description": "run_id parameter", + "name": "discussion_number", + "description": "discussion_number parameter", "in": "PATH", "type": "integer", "required": true, @@ -13574,51 +7425,48 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "body", + "description": "The discussion comment's body text.", + "in": "BODY", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null + "code": 201, + "description": "response", + "examples": [ + { + "data": "{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Do you like apples?\",\"body_html\":\"

Do you like apples?

\",\"body_version\":\"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":null,\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-15T23:53:58Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0}}" + } + ] } ], - "responses": [], "renamed": null }, { - "name": "Re-run a workflow", - "scope": "actions", - "id": "reRunWorkflow", - "method": "POST", - "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun", + "name": "Get a single comment", + "scope": "teams", + "id": "getDiscussionCommentInOrg", + "method": "GET", + "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", "isDeprecated": false, "isLegacy": false, - "description": "Re-runs your workflow run using its `id`. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.", - "documentationUrl": "https://developer.github.com/v3/actions/workflow_runs/#re-run-a-workflow", + "description": "Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number`.", + "documentationUrl": "https://developer.github.com/v3/teams/discussion_comments/#get-a-single-comment", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "owner parameter", + "name": "org", + "description": "org parameter", "in": "PATH", "type": "string", "required": true, @@ -13630,8 +7478,8 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", + "name": "team_slug", + "description": "team_slug parameter", "in": "PATH", "type": "string", "required": true, @@ -13643,8 +7491,21 @@ "deprecated": null }, { - "name": "run_id", - "description": "run_id parameter", + "name": "discussion_number", + "description": "discussion_number parameter", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "comment_number", + "description": "comment_number parameter", "in": "PATH", "type": "integer", "required": true, @@ -13656,25 +7517,35 @@ "deprecated": null } ], - "responses": [], + "responses": [ + { + "code": 200, + "description": "response", + "examples": [ + { + "data": "{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Do you like apples?\",\"body_html\":\"

Do you like apples?

\",\"body_version\":\"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":null,\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-15T23:53:58Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0}}" + } + ] + } + ], "renamed": null }, { - "name": "List secrets for a repository", - "scope": "actions", - "id": "listSecretsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/secrets", + "name": "Edit a comment", + "scope": "teams", + "id": "updateDiscussionCommentInOrg", + "method": "PATCH", + "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", "isDeprecated": false, "isLegacy": false, - "description": "Lists all secrets available in a repository without revealing their encrypted values. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `secrets` permission to use this endpoint.", - "documentationUrl": "https://developer.github.com/v3/actions/secrets/#list-secrets-for-a-repository", + "description": "Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number`.", + "documentationUrl": "https://developer.github.com/v3/teams/discussion_comments/#edit-a-comment", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "owner parameter", + "name": "org", + "description": "org parameter", "in": "PATH", "type": "string", "required": true, @@ -13686,8 +7557,8 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", + "name": "team_slug", + "description": "team_slug parameter", "in": "PATH", "type": "string", "required": true, @@ -13699,11 +7570,11 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", + "name": "discussion_number", + "description": "discussion_number parameter", + "in": "PATH", "type": "integer", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -13712,11 +7583,24 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", + "name": "comment_number", + "description": "comment_number parameter", + "in": "PATH", "type": "integer", - "required": false, + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "body", + "description": "The discussion comment's body text.", + "in": "BODY", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -13731,7 +7615,7 @@ "description": "response", "examples": [ { - "data": "{\"total_count\":2,\"secrets\":[{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"},{\"name\":\"GIST_ID\",\"created_at\":\"2020-01-10T10:59:22Z\",\"updated_at\":\"2020-01-11T11:59:22Z\"}]}" + "data": "{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Do you like pineapples?\",\"body_html\":\"

Do you like pineapples?

\",\"body_version\":\"e6907b24d9c93cc0c5024a7af5888116\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":\"2018-01-26T18:22:20Z\",\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-26T18:22:20Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0}}" } ] } @@ -13739,21 +7623,21 @@ "renamed": null }, { - "name": "Get your public key", - "scope": "actions", - "id": "getPublicKey", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/secrets/public-key", + "name": "Delete a comment", + "scope": "teams", + "id": "deleteDiscussionCommentInOrg", + "method": "DELETE", + "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", "isDeprecated": false, "isLegacy": false, - "description": "Gets your public key, which you must store. You need your public key to use other secrets endpoints. Use the returned `key` to encrypt your secrets. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `secrets` permission to use this endpoint.", - "documentationUrl": "https://developer.github.com/v3/actions/secrets/#get-your-public-key", + "description": "Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number`.", + "documentationUrl": "https://developer.github.com/v3/teams/discussion_comments/#delete-a-comment", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "owner parameter", + "name": "org", + "description": "org parameter", "in": "PATH", "type": "string", "required": true, @@ -13765,8 +7649,8 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", + "name": "team_slug", + "description": "team_slug parameter", "in": "PATH", "type": "string", "required": true, @@ -13776,37 +7660,59 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ + }, { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"key_id\":\"1234\",\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\"}" - } - ] + "name": "discussion_number", + "description": "discussion_number parameter", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "comment_number", + "description": "comment_number parameter", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], + "responses": [], "renamed": null }, { - "name": "Get a secret", - "scope": "actions", - "id": "getSecret", + "name": "List reactions for a team discussion comment", + "scope": "reactions", + "id": "listForTeamDiscussionCommentInOrg", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/secrets/{name}", + "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", "isDeprecated": false, "isLegacy": false, - "description": "Gets a single secret without revealing its encrypted value. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `secrets` permission to use this endpoint.", - "documentationUrl": "https://developer.github.com/v3/actions/secrets/#get-a-secret", - "previews": [], - "headers": [], + "description": "List the reactions to a [team discussion comment](https://developer.github.com/v3/teams/discussion_comments/). OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.", + "documentationUrl": "https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-comment", + "previews": [{ "name": "squirrel-girl" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.squirrel-girl-preview+json", + "required": true + } + ], "parameters": [ { - "name": "owner", - "description": "owner parameter", + "name": "org", + "description": "org parameter", "in": "PATH", "type": "string", "required": true, @@ -13818,8 +7724,8 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", + "name": "team_slug", + "description": "team_slug parameter", "in": "PATH", "type": "string", "required": true, @@ -13831,10 +7737,23 @@ "deprecated": null }, { - "name": "name", - "description": "name parameter", + "name": "discussion_number", + "description": "discussion_number parameter", "in": "PATH", - "type": "string", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "comment_number", + "description": "comment_number parameter", + "in": "PATH", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -13843,6 +7762,28 @@ "alias": null, "deprecated": null }, + { + "name": "content", + "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion comment.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "per_page", "description": "Results per page (max 100)", @@ -13876,7 +7817,7 @@ "description": "response", "examples": [ { - "data": "{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"}" + "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" } ] } @@ -13884,21 +7825,27 @@ "renamed": null }, { - "name": "Create or update a secret for a repository", - "scope": "actions", - "id": "createOrUpdateSecretForRepo", - "method": "PUT", - "url": "/repos/{owner}/{repo}/actions/secrets/{name}", + "name": "Create reaction for a team discussion comment", + "scope": "reactions", + "id": "createForTeamDiscussionCommentInOrg", + "method": "POST", + "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", "isDeprecated": false, "isLegacy": false, - "description": "Creates or updates a secret with an encrypted value. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `secrets` permission to use this endpoint.\n\nEncrypt your secret using the [tweetsodium](https://github.com/mastahyeti/tweetsodium) library.\n\n\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3.\n\n\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n", - "documentationUrl": "https://developer.github.com/v3/actions/secrets/#create-or-update-a-secret-for-a-repository", - "previews": [], - "headers": [], + "description": "Create a reaction to a [team discussion comment](https://developer.github.com/v3/teams/discussion_comments/). OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.", + "documentationUrl": "https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-comment", + "previews": [{ "name": "squirrel-girl" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.squirrel-girl-preview+json", + "required": true + } + ], "parameters": [ { - "name": "owner", - "description": "owner parameter", + "name": "org", + "description": "org parameter", "in": "PATH", "type": "string", "required": true, @@ -13910,8 +7857,8 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", + "name": "team_slug", + "description": "team_slug parameter", "in": "PATH", "type": "string", "required": true, @@ -13923,10 +7870,10 @@ "deprecated": null }, { - "name": "name", - "description": "name parameter", + "name": "discussion_number", + "description": "discussion_number parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -13936,11 +7883,11 @@ "deprecated": null }, { - "name": "encrypted_value", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get your public key](https://developer.github.com/v3/actions/secrets/#get-your-public-key) endpoint.", - "in": "BODY", - "type": "string", - "required": false, + "name": "comment_number", + "description": "comment_number parameter", + "in": "PATH", + "type": "integer", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -13949,12 +7896,21 @@ "deprecated": null }, { - "name": "key_id", - "description": "ID of the key you used to encrypt the secret.", + "name": "content", + "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion comment.", "in": "BODY", "type": "string", - "required": false, - "enum": null, + "required": true, + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], "allowNull": false, "mapToData": null, "validation": null, @@ -13962,25 +7918,41 @@ "deprecated": null } ], - "responses": [], + "responses": [ + { + "code": 201, + "description": "response", + "examples": [ + { + "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" + } + ] + } + ], "renamed": null }, { - "name": "Delete a secret from a repository", - "scope": "actions", - "id": "deleteSecretFromRepo", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/actions/secrets/{name}", + "name": "List reactions for a team discussion", + "scope": "reactions", + "id": "listForTeamDiscussionInOrg", + "method": "GET", + "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", "isDeprecated": false, "isLegacy": false, - "description": "Deletes a secret in a repository using the secret name. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `secrets` permission to use this endpoint.", - "documentationUrl": "https://developer.github.com/v3/actions/secrets/#delete-a-secret-from-a-repository", - "previews": [], - "headers": [], + "description": "List the reactions to a [team discussion](https://developer.github.com/v3/teams/discussions/). OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.", + "documentationUrl": "https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion", + "previews": [{ "name": "squirrel-girl" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.squirrel-girl-preview+json", + "required": true + } + ], "parameters": [ { - "name": "owner", - "description": "owner parameter", + "name": "org", + "description": "org parameter", "in": "PATH", "type": "string", "required": true, @@ -13992,8 +7964,8 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", + "name": "team_slug", + "description": "team_slug parameter", "in": "PATH", "type": "string", "required": true, @@ -14005,40 +7977,10 @@ "deprecated": null }, { - "name": "name", - "description": "name parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "List repository workflows", - "scope": "actions", - "id": "listRepoWorkflows", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/workflows", - "isDeprecated": false, - "isLegacy": false, - "description": "Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.", - "documentationUrl": "https://developer.github.com/v3/actions/workflows/#list-repository-workflows", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "owner parameter", + "name": "discussion_number", + "description": "discussion_number parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -14048,12 +7990,21 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "content", + "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion.", + "in": "QUERY", "type": "string", - "required": true, - "enum": null, + "required": false, + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], "allowNull": false, "mapToData": null, "validation": null, @@ -14093,7 +8044,7 @@ "description": "response", "examples": [ { - "data": "{\"total_count\":2,\"workflows\":[{\"id\":161335,\"node_id\":\"MDg6V29ya2Zsb3cxNjEzMzU=\",\"name\":\"CI\",\"path\":\".github/workflows/blank.yml\",\"state\":\"active\",\"created_at\":\"2020-01-08T23:48:37.000-08:00\",\"updated_at\":\"2020-01-08T23:50:21.000-08:00\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335\",\"html_url\":\"https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335\",\"badge_url\":\"https://github.com/octo-org/octo-repo/workflows/CI/badge.svg\"},{\"id\":269289,\"node_id\":\"MDE4OldvcmtmbG93IFNlY29uZGFyeTI2OTI4OQ==\",\"name\":\"Linter\",\"path\":\".github/workflows/linter.yml\",\"state\":\"active\",\"created_at\":\"2020-01-08T23:48:37.000-08:00\",\"updated_at\":\"2020-01-08T23:50:21.000-08:00\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/269289\",\"html_url\":\"https://github.com/octo-org/octo-repo/blob/master/.github/workflows/269289\",\"badge_url\":\"https://github.com/octo-org/octo-repo/workflows/Linter/badge.svg\"}]}" + "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" } ] } @@ -14101,21 +8052,27 @@ "renamed": null }, { - "name": "Get a workflow", - "scope": "actions", - "id": "getWorkflow", - "method": "GET", - "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}", + "name": "Create reaction for a team discussion", + "scope": "reactions", + "id": "createForTeamDiscussionInOrg", + "method": "POST", + "url": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", "isDeprecated": false, "isLegacy": false, - "description": "Gets a specific workflow. You can also replace `:workflow_id` with `:workflow_file_name`. For example, you could use `main.yml`. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.", - "documentationUrl": "https://developer.github.com/v3/actions/workflows/#get-a-workflow", - "previews": [], - "headers": [], + "description": "Create a reaction to a [team discussion](https://developer.github.com/v3/teams/discussions/). OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.", + "documentationUrl": "https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion", + "previews": [{ "name": "squirrel-girl" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.squirrel-girl-preview+json", + "required": true + } + ], "parameters": [ { - "name": "owner", - "description": "owner parameter", + "name": "org", + "description": "org parameter", "in": "PATH", "type": "string", "required": true, @@ -14127,8 +8084,8 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", + "name": "team_slug", + "description": "team_slug parameter", "in": "PATH", "type": "string", "required": true, @@ -14140,8 +8097,8 @@ "deprecated": null }, { - "name": "workflow_id", - "description": "workflow_id parameter", + "name": "discussion_number", + "description": "discussion_number parameter", "in": "PATH", "type": "integer", "required": true, @@ -14151,15 +8108,37 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "content", + "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion.", + "in": "BODY", + "type": "string", + "required": true, + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ { - "code": 200, + "code": 201, "description": "response", "examples": [ { - "data": "{\"id\":161335,\"node_id\":\"MDg6V29ya2Zsb3cxNjEzMzU=\",\"name\":\"CI\",\"path\":\".github/workflows/blank.yml\",\"state\":\"active\",\"created_at\":\"2020-01-08T23:48:37.000-08:00\",\"updated_at\":\"2020-01-08T23:50:21.000-08:00\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335\",\"html_url\":\"https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335\",\"badge_url\":\"https://github.com/octo-org/octo-repo/workflows/CI/badge.svg\"}" + "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" } ] } @@ -14167,21 +8146,21 @@ "renamed": null }, { - "name": "List workflow runs", - "scope": "actions", - "id": "listWorkflowRuns", + "name": "List pending team invitations", + "scope": "teams", + "id": "listPendingInvitationsInOrg", "method": "GET", - "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs", + "url": "/orgs/{org}/teams/{team_slug}/invitations", "isDeprecated": false, "isLegacy": false, - "description": "List all workflow runs for a workflow. You can also replace `:workflow_id` with `:workflow_file_name`. For example, you could use `main.yml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://developer.github.com/v3/#parameters).\n\nAnyone with read access to the repository can use this endpoint.", - "documentationUrl": "https://developer.github.com/v3/actions/workflow_runs/#list-workflow-runs", + "description": "The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/invitations`.", + "documentationUrl": "https://developer.github.com/v3/teams/members/#list-pending-team-invitations", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "owner parameter", + "name": "org", + "description": "org parameter", "in": "PATH", "type": "string", "required": true, @@ -14193,8 +8172,8 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", + "name": "team_slug", + "description": "team_slug parameter", "in": "PATH", "type": "string", "required": true, @@ -14205,71 +8184,6 @@ "alias": null, "deprecated": null }, - { - "name": "workflow_id", - "description": "workflow_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "actor", - "description": "Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "Returns workflow runs associated with a branch. Use the name of the branch of the `push`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "event", - "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)\" in the GitHub Help documentation.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "status", - "description": "Returns workflow runs associated with the check run `status` or `conclusion` you specify. For example, a conclusion can be `success` or a status can be `completed`. For more information, see the `status` and `conclusion` options available in \"[Create a check run](https://developer.github.com/v3/checks/runs/#create-a-check-run).\"", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["completed", "status", "conclusion"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, { "name": "per_page", "description": "Results per page (max 100)", @@ -14303,7 +8217,7 @@ "description": "response", "examples": [ { - "data": "{\"total_count\":1,\"workflow_runs\":[{\"id\":30433642,\"node_id\":\"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\"head_branch\":\"master\",\"head_sha\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"run_number\":562,\"check_suite_id\":414944374,\"event\":\"push\",\"status\":\"queued\",\"conclusion\":null,\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\"html_url\":\"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\"pull_requests\":[],\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"jobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\"logs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\"artifacts_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\"cancel_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\"rerun_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\"workflow_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/30433642\",\"head_commit\":{\"id\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"tree_id\":\"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\"message\":\"Create linter.yml\",\"timestamp\":\"2020-01-22T19:33:05Z\",\"author\":{\"name\":\"Octo Cat\",\"email\":\"octocat@github.com\"},\"committer\":{\"name\":\"GitHub\",\"email\":\"noreply@github.com\"}},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\"},\"head_repository\":{\"id\":217723378,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\"name\":\"octo-repo\",\"full_name\":\"octo-org/octo-repo\",\"private\":true,\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"html_url\":\"https://github.com/octo-org/octo-repo\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/octo-repo\",\"forks_url\":\"https://api.github.com/repos/octo-org/octo-repo/forks\",\"keys_url\":\"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octo-org/octo-repo/teams\",\"hooks_url\":\"https://api.github.com/repos/octo-org/octo-repo/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octo-org/octo-repo/events\",\"assignees_url\":\"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/tags\",\"blobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octo-org/octo-repo/languages\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octo-org/octo-repo/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscription\",\"commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octo-org/octo-repo/merges\",\"archive_url\":\"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octo-org/octo-repo/downloads\",\"issues_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octo-org/octo-repo/deployments\"}}]}" + "data": "[{\"id\":1,\"login\":\"monalisa\",\"email\":\"octocat@github.com\",\"role\":\"direct_member\",\"created_at\":\"2016-11-30T06:46:10-08:00\",\"inviter\":{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false},\"team_count\":2,\"invitation_team_url\":\"https://api.github.com/organizations/2/invitations/1/teams\"}]" } ] } @@ -14311,21 +8225,21 @@ "renamed": null }, { - "name": "List assignees", - "scope": "issues", - "id": "listAssignees", + "name": "List team members", + "scope": "teams", + "id": "listMembersInOrg", "method": "GET", - "url": "/repos/{owner}/{repo}/assignees", + "url": "/orgs/{org}/teams/{team_slug}/members", "isDeprecated": false, "isLegacy": false, - "description": "Lists the [available assignees](https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository.", - "documentationUrl": "https://developer.github.com/v3/issues/assignees/#list-assignees", + "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.", + "documentationUrl": "https://developer.github.com/v3/teams/members/#list-team-members", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "owner parameter", + "name": "org", + "description": "org parameter", "in": "PATH", "type": "string", "required": true, @@ -14337,8 +8251,8 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", + "name": "team_slug", + "description": "team_slug parameter", "in": "PATH", "type": "string", "required": true, @@ -14349,6 +8263,19 @@ "alias": null, "deprecated": null }, + { + "name": "role", + "description": "Filters members returned by their role in the team. Can be one of: \n\\* `member` - normal members of the team. \n\\* `maintainer` - team maintainers. \n\\* `all` - all members of the team.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["member", "maintainer", "all"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "per_page", "description": "Results per page (max 100)", @@ -14390,21 +8317,21 @@ "renamed": null }, { - "name": "Check assignee", - "scope": "issues", - "id": "checkAssignee", + "name": "Get team membership", + "scope": "teams", + "id": "getMembershipInOrg", "method": "GET", - "url": "/repos/{owner}/{repo}/assignees/{assignee}", + "url": "/orgs/{org}/teams/{team_slug}/memberships/{username}", "isDeprecated": false, "isLegacy": false, - "description": "Checks if a user has permission to be assigned to an issue in this repository.\n\nIf the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned.\n\nOtherwise a `404` status code is returned.", - "documentationUrl": "https://developer.github.com/v3/issues/assignees/#check-assignee", + "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/memberships/:username`.\n\n**Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create team](https://developer.github.com/v3/teams#create-team).", + "documentationUrl": "https://developer.github.com/v3/teams/members/#get-team-membership", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "owner parameter", + "name": "org", + "description": "org parameter", "in": "PATH", "type": "string", "required": true, @@ -14416,8 +8343,8 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", + "name": "team_slug", + "description": "team_slug parameter", "in": "PATH", "type": "string", "required": true, @@ -14429,8 +8356,8 @@ "deprecated": null }, { - "name": "assignee", - "description": "assignee parameter", + "name": "username", + "description": "username parameter", "in": "PATH", "type": "string", "required": true, @@ -14442,30 +8369,41 @@ "deprecated": null } ], - "responses": [], + "responses": [ + { + "code": 200, + "description": "response", + "examples": [ + { + "data": "{\"url\":\"https://api.github.com/teams/1/memberships/octocat\",\"role\":\"member\",\"state\":\"active\"}" + }, + { + "data": "{\"url\":\"https://api.github.com/teams/1/memberships/octocat\",\"role\":\"maintainer\",\"state\":\"active\"}" + }, + { + "data": "{\"url\":\"https://api.github.com/teams/1/memberships/octocat\",\"role\":\"member\",\"state\":\"pending\"}" + } + ] + } + ], "renamed": null }, { - "name": "Enable automated security fixes", - "scope": "repos", - "id": "enableAutomatedSecurityFixes", + "name": "Add or update team membership", + "scope": "teams", + "id": "addOrUpdateMembershipInOrg", "method": "PUT", - "url": "/repos/{owner}/{repo}/automated-security-fixes", + "url": "/orgs/{org}/teams/{team_slug}/memberships/{username}", "isDeprecated": false, "isLegacy": false, - "description": "Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Configuring automated security fixes](https://help.github.com/en/articles/configuring-automated-security-fixes)\" in the GitHub Help documentation.", - "documentationUrl": "https://developer.github.com/v3/repos/#enable-automated-security-fixes", - "previews": [{ "name": "london" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.london-preview+json" - } - ], + "description": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/:org_id/team/:team_id/memberships/:username`.", + "documentationUrl": "https://developer.github.com/v3/teams/members/#add-or-update-team-membership", + "previews": [], + "headers": [], "parameters": [ { - "name": "owner", - "description": "owner parameter", + "name": "org", + "description": "org parameter", "in": "PATH", "type": "string", "required": true, @@ -14477,8 +8415,8 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", + "name": "team_slug", + "description": "team_slug parameter", "in": "PATH", "type": "string", "required": true, @@ -14488,32 +8426,10 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "Disable automated security fixes", - "scope": "repos", - "id": "disableAutomatedSecurityFixes", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/automated-security-fixes", - "isDeprecated": false, - "isLegacy": false, - "description": "Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Configuring automated security fixes](https://help.github.com/en/articles/configuring-automated-security-fixes)\" in the GitHub Help documentation.", - "documentationUrl": "https://developer.github.com/v3/repos/#disable-automated-security-fixes", - "previews": [{ "name": "london" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.london-preview+json" - } - ], - "parameters": [ + }, { - "name": "owner", - "description": "owner parameter", + "name": "username", + "description": "username parameter", "in": "PATH", "type": "string", "required": true, @@ -14525,12 +8441,12 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "role", + "description": "The role that this user should have in the team. Can be one of: \n\\* `member` - a normal member of the team. \n\\* `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description.", + "in": "BODY", "type": "string", - "required": true, - "enum": null, + "required": false, + "enum": ["member", "maintainer"], "allowNull": false, "mapToData": null, "validation": null, @@ -14538,25 +8454,47 @@ "deprecated": null } ], - "responses": [], + "responses": [ + { + "code": 200, + "description": "response", + "examples": [ + { + "data": "{\"url\":\"https://api.github.com/teams/1/memberships/octocat\",\"role\":\"member\",\"state\":\"active\"}" + }, + { + "data": "{\"url\":\"https://api.github.com/teams/1/memberships/octocat\",\"role\":\"member\",\"state\":\"pending\"}" + } + ] + }, + { + "code": 422, + "description": "Response if you attempt to add an organization to a team", + "examples": [ + { + "data": "{\"message\":\"Cannot add an organization as a member.\",\"errors\":[{\"code\":\"org\",\"field\":\"user\",\"resource\":\"TeamMember\"}]}" + } + ] + } + ], "renamed": null }, { - "name": "List branches", - "scope": "repos", - "id": "listBranches", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches", + "name": "Remove team membership", + "scope": "teams", + "id": "removeMembershipInOrg", + "method": "DELETE", + "url": "/orgs/{org}/teams/{team_slug}/memberships/{username}", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/repos/branches/#list-branches", + "description": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/:org_id/team/:team_id/memberships/:username`.", + "documentationUrl": "https://developer.github.com/v3/teams/members/#remove-team-membership", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "owner parameter", + "name": "org", + "description": "org parameter", "in": "PATH", "type": "string", "required": true, @@ -14568,8 +8506,8 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", + "name": "team_slug", + "description": "team_slug parameter", "in": "PATH", "type": "string", "required": true, @@ -14581,37 +8519,11 @@ "deprecated": null }, { - "name": "protected", - "description": "Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches.", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "username", + "description": "username parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -14620,35 +8532,31 @@ "deprecated": null } ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"name\":\"master\",\"commit\":{\"sha\":\"c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\"},\"protected\":true,\"protection\":{\"enabled\":true,\"required_status_checks\":{\"enforcement_level\":\"non_admins\",\"contexts\":[\"ci-test\",\"linter\"]}},\"protection_url\":\"https://api.github.com/repos/octocat/hello-world/branches/master/protection\"}]" - } - ] - } - ], + "responses": [], "renamed": null }, { - "name": "Get branch", - "scope": "repos", - "id": "getBranch", + "name": "List team projects", + "scope": "teams", + "id": "listProjectsInOrg", "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}", + "url": "/orgs/{org}/teams/{team_slug}/projects", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/repos/branches/#get-branch", - "previews": [], - "headers": [], + "description": "Lists the organization projects for a team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/projects`.", + "documentationUrl": "https://developer.github.com/v3/teams/#list-team-projects", + "previews": [{ "name": "inertia" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.inertia-preview+json", + "required": true + } + ], "parameters": [ { - "name": "owner", - "description": "owner parameter", + "name": "org", + "description": "org parameter", "in": "PATH", "type": "string", "required": true, @@ -14660,8 +8568,8 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", + "name": "team_slug", + "description": "team_slug parameter", "in": "PATH", "type": "string", "required": true, @@ -14673,11 +8581,24 @@ "deprecated": null }, { - "name": "branch", - "description": "branch parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -14692,7 +8613,7 @@ "description": "response", "examples": [ { - "data": "{\"name\":\"master\",\"commit\":{\"sha\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"node_id\":\"MDY6Q29tbWl0N2ZkMWE2MGIwMWY5MWIzMTRmNTk5NTVhNGU0ZDRlODBkOGVkZjExZA==\",\"commit\":{\"author\":{\"name\":\"The Octocat\",\"date\":\"2012-03-06T15:06:50-08:00\",\"email\":\"octocat@nowhere.com\"},\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"message\":\"Merge pull request #6 from Spaceghost/patch-1\\n\\nNew line at end of file.\",\"tree\":{\"sha\":\"b4eecafa9be2f2006ce1b709d6857b07069b4608\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608\"},\"committer\":{\"name\":\"The Octocat\",\"date\":\"2012-03-06T15:06:50-08:00\",\"email\":\"octocat@nowhere.com\"},\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"author\":{\"gravatar_id\":\"\",\"avatar_url\":\"https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png\",\"url\":\"https://api.github.com/users/octocat\",\"id\":583231,\"login\":\"octocat\"},\"parents\":[{\"sha\":\"553c2077f0edc3d5dc5d17262f6aa498e69d6f8e\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e\"},{\"sha\":\"762941318ee16e59dabbacb1b4049eec22f0d303\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303\"}],\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"committer\":{\"gravatar_id\":\"\",\"avatar_url\":\"https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png\",\"url\":\"https://api.github.com/users/octocat\",\"id\":583231,\"login\":\"octocat\"}},\"_links\":{\"html\":\"https://github.com/octocat/Hello-World/tree/master\",\"self\":\"https://api.github.com/repos/octocat/Hello-World/branches/master\"},\"protected\":true,\"protection\":{\"enabled\":true,\"required_status_checks\":{\"enforcement_level\":\"non_admins\",\"contexts\":[\"ci-test\",\"linter\"]}},\"protection_url\":\"https://api.github.com/repos/octocat/hello-world/branches/master/protection\"}" + "data": "[{\"owner_url\":\"https://api.github.com/orgs/octocat\",\"url\":\"https://api.github.com/projects/1002605\",\"html_url\":\"https://github.com/orgs/api-playground/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002605/columns\",\"id\":1002605,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDU=\",\"name\":\"Organization Roadmap\",\"body\":\"High-level roadmap for the upcoming year.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-11T20:09:31Z\",\"updated_at\":\"2014-03-04T18:58:10Z\",\"organization_permission\":\"write\",\"private\":false,\"permissions\":{\"read\":true,\"write\":true,\"admin\":false}}]" } ] } @@ -14700,21 +8621,27 @@ "renamed": null }, { - "name": "Get branch protection", - "scope": "repos", - "id": "getBranchProtection", + "name": "Review a team project", + "scope": "teams", + "id": "reviewProjectInOrg", "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection", + "url": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", "isDeprecated": false, "isLegacy": false, - "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://developer.github.com/v3/repos/branches/#get-branch-protection", - "previews": [], - "headers": [], + "description": "Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/projects/:project_id`.", + "documentationUrl": "https://developer.github.com/v3/teams/#review-a-team-project", + "previews": [{ "name": "inertia" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.inertia-preview+json", + "required": true + } + ], "parameters": [ { - "name": "owner", - "description": "owner parameter", + "name": "org", + "description": "org parameter", "in": "PATH", "type": "string", "required": true, @@ -14726,8 +8653,8 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", + "name": "team_slug", + "description": "team_slug parameter", "in": "PATH", "type": "string", "required": true, @@ -14739,10 +8666,10 @@ "deprecated": null }, { - "name": "branch", - "description": "branch parameter", + "name": "project_id", + "description": "project_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -14758,7 +8685,7 @@ "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection\",\"required_status_checks\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks\",\"strict\":true,\"contexts\":[\"continuous-integration/travis-ci\"],\"contexts_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts\"},\"enforce_admins\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins\",\"enabled\":true},\"required_pull_request_reviews\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews\",\"dismissal_restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":2},\"restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams\",\"apps_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"apps\":[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]},\"required_linear_history\":{\"enabled\":true},\"allow_force_pushes\":{\"enabled\":true},\"allow_deletions\":{\"enabled\":true}}" + "data": "{\"owner_url\":\"https://api.github.com/orgs/octocat\",\"url\":\"https://api.github.com/projects/1002605\",\"html_url\":\"https://github.com/orgs/api-playground/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002605/columns\",\"id\":1002605,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDU=\",\"name\":\"Organization Roadmap\",\"body\":\"High-level roadmap for the upcoming year.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-11T20:09:31Z\",\"updated_at\":\"2014-03-04T18:58:10Z\",\"organization_permission\":\"write\",\"private\":false,\"permissions\":{\"read\":true,\"write\":true,\"admin\":false}}" } ] } @@ -14766,21 +8693,27 @@ "renamed": null }, { - "name": "Update branch protection", - "scope": "repos", - "id": "updateBranchProtection", + "name": "Add or update team project", + "scope": "teams", + "id": "addOrUpdateProjectInOrg", "method": "PUT", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection", + "url": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", "isDeprecated": false, "isLegacy": false, - "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nProtecting a branch requires admin or owner permissions to the repository.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.\n\n**Note**: The list of users, apps, and teams in total is limited to 100 items.", - "documentationUrl": "https://developer.github.com/v3/repos/branches/#update-branch-protection", - "previews": [], - "headers": [], + "description": "Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/:org_id/team/:team_id/projects/:project_id`.", + "documentationUrl": "https://developer.github.com/v3/teams/#add-or-update-team-project", + "previews": [{ "name": "inertia" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.inertia-preview+json", + "required": true + } + ], "parameters": [ { - "name": "owner", - "description": "owner parameter", + "name": "org", + "description": "org parameter", "in": "PATH", "type": "string", "required": true, @@ -14792,8 +8725,8 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", + "name": "team_slug", + "description": "team_slug parameter", "in": "PATH", "type": "string", "required": true, @@ -14805,10 +8738,10 @@ "deprecated": null }, { - "name": "branch", - "description": "branch parameter", + "name": "project_id", + "description": "project_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -14818,77 +8751,65 @@ "deprecated": null }, { - "name": "required_status_checks", - "description": "Require status checks to pass before merging. Set to `null` to disable.", - "in": "BODY", - "type": "object", - "required": true, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_status_checks.strict", - "description": "Require branches to be up to date before merging.", + "name": "permission", + "description": "The permission to grant to the team for this project. Can be one of: \n\\* `read` - team members can read, but not write to or administer this project. \n\\* `write` - team members can read and write, but not administer this project. \n\\* `admin` - team members can read, write and administer this project. \nDefault: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\"", "in": "BODY", - "type": "boolean", - "required": true, - "enum": null, + "type": "string", + "required": false, + "enum": ["read", "write", "admin"], "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "required_status_checks.contexts", - "description": "The list of status checks to require in order to merge into this branch", - "in": "BODY", - "type": "string[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, + "code": 403, + "description": "Response if the project is not owned by the organization", + "examples": [ + { + "data": "{\"message\":\"Must have admin rights to Repository.\",\"documentation_url\":\"https://developer.github.com/v3/teams/#add-or-update-team-project\"}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Remove team project", + "scope": "teams", + "id": "removeProjectInOrg", + "method": "DELETE", + "url": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", + "isDeprecated": false, + "isLegacy": false, + "description": "Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/:org_id/team/:team_id/projects/:project_id`.", + "documentationUrl": "https://developer.github.com/v3/teams/#remove-team-project", + "previews": [], + "headers": [], + "parameters": [ { - "name": "enforce_admins", - "description": "Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable.", - "in": "BODY", - "type": "boolean", + "name": "org", + "description": "org parameter", + "in": "PATH", + "type": "string", "required": true, "enum": null, - "allowNull": true, + "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null }, { - "name": "required_pull_request_reviews", - "description": "Require at least one approving review on a pull request, before merging. Set to `null` to disable.", - "in": "BODY", - "type": "object", + "name": "team_slug", + "description": "team_slug parameter", + "in": "PATH", + "type": "string", "required": true, "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_pull_request_reviews.dismissal_restrictions", - "description": "Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -14896,24 +8817,41 @@ "deprecated": null }, { - "name": "required_pull_request_reviews.dismissal_restrictions.users", - "description": "The list of user `login`s with dismissal access", - "in": "BODY", - "type": "string[]", - "required": false, + "name": "project_id", + "description": "project_id parameter", + "in": "PATH", + "type": "integer", + "required": true, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [], + "renamed": null + }, + { + "name": "List team repos", + "scope": "teams", + "id": "listReposInOrg", + "method": "GET", + "url": "/orgs/{org}/teams/{team_slug}/repos", + "isDeprecated": false, + "isLegacy": false, + "description": "Lists a team's repositories visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/repos`.", + "documentationUrl": "https://developer.github.com/v3/teams/#list-team-repos", + "previews": [], + "headers": [], + "parameters": [ { - "name": "required_pull_request_reviews.dismissal_restrictions.teams", - "description": "The list of team `slug`s with dismissal access", - "in": "BODY", - "type": "string[]", - "required": false, + "name": "org", + "description": "org parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -14922,11 +8860,11 @@ "deprecated": null }, { - "name": "required_pull_request_reviews.dismiss_stale_reviews", - "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", - "in": "BODY", - "type": "boolean", - "required": false, + "name": "team_slug", + "description": "team_slug parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -14935,10 +8873,10 @@ "deprecated": null }, { - "name": "required_pull_request_reviews.require_code_owner_reviews", - "description": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) review them.", - "in": "BODY", - "type": "boolean", + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -14948,9 +8886,9 @@ "deprecated": null }, { - "name": "required_pull_request_reviews.required_approving_review_count", - "description": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.", - "in": "BODY", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", "type": "integer", "required": false, "enum": null, @@ -14959,25 +8897,39 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "restrictions", - "description": "Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable.", - "in": "BODY", - "type": "object", - "required": true, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, + "code": 200, + "description": "response", + "examples": [ + { + "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"}}]" + } + ] + } + ], + "renamed": null + }, + { + "name": "Check if a team manages a repository", + "scope": "teams", + "id": "checkManagesRepoInOrg", + "method": "GET", + "url": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", + "isDeprecated": false, + "isLegacy": false, + "description": "Checks whether a team has `admin`, `push`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/repos/:owner/:repo`.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://developer.github.com/v3/media/) via the `Accept` header:", + "documentationUrl": "https://developer.github.com/v3/teams/#check-if-a-team-manages-a-repository", + "previews": [], + "headers": [], + "parameters": [ { - "name": "restrictions.users", - "description": "The list of user `login`s with push access", - "in": "BODY", - "type": "string[]", + "name": "org", + "description": "org parameter", + "in": "PATH", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -14987,10 +8939,10 @@ "deprecated": null }, { - "name": "restrictions.teams", - "description": "The list of team `slug`s with push access", - "in": "BODY", - "type": "string[]", + "name": "team_slug", + "description": "team_slug parameter", + "in": "PATH", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -15000,24 +8952,11 @@ "deprecated": null }, { - "name": "restrictions.apps", - "description": "The list of app `slug`s with push access", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "required_linear_history", - "description": "Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see \"[Requiring a linear commit history](https://help.github.com/github/administering-a-repository/requiring-a-linear-commit-history)\" in the GitHub Help documentation.", - "in": "BODY", - "type": "boolean", - "required": false, + "name": "owner", + "description": "owner parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -15026,24 +8965,11 @@ "deprecated": null }, { - "name": "allow_force_pushes", - "description": "Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://help.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.\"", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "allow_deletions", - "description": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://help.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.", - "in": "BODY", - "type": "boolean", - "required": false, + "name": "repo", + "description": "repo parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -15055,10 +8981,10 @@ "responses": [ { "code": 200, - "description": "response", + "description": "Alternative response with repository permissions", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection\",\"required_status_checks\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks\",\"strict\":true,\"contexts\":[\"continuous-integration/travis-ci\"],\"contexts_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts\"},\"enforce_admins\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins\",\"enabled\":true},\"required_pull_request_reviews\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews\",\"dismissal_restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":2},\"restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams\",\"apps_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"apps\":[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]},\"required_linear_history\":{\"enabled\":true},\"allow_force_pushes\":{\"enabled\":true},\"allow_deletions\":{\"enabled\":true}}" + "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}" } ] } @@ -15066,21 +8992,21 @@ "renamed": null }, { - "name": "Remove branch protection", - "scope": "repos", - "id": "removeBranchProtection", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection", + "name": "Add or update team repository", + "scope": "teams", + "id": "addOrUpdateRepoInOrg", + "method": "PUT", + "url": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", "isDeprecated": false, "isLegacy": false, - "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://developer.github.com/v3/repos/branches/#remove-branch-protection", + "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/:org_id/team/:team_id/repos/:owner/:repo`.", + "documentationUrl": "https://developer.github.com/v3/teams/#add-or-update-team-repository", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "owner parameter", + "name": "org", + "description": "org parameter", "in": "PATH", "type": "string", "required": true, @@ -15092,8 +9018,8 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", + "name": "team_slug", + "description": "team_slug parameter", "in": "PATH", "type": "string", "required": true, @@ -15104,36 +9030,6 @@ "alias": null, "deprecated": null }, - { - "name": "branch", - "description": "branch parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "Get admin enforcement of protected branch", - "scope": "repos", - "id": "getProtectedBranchAdminEnforcement", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "isDeprecated": false, - "isLegacy": false, - "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://developer.github.com/v3/repos/branches/#get-admin-enforcement-of-protected-branch", - "previews": [], - "headers": [], - "parameters": [ { "name": "owner", "description": "owner parameter", @@ -15161,12 +9057,12 @@ "deprecated": null }, { - "name": "branch", - "description": "branch parameter", - "in": "PATH", + "name": "permission", + "description": "The permission to grant the team on this repository. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer this repository. \n\\* `push` - team members can pull and push, but not administer this repository. \n\\* `admin` - team members can pull, push and administer this repository. \n \nIf no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.", + "in": "BODY", "type": "string", - "required": true, - "enum": null, + "required": false, + "enum": ["pull", "push", "admin"], "allowNull": false, "mapToData": null, "validation": null, @@ -15174,35 +9070,25 @@ "deprecated": null } ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins\",\"enabled\":true}" - } - ] - } - ], + "responses": [], "renamed": null }, { - "name": "Add admin enforcement of protected branch", - "scope": "repos", - "id": "addProtectedBranchAdminEnforcement", - "method": "POST", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", + "name": "Remove team repository", + "scope": "teams", + "id": "removeRepoInOrg", + "method": "DELETE", + "url": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", "isDeprecated": false, "isLegacy": false, - "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", - "documentationUrl": "https://developer.github.com/v3/repos/branches/#add-admin-enforcement-of-protected-branch", + "description": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/:org_id/team/:team_id/repos/:owner/:repo`.", + "documentationUrl": "https://developer.github.com/v3/teams/#remove-team-repository", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "owner parameter", + "name": "org", + "description": "org parameter", "in": "PATH", "type": "string", "required": true, @@ -15214,8 +9100,8 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", + "name": "team_slug", + "description": "team_slug parameter", "in": "PATH", "type": "string", "required": true, @@ -15226,46 +9112,6 @@ "alias": null, "deprecated": null }, - { - "name": "branch", - "description": "branch parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins\",\"enabled\":true}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Remove admin enforcement of protected branch", - "scope": "repos", - "id": "removeProtectedBranchAdminEnforcement", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", - "isDeprecated": false, - "isLegacy": false, - "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoving admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", - "documentationUrl": "https://developer.github.com/v3/repos/branches/#remove-admin-enforcement-of-protected-branch", - "previews": [], - "headers": [], - "parameters": [ { "name": "owner", "description": "owner parameter", @@ -15291,40 +9137,40 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "branch", - "description": "branch parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null } ], "responses": [], "renamed": null }, { - "name": "Get pull request review enforcement of protected branch", - "scope": "repos", - "id": "getProtectedBranchPullRequestReviewEnforcement", + "name": "List child teams", + "scope": "teams", + "id": "listChildInOrg", "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", + "url": "/orgs/{org}/teams/{team_slug}/teams", "isDeprecated": false, "isLegacy": false, - "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://developer.github.com/v3/repos/branches/#get-pull-request-review-enforcement-of-protected-branch", + "description": "Lists the child teams of the team requested by `:team_slug`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/teams`.\n\n", + "documentationUrl": "https://developer.github.com/v3/teams/#list-child-teams", "previews": [], "headers": [], "parameters": [ { - "name": "owner", - "description": "owner parameter", + "name": "org", + "description": "org parameter", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "team_slug", + "description": "team_slug parameter", "in": "PATH", "type": "string", "required": true, @@ -15336,11 +9182,11 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -15349,11 +9195,11 @@ "deprecated": null }, { - "name": "branch", - "description": "branch parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -15365,10 +9211,10 @@ "responses": [ { "code": 200, - "description": "response", + "description": "Response if child teams exist", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews\",\"dismissal_restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":2}" + "data": "[{\"id\":2,\"node_id\":\"MDQ6VGVhbTI=\",\"url\":\"https://api.github.com/teams/2\",\"name\":\"Original Roster\",\"slug\":\"original-roster\",\"description\":\"Started it all.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/2/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/2/repos\",\"parent\":{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"}}]" } ] } @@ -15376,23 +9222,29 @@ "renamed": null }, { - "name": "Update pull request review enforcement of protected branch", - "scope": "repos", - "id": "updateProtectedBranchPullRequestReviewEnforcement", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", + "name": "Get a project card", + "scope": "projects", + "id": "getCard", + "method": "GET", + "url": "/projects/columns/cards/{card_id}", "isDeprecated": false, "isLegacy": false, - "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.", - "documentationUrl": "https://developer.github.com/v3/repos/branches/#update-pull-request-review-enforcement-of-protected-branch", - "previews": [], - "headers": [], + "description": "", + "documentationUrl": "https://developer.github.com/v3/projects/cards/#get-a-project-card", + "previews": [{ "name": "inertia" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.inertia-preview+json", + "required": true + } + ], "parameters": [ { - "name": "owner", - "description": "owner parameter", + "name": "card_id", + "description": "card_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -15400,12 +9252,45 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "repo", - "description": "repo parameter", + "code": 200, + "description": "response", + "examples": [ + { + "data": "{\"url\":\"https://api.github.com/projects/columns/cards/1478\",\"id\":1478,\"node_id\":\"MDExOlByb2plY3RDYXJkMTQ3OA==\",\"note\":\"Add payload for delete Project column\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2016-09-05T14:21:06Z\",\"updated_at\":\"2016-09-05T14:20:22Z\",\"archived\":false,\"column_url\":\"https://api.github.com/projects/columns/367\",\"content_url\":\"https://api.github.com/repos/api-playground/projects-test/issues/3\",\"project_url\":\"https://api.github.com/projects/120\"}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Update a project card", + "scope": "projects", + "id": "updateCard", + "method": "PATCH", + "url": "/projects/columns/cards/{card_id}", + "isDeprecated": false, + "isLegacy": false, + "description": "", + "documentationUrl": "https://developer.github.com/v3/projects/cards/#update-a-project-card", + "previews": [{ "name": "inertia" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.inertia-preview+json", + "required": true + } + ], + "parameters": [ + { + "name": "card_id", + "description": "card_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -15415,11 +9300,11 @@ "deprecated": null }, { - "name": "branch", - "description": "branch parameter", - "in": "PATH", + "name": "note", + "description": "The card's note content. Only valid for cards without another type of content, so this cannot be specified if the card already has a `content_id` and `content_type`.", + "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -15428,10 +9313,10 @@ "deprecated": null }, { - "name": "dismissal_restrictions", - "description": "Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", + "name": "archived", + "description": "Use `true` to archive a project card. Specify `false` if you need to restore a previously archived project card.", "in": "BODY", - "type": "object", + "type": "boolean", "required": false, "enum": null, "allowNull": false, @@ -15439,26 +9324,82 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "dismissal_restrictions.users", - "description": "The list of user `login`s with dismissal access", - "in": "BODY", - "type": "string[]", - "required": false, + "code": 200, + "description": "response", + "examples": [ + { + "data": "{\"url\":\"https://api.github.com/projects/columns/cards/1478\",\"id\":1478,\"node_id\":\"MDExOlByb2plY3RDYXJkMTQ3OA==\",\"note\":\"Add payload for delete Project column\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2016-09-05T14:21:06Z\",\"updated_at\":\"2016-09-05T14:20:22Z\",\"archived\":false,\"column_url\":\"https://api.github.com/projects/columns/367\",\"content_url\":\"https://api.github.com/repos/api-playground/projects-test/issues/3\",\"project_url\":\"https://api.github.com/projects/120\"}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Delete a project card", + "scope": "projects", + "id": "deleteCard", + "method": "DELETE", + "url": "/projects/columns/cards/{card_id}", + "isDeprecated": false, + "isLegacy": false, + "description": "", + "documentationUrl": "https://developer.github.com/v3/projects/cards/#delete-a-project-card", + "previews": [{ "name": "inertia" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.inertia-preview+json", + "required": true + } + ], + "parameters": [ + { + "name": "card_id", + "description": "card_id parameter", + "in": "PATH", + "type": "integer", + "required": true, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [], + "renamed": null + }, + { + "name": "Move a project card", + "scope": "projects", + "id": "moveCard", + "method": "POST", + "url": "/projects/columns/cards/{card_id}/moves", + "isDeprecated": false, + "isLegacy": false, + "description": "", + "documentationUrl": "https://developer.github.com/v3/projects/cards/#move-a-project-card", + "previews": [{ "name": "inertia" }], + "headers": [ { - "name": "dismissal_restrictions.teams", - "description": "The list of team `slug`s with dismissal access", - "in": "BODY", - "type": "string[]", - "required": false, + "name": "accept", + "value": "application/vnd.github.inertia-preview+json", + "required": true + } + ], + "parameters": [ + { + "name": "card_id", + "description": "card_id parameter", + "in": "PATH", + "type": "integer", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -15467,23 +9408,23 @@ "deprecated": null }, { - "name": "dismiss_stale_reviews", - "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", + "name": "position", + "description": "Can be one of `top`, `bottom`, or `after:`, where `` is the `id` value of a card in the same column, or in the new column specified by `column_id`.", "in": "BODY", - "type": "boolean", - "required": false, + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, - "validation": null, + "validation": "^(top|bottom|after:\\d+)$", "alias": null, "deprecated": null }, { - "name": "require_code_owner_reviews", - "description": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) have reviewed.", + "name": "column_id", + "description": "The `id` value of a column in the same project.", "in": "BODY", - "type": "boolean", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -15491,13 +9432,36 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [], + "renamed": null + }, + { + "name": "Get a project column", + "scope": "projects", + "id": "getColumn", + "method": "GET", + "url": "/projects/columns/{column_id}", + "isDeprecated": false, + "isLegacy": false, + "description": "", + "documentationUrl": "https://developer.github.com/v3/projects/columns/#get-a-project-column", + "previews": [{ "name": "inertia" }], + "headers": [ { - "name": "required_approving_review_count", - "description": "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.", - "in": "BODY", + "name": "accept", + "value": "application/vnd.github.inertia-preview+json", + "required": true + } + ], + "parameters": [ + { + "name": "column_id", + "description": "column_id parameter", + "in": "PATH", "type": "integer", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -15512,7 +9476,7 @@ "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews\",\"dismissal_restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":2}" + "data": "{\"url\":\"https://api.github.com/projects/columns/367\",\"project_url\":\"https://api.github.com/projects/120\",\"cards_url\":\"https://api.github.com/projects/columns/367/cards\",\"id\":367,\"node_id\":\"MDEzOlByb2plY3RDb2x1bW4zNjc=\",\"name\":\"To Do\",\"created_at\":\"2016-09-05T14:18:44Z\",\"updated_at\":\"2016-09-05T14:22:28Z\"}" } ] } @@ -15520,23 +9484,29 @@ "renamed": null }, { - "name": "Remove pull request review enforcement of protected branch", - "scope": "repos", - "id": "removeProtectedBranchPullRequestReviewEnforcement", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", + "name": "Update a project column", + "scope": "projects", + "id": "updateColumn", + "method": "PATCH", + "url": "/projects/columns/{column_id}", "isDeprecated": false, "isLegacy": false, - "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://developer.github.com/v3/repos/branches/#remove-pull-request-review-enforcement-of-protected-branch", - "previews": [], - "headers": [], + "description": "", + "documentationUrl": "https://developer.github.com/v3/projects/columns/#update-a-project-column", + "previews": [{ "name": "inertia" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.inertia-preview+json", + "required": true + } + ], "parameters": [ { - "name": "owner", - "description": "owner parameter", + "name": "column_id", + "description": "column_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -15546,9 +9516,9 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "name", + "description": "The new name of the column.", + "in": "BODY", "type": "string", "required": true, "enum": null, @@ -15557,12 +9527,45 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "branch", - "description": "branch parameter", + "code": 200, + "description": "response", + "examples": [ + { + "data": "{\"url\":\"https://api.github.com/projects/columns/367\",\"project_url\":\"https://api.github.com/projects/120\",\"cards_url\":\"https://api.github.com/projects/columns/367/cards\",\"id\":367,\"node_id\":\"MDEzOlByb2plY3RDb2x1bW4zNjc=\",\"name\":\"To Do\",\"created_at\":\"2016-09-05T14:18:44Z\",\"updated_at\":\"2016-09-05T14:22:28Z\"}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Delete a project column", + "scope": "projects", + "id": "deleteColumn", + "method": "DELETE", + "url": "/projects/columns/{column_id}", + "isDeprecated": false, + "isLegacy": false, + "description": "", + "documentationUrl": "https://developer.github.com/v3/projects/columns/#delete-a-project-column", + "previews": [{ "name": "inertia" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.inertia-preview+json", + "required": true + } + ], + "parameters": [ + { + "name": "column_id", + "description": "column_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -15576,25 +9579,29 @@ "renamed": null }, { - "name": "Get required signatures of protected branch", - "scope": "repos", - "id": "getProtectedBranchRequiredSignatures", + "name": "List project cards", + "scope": "projects", + "id": "listCards", "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", + "url": "/projects/columns/{column_id}/cards", "isDeprecated": false, "isLegacy": false, - "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://help.github.com/articles/signing-commits-with-gpg) in GitHub Help.\n\n**Note**: You must enable branch protection to require signed commits.", - "documentationUrl": "https://developer.github.com/v3/repos/branches/#get-required-signatures-of-protected-branch", - "previews": [{ "name": "zzzax" }], + "description": "", + "documentationUrl": "https://developer.github.com/v3/projects/cards/#list-project-cards", + "previews": [{ "name": "inertia" }], "headers": [ - { "name": "accept", "value": "application/vnd.github.zzzax-preview+json" } + { + "name": "accept", + "value": "application/vnd.github.inertia-preview+json", + "required": true + } ], "parameters": [ { - "name": "owner", - "description": "owner parameter", + "name": "column_id", + "description": "column_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -15604,11 +9611,24 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "archived_state", + "description": "Filters the project cards that are returned by the card's state. Can be one of `all`,`archived`, or `not_archived`.", + "in": "QUERY", "type": "string", - "required": true, + "required": false, + "enum": ["all", "archived", "not_archived"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -15617,11 +9637,11 @@ "deprecated": null }, { - "name": "branch", - "description": "branch parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -15636,7 +9656,7 @@ "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures\",\"enabled\":true}" + "data": "[{\"url\":\"https://api.github.com/projects/columns/cards/1478\",\"id\":1478,\"node_id\":\"MDExOlByb2plY3RDYXJkMTQ3OA==\",\"note\":\"Add payload for delete Project column\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2016-09-05T14:21:06Z\",\"updated_at\":\"2016-09-05T14:20:22Z\",\"archived\":false,\"column_url\":\"https://api.github.com/projects/columns/367\",\"content_url\":\"https://api.github.com/repos/api-playground/projects-test/issues/3\",\"project_url\":\"https://api.github.com/projects/120\"}]" } ] } @@ -15644,25 +9664,29 @@ "renamed": null }, { - "name": "Add required signatures of protected branch", - "scope": "repos", - "id": "addProtectedBranchRequiredSignatures", + "name": "Create a project card", + "scope": "projects", + "id": "createCard", "method": "POST", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", + "url": "/projects/columns/{column_id}/cards", "isDeprecated": false, "isLegacy": false, - "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.", - "documentationUrl": "https://developer.github.com/v3/repos/branches/#add-required-signatures-of-protected-branch", - "previews": [{ "name": "zzzax" }], + "description": "**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key.\n\nBe aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests)\" endpoint.", + "documentationUrl": "https://developer.github.com/v3/projects/cards/#create-a-project-card", + "previews": [{ "name": "inertia" }], "headers": [ - { "name": "accept", "value": "application/vnd.github.zzzax-preview+json" } + { + "name": "accept", + "value": "application/vnd.github.inertia-preview+json", + "required": true + } ], "parameters": [ { - "name": "owner", - "description": "owner parameter", + "name": "column_id", + "description": "column_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -15672,11 +9696,11 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "note", + "description": "The card's note content. Only valid for cards without another type of content, so you must omit when specifying `content_id` and `content_type`.", + "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -15685,11 +9709,24 @@ "deprecated": null }, { - "name": "branch", - "description": "branch parameter", - "in": "PATH", + "name": "content_id", + "description": "The issue or pull request id you want to associate with this card. You can use the [List issues for a repository](https://developer.github.com/v3/issues/#list-issues-for-a-repository) and [List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests) endpoints to find this id. \n**Note:** Depending on whether you use the issue id or pull request id, you will need to specify `Issue` or `PullRequest` as the `content_type`.", + "in": "BODY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "content_type", + "description": "**Required if you provide `content_id`**. The type of content you want to associate with this card. Use `Issue` when `content_id` is an issue id and use `PullRequest` when `content_id` is a pull request id.", + "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -15700,11 +9737,11 @@ ], "responses": [ { - "code": 200, + "code": 201, "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures\",\"enabled\":true}" + "data": "{\"url\":\"https://api.github.com/projects/columns/cards/1478\",\"id\":1478,\"node_id\":\"MDExOlByb2plY3RDYXJkMTQ3OA==\",\"note\":\"Add payload for delete Project column\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2016-09-05T14:21:06Z\",\"updated_at\":\"2016-09-05T14:20:22Z\",\"archived\":false,\"column_url\":\"https://api.github.com/projects/columns/367\",\"content_url\":\"https://api.github.com/repos/api-playground/projects-test/issues/3\",\"project_url\":\"https://api.github.com/projects/120\"}" } ] } @@ -15712,38 +9749,29 @@ "renamed": null }, { - "name": "Remove required signatures of protected branch", - "scope": "repos", - "id": "removeProtectedBranchRequiredSignatures", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", + "name": "Move a project column", + "scope": "projects", + "id": "moveColumn", + "method": "POST", + "url": "/projects/columns/{column_id}/moves", "isDeprecated": false, "isLegacy": false, - "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.", - "documentationUrl": "https://developer.github.com/v3/repos/branches/#remove-required-signatures-of-protected-branch", - "previews": [{ "name": "zzzax" }], + "description": "", + "documentationUrl": "https://developer.github.com/v3/projects/columns/#move-a-project-column", + "previews": [{ "name": "inertia" }], "headers": [ - { "name": "accept", "value": "application/vnd.github.zzzax-preview+json" } + { + "name": "accept", + "value": "application/vnd.github.inertia-preview+json", + "required": true + } ], "parameters": [ { - "name": "owner", - "description": "owner parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "repo parameter", + "name": "column_id", + "description": "column_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -15753,15 +9781,15 @@ "deprecated": null }, { - "name": "branch", - "description": "branch parameter", - "in": "PATH", + "name": "position", + "description": "Can be one of `first`, `last`, or `after:`, where `` is the `id` value of a column in the same project.", + "in": "BODY", "type": "string", "required": true, "enum": null, "allowNull": false, "mapToData": null, - "validation": null, + "validation": "^(first|last|after:\\d+)$", "alias": null, "deprecated": null } @@ -15770,49 +9798,29 @@ "renamed": null }, { - "name": "Get required status checks of protected branch", - "scope": "repos", - "id": "getProtectedBranchRequiredStatusChecks", + "name": "Get a project", + "scope": "projects", + "id": "get", "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", + "url": "/projects/{project_id}", "isDeprecated": false, "isLegacy": false, - "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://developer.github.com/v3/repos/branches/#get-required-status-checks-of-protected-branch", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "owner parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, + "description": "Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", + "documentationUrl": "https://developer.github.com/v3/projects/#get-a-project", + "previews": [{ "name": "inertia" }], + "headers": [ { - "name": "repo", - "description": "repo parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, + "name": "accept", + "value": "application/vnd.github.inertia-preview+json", + "required": true + } + ], + "parameters": [ { - "name": "branch", - "description": "branch parameter", + "name": "project_id", + "description": "project_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -15828,7 +9836,7 @@ "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks\",\"strict\":true,\"contexts\":[\"continuous-integration/travis-ci\"],\"contexts_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts\"}" + "data": "{\"owner_url\":\"https://api.github.com/repos/api-playground/projects-test\",\"url\":\"https://api.github.com/projects/1002604\",\"html_url\":\"https://github.com/api-playground/projects-test/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002604/columns\",\"id\":1002604,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDQ=\",\"name\":\"Projects Documentation\",\"body\":\"Developer documentation project for the developer site.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\"}" } ] } @@ -15836,23 +9844,29 @@ "renamed": null }, { - "name": "Update required status checks of protected branch", - "scope": "repos", - "id": "updateProtectedBranchRequiredStatusChecks", + "name": "Update a project", + "scope": "projects", + "id": "update", "method": "PATCH", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", + "url": "/projects/{project_id}", "isDeprecated": false, "isLegacy": false, - "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.", - "documentationUrl": "https://developer.github.com/v3/repos/branches/#update-required-status-checks-of-protected-branch", - "previews": [], - "headers": [], + "description": "Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", + "documentationUrl": "https://developer.github.com/v3/projects/#update-a-project", + "previews": [{ "name": "inertia" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.inertia-preview+json", + "required": true + } + ], "parameters": [ { - "name": "owner", - "description": "owner parameter", + "name": "project_id", + "description": "project_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -15862,11 +9876,11 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "name", + "description": "The name of the project.", + "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -15875,11 +9889,11 @@ "deprecated": null }, { - "name": "branch", - "description": "branch parameter", - "in": "PATH", + "name": "body", + "description": "The description of the project.", + "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -15888,10 +9902,23 @@ "deprecated": null }, { - "name": "strict", - "description": "Require branches to be up to date before merging.", + "name": "state", + "description": "State of the project. Either `open` or `closed`.", "in": "BODY", - "type": "boolean", + "type": "string", + "required": false, + "enum": ["open", "closed"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "organization_permission", + "description": "The permission level that determines whether all members of the project's organization can see and/or make changes to the project. Setting `organization_permission` is only available for organization projects. If an organization member belongs to a team with a higher level of access or is a collaborator with a higher level of access, their permission level is not lowered by `organization_permission`. For information on changing access for a team or collaborator, see [Add or update team project](https://developer.github.com/v3/teams/#add-or-update-team-project) or [Add user as a collaborator](https://developer.github.com/v3/projects/collaborators/#add-user-as-a-collaborator). \n \n**Note:** Updating a project's `organization_permission` requires `admin` access to the project. \n \nCan be one of: \n\\* `read` - Organization members can read, but not write to or administer this project. \n\\* `write` - Organization members can read and write, but not administer this project. \n\\* `admin` - Organization members can read, write and administer this project. \n\\* `none` - Organization members can only see this project if it is public.", + "in": "BODY", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -15901,10 +9928,10 @@ "deprecated": null }, { - "name": "contexts", - "description": "The list of status checks to require in order to merge into this branch", + "name": "private", + "description": "Sets the visibility of a project board. Setting `private` is only available for organization and user projects. **Note:** Updating a project's visibility requires `admin` access to the project. \n \nCan be one of: \n\\* `false` - Anyone can see the project. \n\\* `true` - Only the user can view a project board created on a user account. Organization members with the appropriate `organization_permission` can see project boards in an organization account.", "in": "BODY", - "type": "string[]", + "type": "boolean", "required": false, "enum": null, "allowNull": false, @@ -15920,7 +9947,7 @@ "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks\",\"strict\":true,\"contexts\":[\"continuous-integration/travis-ci\"],\"contexts_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts\"}" + "data": "{\"owner_url\":\"https://api.github.com/repos/api-playground/projects-test\",\"url\":\"https://api.github.com/projects/1002604\",\"html_url\":\"https://github.com/api-playground/projects-test/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002604/columns\",\"id\":1002604,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDQ=\",\"name\":\"Projects Documentation\",\"body\":\"Developer documentation project for the developer site.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\"}" } ] } @@ -15928,49 +9955,29 @@ "renamed": null }, { - "name": "Remove required status checks of protected branch", - "scope": "repos", - "id": "removeProtectedBranchRequiredStatusChecks", + "name": "Delete a project", + "scope": "projects", + "id": "delete", "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", + "url": "/projects/{project_id}", "isDeprecated": false, "isLegacy": false, - "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://developer.github.com/v3/repos/branches/#remove-required-status-checks-of-protected-branch", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "owner parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, + "description": "Deletes a project board. Returns a `404 Not Found` status if projects are disabled.", + "documentationUrl": "https://developer.github.com/v3/projects/#delete-a-project", + "previews": [{ "name": "inertia" }], + "headers": [ { - "name": "repo", - "description": "repo parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, + "name": "accept", + "value": "application/vnd.github.inertia-preview+json", + "required": true + } + ], + "parameters": [ { - "name": "branch", - "description": "branch parameter", + "name": "project_id", + "description": "project_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -15984,85 +9991,29 @@ "renamed": null }, { - "name": "List required status checks contexts of protected branch", - "scope": "repos", - "id": "listProtectedBranchRequiredStatusChecksContexts", + "name": "List collaborators", + "scope": "projects", + "id": "listCollaborators", "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + "url": "/projects/{project_id}/collaborators", "isDeprecated": false, "isLegacy": false, - "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://developer.github.com/v3/repos/branches/#list-required-status-checks-contexts-of-protected-branch", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "owner parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "repo parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "branch", - "description": "branch parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ + "description": "Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators.", + "documentationUrl": "https://developer.github.com/v3/projects/collaborators/#list-collaborators", + "previews": [{ "name": "inertia" }], + "headers": [ { - "code": 200, - "description": "response", - "examples": [{ "data": "[\"continuous-integration/travis-ci\"]" }] + "name": "accept", + "value": "application/vnd.github.inertia-preview+json", + "required": true } ], - "renamed": null - }, - { - "name": "Replace required status checks contexts of protected branch", - "scope": "repos", - "id": "replaceProtectedBranchRequiredStatusChecksContexts", - "method": "PUT", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", - "isDeprecated": false, - "isLegacy": false, - "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://developer.github.com/v3/repos/branches/#replace-required-status-checks-contexts-of-protected-branch", - "previews": [], - "headers": [], "parameters": [ { - "name": "owner", - "description": "owner parameter", + "name": "project_id", + "description": "project_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -16072,12 +10023,12 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "affiliation", + "description": "Filters the collaborators by their affiliation. Can be one of: \n\\* `outside`: Outside collaborators of a project that are not a member of the project's organization. \n\\* `direct`: Collaborators with permissions to a project, regardless of organization membership status. \n\\* `all`: All collaborators the authenticated user can see.", + "in": "QUERY", "type": "string", - "required": true, - "enum": null, + "required": false, + "enum": ["outside", "direct", "all"], "allowNull": false, "mapToData": null, "validation": null, @@ -16085,11 +10036,11 @@ "deprecated": null }, { - "name": "branch", - "description": "branch parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -16098,14 +10049,14 @@ "deprecated": null }, { - "name": "contexts", - "description": "contexts parameter", - "in": "BODY", - "type": "string[]", - "required": true, + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, - "mapToData": true, + "mapToData": null, "validation": null, "alias": null, "deprecated": null @@ -16115,29 +10066,39 @@ { "code": 200, "description": "response", - "examples": [{ "data": "[\"continuous-integration/travis-ci\"]" }] + "examples": [ + { + "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" + } + ] } ], "renamed": null }, { - "name": "Add required status checks contexts of protected branch", - "scope": "repos", - "id": "addProtectedBranchRequiredStatusChecksContexts", - "method": "POST", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + "name": "Add user as a collaborator", + "scope": "projects", + "id": "addCollaborator", + "method": "PUT", + "url": "/projects/{project_id}/collaborators/{username}", "isDeprecated": false, "isLegacy": false, - "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://developer.github.com/v3/repos/branches/#add-required-status-checks-contexts-of-protected-branch", - "previews": [], - "headers": [], + "description": "Adds a collaborator to a an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator.", + "documentationUrl": "https://developer.github.com/v3/projects/collaborators/#add-user-as-a-collaborator", + "previews": [{ "name": "inertia" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.inertia-preview+json", + "required": true + } + ], "parameters": [ { - "name": "owner", - "description": "owner parameter", + "name": "project_id", + "description": "project_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -16147,8 +10108,8 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", + "name": "username", + "description": "username parameter", "in": "PATH", "type": "string", "required": true, @@ -16160,76 +10121,46 @@ "deprecated": null }, { - "name": "branch", - "description": "branch parameter", - "in": "PATH", + "name": "permission", + "description": "The permission to grant the collaborator. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\" Can be one of: \n\\* `read` - can read, but not write to or administer this project. \n\\* `write` - can read and write, but not administer this project. \n\\* `admin` - can read, write and administer this project.", + "in": "BODY", "type": "string", - "required": true, - "enum": null, + "required": false, + "enum": ["read", "write", "admin"], "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - }, - { - "name": "contexts", - "description": "contexts parameter", - "in": "BODY", - "type": "string[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[\"continuous-integration/travis-ci\",\"continuous-integration/jenkins\"]" - } - ] } ], + "responses": [], "renamed": null }, { - "name": "Remove required status checks contexts of protected branch", - "scope": "repos", - "id": "removeProtectedBranchRequiredStatusChecksContexts", + "name": "Remove user as a collaborator", + "scope": "projects", + "id": "removeCollaborator", "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + "url": "/projects/{project_id}/collaborators/{username}", "isDeprecated": false, "isLegacy": false, - "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://developer.github.com/v3/repos/branches/#remove-required-status-checks-contexts-of-protected-branch", - "previews": [], - "headers": [], - "parameters": [ + "description": "Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator.", + "documentationUrl": "https://developer.github.com/v3/projects/collaborators/#remove-user-as-a-collaborator", + "previews": [{ "name": "inertia" }], + "headers": [ { - "name": "owner", - "description": "owner parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, + "name": "accept", + "value": "application/vnd.github.inertia-preview+json", + "required": true + } + ], + "parameters": [ { - "name": "repo", - "description": "repo parameter", + "name": "project_id", + "description": "project_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -16239,8 +10170,8 @@ "deprecated": null }, { - "name": "branch", - "description": "branch parameter", + "name": "username", + "description": "username parameter", "in": "PATH", "type": "string", "required": true, @@ -16250,61 +10181,35 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "contexts", - "description": "contexts parameter", - "in": "BODY", - "type": "string[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [{ "data": "[\"continuous-integration/travis-ci\"]" }] } ], + "responses": [], "renamed": null }, { - "name": "Get restrictions of protected branch", - "scope": "repos", - "id": "getProtectedBranchRestrictions", + "name": "Review a user's permission level", + "scope": "projects", + "id": "reviewUserPermissionLevel", "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", + "url": "/projects/{project_id}/collaborators/{username}/permission", "isDeprecated": false, "isLegacy": false, - "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists who has access to this protected branch. {{#note}}\n\n**Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories.", - "documentationUrl": "https://developer.github.com/v3/repos/branches/#get-restrictions-of-protected-branch", - "previews": [], - "headers": [], - "parameters": [ + "description": "Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level.", + "documentationUrl": "https://developer.github.com/v3/projects/collaborators/#review-a-users-permission-level", + "previews": [{ "name": "inertia" }], + "headers": [ { - "name": "owner", - "description": "owner parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, + "name": "accept", + "value": "application/vnd.github.inertia-preview+json", + "required": true + } + ], + "parameters": [ { - "name": "repo", - "description": "repo parameter", + "name": "project_id", + "description": "project_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -16314,8 +10219,8 @@ "deprecated": null }, { - "name": "branch", - "description": "branch parameter", + "name": "username", + "description": "username parameter", "in": "PATH", "type": "string", "required": true, @@ -16333,7 +10238,7 @@ "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams\",\"apps_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"apps\":[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]}" + "data": "{\"permission\":\"admin\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" } ] } @@ -16341,23 +10246,29 @@ "renamed": null }, { - "name": "Remove restrictions of protected branch", - "scope": "repos", - "id": "removeProtectedBranchRestrictions", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", + "name": "List project columns", + "scope": "projects", + "id": "listColumns", + "method": "GET", + "url": "/projects/{project_id}/columns", "isDeprecated": false, "isLegacy": false, - "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nDisables the ability to restrict who can push to this branch.", - "documentationUrl": "https://developer.github.com/v3/repos/branches/#remove-restrictions-of-protected-branch", - "previews": [], - "headers": [], + "description": "", + "documentationUrl": "https://developer.github.com/v3/projects/columns/#list-project-columns", + "previews": [{ "name": "inertia" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.inertia-preview+json", + "required": true + } + ], "parameters": [ { - "name": "owner", - "description": "owner parameter", + "name": "project_id", + "description": "project_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -16367,11 +10278,11 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -16380,11 +10291,11 @@ "deprecated": null }, { - "name": "branch", - "description": "branch parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -16393,40 +10304,43 @@ "deprecated": null } ], - "responses": [], + "responses": [ + { + "code": 200, + "description": "response", + "examples": [ + { + "data": "[{\"url\":\"https://api.github.com/projects/columns/367\",\"project_url\":\"https://api.github.com/projects/120\",\"cards_url\":\"https://api.github.com/projects/columns/367/cards\",\"id\":367,\"node_id\":\"MDEzOlByb2plY3RDb2x1bW4zNjc=\",\"name\":\"To Do\",\"created_at\":\"2016-09-05T14:18:44Z\",\"updated_at\":\"2016-09-05T14:22:28Z\"}]" + } + ] + } + ], "renamed": null }, { - "name": "Get apps with access to protected branch", - "scope": "repos", - "id": "getAppsWithAccessToProtectedBranch", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + "name": "Create a project column", + "scope": "projects", + "id": "createColumn", + "method": "POST", + "url": "/projects/{project_id}/columns", "isDeprecated": false, "isLegacy": false, - "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.", - "documentationUrl": "https://developer.github.com/v3/repos/branches/#list-apps-with-access-to-protected-branch", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "owner parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, + "description": "", + "documentationUrl": "https://developer.github.com/v3/projects/columns/#create-a-project-column", + "previews": [{ "name": "inertia" }], + "headers": [ { - "name": "repo", - "description": "repo parameter", + "name": "accept", + "value": "application/vnd.github.inertia-preview+json", + "required": true + } + ], + "parameters": [ + { + "name": "project_id", + "description": "project_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -16436,9 +10350,9 @@ "deprecated": null }, { - "name": "branch", - "description": "branch parameter", - "in": "PATH", + "name": "name", + "description": "The name of the column.", + "in": "BODY", "type": "string", "required": true, "enum": null, @@ -16455,7 +10369,7 @@ "description": "response", "examples": [ { - "data": "[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]" + "data": "{\"url\":\"https://api.github.com/projects/columns/367\",\"project_url\":\"https://api.github.com/projects/120\",\"cards_url\":\"https://api.github.com/projects/columns/367/cards\",\"id\":367,\"node_id\":\"MDEzOlByb2plY3RDb2x1bW4zNjc=\",\"name\":\"To Do\",\"created_at\":\"2016-09-05T14:18:44Z\",\"updated_at\":\"2016-09-05T14:22:28Z\"}" } ] } @@ -16463,23 +10377,55 @@ "renamed": null }, { - "name": "Get apps with access to protected branch", - "scope": "repos", - "id": "listAppsWithAccessToProtectedBranch", + "name": "Get your current rate limit status", + "scope": "rateLimit", + "id": "get", "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + "url": "/rate_limit", "isDeprecated": false, "isLegacy": false, - "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.", - "documentationUrl": "https://developer.github.com/v3/repos/branches/#list-apps-with-access-to-protected-branch", + "description": "**Note:** Accessing this endpoint does not count against your REST API rate limit.\n\n**Understanding your rate limit status**\n\nThe Search API has a [custom rate limit](https://developer.github.com/v3/search/#rate-limit), separate from the rate limit governing the rest of the REST API. The GraphQL API also has a [custom rate limit](https://developer.github.com/v4/guides/resource-limitations/#rate-limit) that is separate from and calculated differently than rate limits in the REST API.\n\nFor these reasons, the Rate Limit API response categorizes your rate limit. Under `resources`, you'll see four objects:\n\n* The `core` object provides your rate limit status for all non-search-related resources in the REST API.\n* The `search` object provides your rate limit status for the [Search API](https://developer.github.com/v3/search/).\n* The `graphql` object provides your rate limit status for the [GraphQL API](https://developer.github.com/v4/).\n* The `integration_manifest` object provides your rate limit status for the [GitHub App Manifest code conversion](https://developer.github.com/apps/building-github-apps/creating-github-apps-from-a-manifest/#3-you-exchange-the-temporary-code-to-retrieve-the-app-configuration) endpoint.\n\nFor more information on the headers and values in the rate limit response, see \"[Rate limiting](https://developer.github.com/v3/#rate-limiting).\"\n\nThe `rate` object (shown at the bottom of the response above) is deprecated.\n\nIf you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", + "documentationUrl": "https://developer.github.com/v3/rate_limit/#get-your-current-rate-limit-status", "previews": [], "headers": [], + "parameters": [], + "responses": [ + { + "code": 200, + "description": "response", + "examples": [ + { + "data": "{\"resources\":{\"core\":{\"limit\":5000,\"remaining\":4999,\"reset\":1372700873},\"search\":{\"limit\":30,\"remaining\":18,\"reset\":1372697452},\"graphql\":{\"limit\":5000,\"remaining\":4993,\"reset\":1372700389},\"integration_manifest\":{\"limit\":5000,\"remaining\":4999,\"reset\":1551806725}},\"rate\":{\"limit\":5000,\"remaining\":4999,\"reset\":1372700873}}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Delete a reaction", + "scope": "reactions", + "id": "delete", + "method": "DELETE", + "url": "/reactions/{reaction_id}", + "isDeprecated": false, + "isLegacy": false, + "description": "OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), when deleting a [team discussion](https://developer.github.com/v3/teams/discussions/) or [team discussion comment](https://developer.github.com/v3/teams/discussion_comments/).", + "documentationUrl": "https://developer.github.com/v3/reactions/#delete-a-reaction", + "previews": [{ "name": "squirrel-girl" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.squirrel-girl-preview+json", + "required": true + } + ], "parameters": [ { - "name": "owner", - "description": "owner parameter", + "name": "reaction_id", + "description": "reaction_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -16487,10 +10433,27 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [], + "renamed": null + }, + { + "name": "Get", + "scope": "repos", + "id": "get", + "method": "GET", + "url": "/repos/{owner}/{repo}", + "isDeprecated": false, + "isLegacy": false, + "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.", + "documentationUrl": "https://developer.github.com/v3/repos/#get", + "previews": [], + "headers": [], + "parameters": [ { - "name": "repo", - "description": "repo parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", "type": "string", "required": true, @@ -16502,8 +10465,8 @@ "deprecated": null }, { - "name": "branch", - "description": "branch parameter", + "name": "repo", + "description": "repo parameter", "in": "PATH", "type": "string", "required": true, @@ -16518,34 +10481,26 @@ "responses": [ { "code": 200, - "description": "response", + "description": "The `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.", "examples": [ { - "data": "[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]" + "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"},\"organization\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"parent\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"source\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}" } ] } ], - "renamed": { - "before": { - "scope": "repos", - "id": "listAppsWithAccessToProtectedBranch" - }, - "after": { "scope": "repos", "id": "getAppsWithAccessToProtectedBranch" }, - "date": "2019-09-13", - "note": "\"List apps with access to protected branch\" is now \"Get apps with access to protected branch\"" - } + "renamed": null }, { - "name": "Replace app restrictions of protected branch", + "name": "Edit", "scope": "repos", - "id": "replaceProtectedBranchAppRestrictions", - "method": "PUT", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + "id": "update", + "method": "PATCH", + "url": "/repos/{owner}/{repo}", "isDeprecated": false, "isLegacy": false, - "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://developer.github.com/v3/repos/branches/#replace-app-restrictions-of-protected-branch", + "description": "**Note**: To edit a repository's topics, use the [`topics` endpoint](https://developer.github.com/v3/repos/#replace-all-topics-for-a-repository).", + "documentationUrl": "https://developer.github.com/v3/repos/#edit", "previews": [], "headers": [], "parameters": [ @@ -16576,11 +10531,11 @@ "deprecated": null }, { - "name": "branch", - "description": "branch parameter", - "in": "PATH", + "name": "name", + "description": "The name of the repository.", + "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -16589,51 +10544,11 @@ "deprecated": null }, { - "name": "apps", - "description": "apps parameter", + "name": "description", + "description": "A short description of the repository.", "in": "BODY", - "type": "string[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Add app restrictions of protected branch", - "scope": "repos", - "id": "addProtectedBranchAppRestrictions", - "method": "POST", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "isDeprecated": false, - "isLegacy": false, - "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified apps push access for this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://developer.github.com/v3/repos/branches/#add-app-restrictions-of-protected-branch", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "owner parameter", - "in": "PATH", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -16642,11 +10557,11 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "homepage", + "description": "A URL with more information about the repository.", + "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -16655,11 +10570,11 @@ "deprecated": null }, { - "name": "branch", - "description": "branch parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "private", + "description": "Either `true` to make the repository private or `false` to make it public. Creating private repositories requires a paid GitHub account. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", + "in": "BODY", + "type": "boolean", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -16668,51 +10583,24 @@ "deprecated": null }, { - "name": "apps", - "description": "apps parameter", + "name": "visibility", + "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud, `visibility` can also be `internal`. The `visibility` parameter overrides the `private` parameter when you use both along with the `nebula-preview` preview header.", "in": "BODY", - "type": "string[]", - "required": true, - "enum": null, + "type": "string", + "required": false, + "enum": ["public", "private", "visibility", "internal"], "allowNull": false, - "mapToData": true, + "mapToData": null, "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Remove app restrictions of protected branch", - "scope": "repos", - "id": "removeProtectedBranchAppRestrictions", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", - "isDeprecated": false, - "isLegacy": false, - "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://developer.github.com/v3/repos/branches/#remove-app-restrictions-of-protected-branch", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "owner", - "description": "owner parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "has_issues", + "description": "Either `true` to enable issues for this repository or `false` to disable them.", + "in": "BODY", + "type": "boolean", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -16721,11 +10609,11 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "has_projects", + "description": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", + "in": "BODY", + "type": "boolean", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -16734,11 +10622,11 @@ "deprecated": null }, { - "name": "branch", - "description": "branch parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "has_wiki", + "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", + "in": "BODY", + "type": "boolean", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -16747,51 +10635,24 @@ "deprecated": null }, { - "name": "apps", - "description": "apps parameter", + "name": "is_template", + "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", "in": "BODY", - "type": "string[]", - "required": true, + "type": "boolean", + "required": false, "enum": null, "allowNull": false, - "mapToData": true, + "mapToData": null, "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get teams with access to protected branch", - "scope": "repos", - "id": "getTeamsWithAccessToProtectedBranch", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "isDeprecated": false, - "isLegacy": false, - "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the teams who have push access to this branch. The list includes child teams.", - "documentationUrl": "https://developer.github.com/v3/repos/branches/#list-teams-with-access-to-protected-branch", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "owner", - "description": "owner parameter", - "in": "PATH", + "name": "default_branch", + "description": "Updates the default branch for this repository.", + "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -16800,11 +10661,11 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "allow_squash_merge", + "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", + "in": "BODY", + "type": "boolean", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -16813,51 +10674,24 @@ "deprecated": null }, { - "name": "branch", - "description": "branch parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "allow_merge_commit", + "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", + "in": "BODY", + "type": "boolean", + "required": false, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get teams with access to protected branch", - "scope": "repos", - "id": "listProtectedBranchTeamRestrictions", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", - "isDeprecated": false, - "isLegacy": false, - "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the teams who have push access to this branch. The list includes child teams.", - "documentationUrl": "https://developer.github.com/v3/repos/branches/#list-teams-with-access-to-protected-branch", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "owner", - "description": "owner parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "allow_rebase_merge", + "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", + "in": "BODY", + "type": "boolean", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -16866,11 +10700,11 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "delete_branch_on_merge", + "description": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", + "in": "BODY", + "type": "boolean", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -16879,11 +10713,11 @@ "deprecated": null }, { - "name": "branch", - "description": "branch parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "archived", + "description": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.", + "in": "BODY", + "type": "boolean", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -16898,34 +10732,23 @@ "description": "response", "examples": [ { - "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]" + "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0,\"organization\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"parent\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"source\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}" } ] } ], - "renamed": { - "before": { - "scope": "repos", - "id": "listProtectedBranchTeamRestrictions" - }, - "after": { - "scope": "repos", - "id": "getTeamsWithAccessToProtectedBranch" - }, - "date": "2019-09-09", - "note": "\"List team restrictions of protected branch\" is now \"Get teams with access to protected branch\"" - } + "renamed": null }, { - "name": "Get teams with access to protected branch", + "name": "Delete a repository", "scope": "repos", - "id": "listTeamsWithAccessToProtectedBranch", - "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + "id": "delete", + "method": "DELETE", + "url": "/repos/{owner}/{repo}", "isDeprecated": false, "isLegacy": false, - "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the teams who have push access to this branch. The list includes child teams.", - "documentationUrl": "https://developer.github.com/v3/repos/branches/#list-teams-with-access-to-protected-branch", + "description": "Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required.\n\nIf an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response:", + "documentationUrl": "https://developer.github.com/v3/repos/#delete-a-repository", "previews": [], "headers": [], "parameters": [ @@ -16954,55 +10777,31 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "branch", - "description": "branch parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null } ], "responses": [ { - "code": 200, - "description": "response", + "code": 403, + "description": "If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response:", "examples": [ { - "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]" + "data": "{\"message\":\"Organization members cannot delete repositories.\",\"documentation_url\":\"https://developer.github.com/v3/repos/#delete-a-repository\"}" } ] } ], - "renamed": { - "before": { - "scope": "repos", - "id": "listTeamsWithAccessToProtectedBranch" - }, - "after": { - "scope": "repos", - "id": "getTeamsWithAccessToProtectedBranch" - }, - "date": "2019-09-13", - "note": "\"List teams with access to protected branch\" is now \"Get teams with access to protected branch\"" - } + "renamed": null }, { - "name": "Replace team restrictions of protected branch", - "scope": "repos", - "id": "replaceProtectedBranchTeamRestrictions", - "method": "PUT", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + "name": "Get an artifact", + "scope": "actions", + "id": "getArtifact", + "method": "GET", + "url": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}", "isDeprecated": false, "isLegacy": false, - "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://developer.github.com/v3/repos/branches/#replace-team-restrictions-of-protected-branch", + "description": "Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.", + "documentationUrl": "https://developer.github.com/v3/actions/artifacts/#get-an-artifact", "previews": [], "headers": [], "parameters": [ @@ -17033,10 +10832,10 @@ "deprecated": null }, { - "name": "branch", - "description": "branch parameter", + "name": "artifact_id", + "description": "artifact_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -17044,19 +10843,6 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "teams", - "description": "teams parameter", - "in": "BODY", - "type": "string[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null } ], "responses": [ @@ -17065,7 +10851,7 @@ "description": "response", "examples": [ { - "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]" + "data": "{\"id\":11,\"node_id\":\"MDg6QXJ0aWZhY3QxMQ==\",\"name\":\"Rails\",\"size_in_bytes\":556,\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/5/zip\",\"expired\":\"false\",\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-01-21T14:59:22Z\"}" } ] } @@ -17073,15 +10859,15 @@ "renamed": null }, { - "name": "Add team restrictions of protected branch", - "scope": "repos", - "id": "addProtectedBranchTeamRestrictions", - "method": "POST", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + "name": "Delete an artifact", + "scope": "actions", + "id": "deleteArtifact", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}", "isDeprecated": false, "isLegacy": false, - "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified teams push access for this branch. You can also give push access to child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://developer.github.com/v3/repos/branches/#add-team-restrictions-of-protected-branch", + "description": "Deletes an artifact for a workflow run. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.", + "documentationUrl": "https://developer.github.com/v3/actions/artifacts/#delete-an-artifact", "previews": [], "headers": [], "parameters": [ @@ -17112,10 +10898,10 @@ "deprecated": null }, { - "name": "branch", - "description": "branch parameter", + "name": "artifact_id", + "description": "artifact_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -17123,44 +10909,21 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "teams", - "description": "teams parameter", - "in": "BODY", - "type": "string[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]" - } - ] } ], + "responses": [], "renamed": null }, { - "name": "Remove team restrictions of protected branch", - "scope": "repos", - "id": "removeProtectedBranchTeamRestrictions", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + "name": "Download an artifact", + "scope": "actions", + "id": "downloadArtifact", + "method": "GET", + "url": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}", "isDeprecated": false, "isLegacy": false, - "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://developer.github.com/v3/repos/branches/#remove-team-restrictions-of-protected-branch", + "description": "Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in the response header to find the URL for the download. The `:archive_format` must be `zip`. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.\n\nCall this endpoint using the `-v` flag, which enables verbose output and allows you to see the download URL in the header. To download the file into the current working directory, specify the filename using the `-o` flag.", + "documentationUrl": "https://developer.github.com/v3/actions/artifacts/#download-an-artifact", "previews": [], "headers": [], "parameters": [ @@ -17191,10 +10954,10 @@ "deprecated": null }, { - "name": "branch", - "description": "branch parameter", + "name": "artifact_id", + "description": "artifact_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -17204,42 +10967,32 @@ "deprecated": null }, { - "name": "teams", - "description": "teams parameter", - "in": "BODY", - "type": "string[]", + "name": "archive_format", + "description": "archive_format parameter", + "in": "PATH", + "type": "string", "required": true, "enum": null, "allowNull": false, - "mapToData": true, + "mapToData": null, "validation": null, "alias": null, "deprecated": null } ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]" - } - ] - } - ], + "responses": [], "renamed": null }, { - "name": "Get users with access to protected branch", - "scope": "repos", - "id": "getUsersWithAccessToProtectedBranch", + "name": "Get a workflow job", + "scope": "actions", + "id": "getWorkflowJob", "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + "url": "/repos/{owner}/{repo}/actions/jobs/{job_id}", "isDeprecated": false, "isLegacy": false, - "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the people who have push access to this branch.", - "documentationUrl": "https://developer.github.com/v3/repos/branches/#list-users-with-access-to-protected-branch", + "description": "Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.", + "documentationUrl": "https://developer.github.com/v3/actions/workflow_jobs/#get-a-workflow-job", "previews": [], "headers": [], "parameters": [ @@ -17270,10 +11023,10 @@ "deprecated": null }, { - "name": "branch", - "description": "branch parameter", + "name": "job_id", + "description": "job_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -17285,11 +11038,11 @@ ], "responses": [ { - "code": 200, + "code": 202, "description": "response", "examples": [ { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" + "data": "{\"id\":399444496,\"run_id\":29679449,\"run_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449\",\"node_id\":\"MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==\",\"head_sha\":\"f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496\",\"html_url\":\"https://github.com/octo-org/octo-repo/runs/399444496\",\"status\":\"completed\",\"conclusion\":\"success\",\"started_at\":\"2020-01-20T17:42:40Z\",\"completed_at\":\"2020-01-20T17:44:39Z\",\"name\":\"build\",\"steps\":[{\"name\":\"Set up job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":1,\"started_at\":\"2020-01-20T09:42:40.000-08:00\",\"completed_at\":\"2020-01-20T09:42:41.000-08:00\"},{\"name\":\"Run actions/checkout@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":2,\"started_at\":\"2020-01-20T09:42:41.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Set up Ruby\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":3,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Run actions/cache@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":4,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:48.000-08:00\"},{\"name\":\"Install Bundler\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":5,\"started_at\":\"2020-01-20T09:42:48.000-08:00\",\"completed_at\":\"2020-01-20T09:42:52.000-08:00\"},{\"name\":\"Install Gems\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":6,\"started_at\":\"2020-01-20T09:42:52.000-08:00\",\"completed_at\":\"2020-01-20T09:42:53.000-08:00\"},{\"name\":\"Run Tests\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":7,\"started_at\":\"2020-01-20T09:42:53.000-08:00\",\"completed_at\":\"2020-01-20T09:42:59.000-08:00\"},{\"name\":\"Deploy to Heroku\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":8,\"started_at\":\"2020-01-20T09:42:59.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Post actions/cache@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":16,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Complete job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":17,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"}],\"check_run_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496\"}" } ] } @@ -17297,15 +11050,15 @@ "renamed": null }, { - "name": "Get users with access to protected branch", - "scope": "repos", - "id": "listProtectedBranchUserRestrictions", + "name": "List workflow job logs", + "scope": "actions", + "id": "listWorkflowJobLogs", "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + "url": "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs", "isDeprecated": false, "isLegacy": false, - "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the people who have push access to this branch.", - "documentationUrl": "https://developer.github.com/v3/repos/branches/#list-users-with-access-to-protected-branch", + "description": "Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.\n\nCall this endpoint using the `-v` flag, which enables verbose output and allows you to see the download URL in the header. To download the file into the current working directory, specify the filename using the `-o` flag.", + "documentationUrl": "https://developer.github.com/v3/actions/workflow_jobs/#list-workflow-job-logs", "previews": [], "headers": [], "parameters": [ @@ -17336,10 +11089,10 @@ "deprecated": null }, { - "name": "branch", - "description": "branch parameter", + "name": "job_id", + "description": "job_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -17347,42 +11100,47 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ + }, { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], - "renamed": { - "before": { - "scope": "repos", - "id": "listProtectedBranchUserRestrictions" - }, - "after": { - "scope": "repos", - "id": "getUsersWithAccessToProtectedBranch" - }, - "date": "2019-09-09", - "note": "\"List user restrictions of protected branch\" is now \"Get users with access to protected branch\"" - } + "responses": [], + "renamed": null }, { - "name": "Get users with access to protected branch", - "scope": "repos", - "id": "listUsersWithAccessToProtectedBranch", + "name": "List self-hosted runners for a repository", + "scope": "actions", + "id": "listSelfHostedRunnersForRepo", "method": "GET", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + "url": "/repos/{owner}/{repo}/actions/runners", "isDeprecated": false, "isLegacy": false, - "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the people who have push access to this branch.", - "documentationUrl": "https://developer.github.com/v3/repos/branches/#list-users-with-access-to-protected-branch", + "description": "Lists all self-hosted runners for a repository. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the `administration` permission to use this endpoint.", + "documentationUrl": "https://developer.github.com/v3/actions/self_hosted_runners/#list-self-hosted-runners-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -17413,11 +11171,24 @@ "deprecated": null }, { - "name": "branch", - "description": "branch parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -17432,34 +11203,23 @@ "description": "response", "examples": [ { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" + "data": "[[{\"id\":23,\"name\":\"MBP\",\"os\":\"macos\",\"status\":\"online\"},{\"id\":24,\"name\":\"iMac\",\"os\":\"macos\",\"status\":\"offline\"}]]" } ] } ], - "renamed": { - "before": { - "scope": "repos", - "id": "listUsersWithAccessToProtectedBranch" - }, - "after": { - "scope": "repos", - "id": "getUsersWithAccessToProtectedBranch" - }, - "date": "2019-09-13", - "note": "\"List users with access to protected branch\" is now \"Get users with access to protected branch\"" - } + "renamed": null }, { - "name": "Replace user restrictions of protected branch", - "scope": "repos", - "id": "replaceProtectedBranchUserRestrictions", - "method": "PUT", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + "name": "List downloads for the self-hosted runner application", + "scope": "actions", + "id": "listDownloadsForSelfHostedRunnerApplication", + "method": "GET", + "url": "/repos/{owner}/{repo}/actions/runners/downloads", "isDeprecated": false, "isLegacy": false, - "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://developer.github.com/v3/repos/branches/#replace-user-restrictions-of-protected-branch", + "description": "Lists binaries for the self-hosted runner application that you can download and run. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the `administration` permission to use this endpoint.", + "documentationUrl": "https://developer.github.com/v3/actions/self_hosted_runners/#list-downloads-for-the-self-hosted-runner-application", "previews": [], "headers": [], "parameters": [ @@ -17488,32 +11248,6 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "branch", - "description": "branch parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "users", - "description": "users parameter", - "in": "BODY", - "type": "string[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null } ], "responses": [ @@ -17522,7 +11256,7 @@ "description": "response", "examples": [ { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" + "data": "[{\"os\":\"osx\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-osx-x64-2.164.0.tar.gz\",\"filename\":\"actions-runner-osx-x64-2.164.0.tar.gz\"},{\"os\":\"linux\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-x64-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-x64-2.164.0.tar.gz\"},{\"os\":\"linux\",\"architecture\":\"arm\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-arm-2.164.0.tar.gz\"},{\"os\":\"win\",\"architecture\":\"x64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-win-x64-2.164.0.zip\",\"filename\":\"actions-runner-win-x64-2.164.0.zip\"},{\"os\":\"linux\",\"architecture\":\"arm64\",\"download_url\":\"https://github.com/actions/runner/releases/download/v2.164.0/actions-runner-linux-arm64-2.164.0.tar.gz\",\"filename\":\"actions-runner-linux-arm64-2.164.0.tar.gz\"}]" } ] } @@ -17530,15 +11264,15 @@ "renamed": null }, { - "name": "Add user restrictions of protected branch", - "scope": "repos", - "id": "addProtectedBranchUserRestrictions", + "name": "Create a registration token", + "scope": "actions", + "id": "createRegistrationToken", "method": "POST", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + "url": "/repos/{owner}/{repo}/actions/runners/registration-token", "isDeprecated": false, "isLegacy": false, - "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified people push access for this branch.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://developer.github.com/v3/repos/branches/#add-user-restrictions-of-protected-branch", + "description": "Returns a token that you can pass to the `config` script. The token expires after one hour. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the `administration` permission to use this endpoint.\n\nConfigure your self-hosted runner, replacing TOKEN with the registration token provided by this endpoint.\n\n", + "documentationUrl": "https://developer.github.com/v3/actions/self_hosted_runners/#create-a-registration-token", "previews": [], "headers": [], "parameters": [ @@ -17567,10 +11301,37 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "branch", - "description": "branch parameter", + "code": 201, + "description": "response", + "examples": [ + { + "data": "{\"token\":\"LLBF3JGZDX3P5PMEXLND6TS6FCWO6\",\"expires_at\":\"2020-01-22T12:13:35.123-08:00\"}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Create a remove token", + "scope": "actions", + "id": "createRemoveToken", + "method": "POST", + "url": "/repos/{owner}/{repo}/actions/runners/remove-token", + "isDeprecated": false, + "isLegacy": false, + "description": "Returns a token that you can pass to remove a self-hosted runner from a repository. The token expires after one hour. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the `administration` permission to use this endpoint.\n\nRemove your self-hosted runner from a repository, replacing TOKEN with the remove token provided by this endpoint.\n\n", + "documentationUrl": "https://developer.github.com/v3/actions/self_hosted_runners/#create-a-remove-token", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "owner parameter", "in": "PATH", "type": "string", "required": true, @@ -17582,14 +11343,14 @@ "deprecated": null }, { - "name": "users", - "description": "users parameter", - "in": "BODY", - "type": "string[]", + "name": "repo", + "description": "repo parameter", + "in": "PATH", + "type": "string", "required": true, "enum": null, "allowNull": false, - "mapToData": true, + "mapToData": null, "validation": null, "alias": null, "deprecated": null @@ -17597,11 +11358,11 @@ ], "responses": [ { - "code": 200, + "code": 201, "description": "response", "examples": [ { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" + "data": "{\"token\":\"AABF3JGZDX3P5PMEXLND6TS6FCWO6\",\"expires_at\":\"2020-01-29T12:13:35.123-08:00\"}" } ] } @@ -17609,15 +11370,15 @@ "renamed": null }, { - "name": "Remove user restrictions of protected branch", - "scope": "repos", - "id": "removeProtectedBranchUserRestrictions", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + "name": "Get a self-hosted runner", + "scope": "actions", + "id": "getSelfHostedRunner", + "method": "GET", + "url": "/repos/{owner}/{repo}/actions/runners/{runner_id}", "isDeprecated": false, "isLegacy": false, - "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a user to push to this branch.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", - "documentationUrl": "https://developer.github.com/v3/repos/branches/#remove-user-restrictions-of-protected-branch", + "description": "Gets a specific self-hosted runner. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the `administration` permission to use this endpoint.", + "documentationUrl": "https://developer.github.com/v3/actions/self_hosted_runners/#get-a-self-hosted-runner", "previews": [], "headers": [], "parameters": [ @@ -17648,10 +11409,10 @@ "deprecated": null }, { - "name": "branch", - "description": "branch parameter", + "name": "runner_id", + "description": "runner_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -17659,19 +11420,6 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "users", - "description": "users parameter", - "in": "BODY", - "type": "string[]", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null } ], "responses": [ @@ -17680,7 +11428,7 @@ "description": "response", "examples": [ { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" + "data": "{\"id\":23,\"name\":\"MBP\",\"os\":\"macos\",\"status\":\"online\"}" } ] } @@ -17688,22 +11436,17 @@ "renamed": null }, { - "name": "Create a check run", - "scope": "checks", - "id": "create", - "method": "POST", - "url": "/repos/{owner}/{repo}/check-runs", + "name": "Remove a self-hosted runner", + "scope": "actions", + "id": "removeSelfHostedRunner", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/actions/runners/{runner_id}", "isDeprecated": false, "isLegacy": false, - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.", - "documentationUrl": "https://developer.github.com/v3/checks/runs/#create-a-check-run", - "previews": [{ "name": "antiope" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.antiope-preview+json" - } - ], + "description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists. Anyone with admin access to the repository can use this endpoint. GitHub Apps must have the `administration` permission to use this endpoint.", + "documentationUrl": "https://developer.github.com/v3/actions/self_hosted_runners/#remove-a-self-hosted-runner", + "previews": [], + "headers": [], "parameters": [ { "name": "owner", @@ -17732,10 +11475,10 @@ "deprecated": null }, { - "name": "name", - "description": "The name of the check. For example, \"code-coverage\".", - "in": "BODY", - "type": "string", + "name": "runner_id", + "description": "runner_id parameter", + "in": "PATH", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -17743,11 +11486,28 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [], + "renamed": null + }, + { + "name": "List repository workflow runs", + "scope": "actions", + "id": "listRepoWorkflowRuns", + "method": "GET", + "url": "/repos/{owner}/{repo}/actions/runs", + "isDeprecated": false, + "isLegacy": false, + "description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://developer.github.com/v3/#parameters).\n\nAnyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.", + "documentationUrl": "https://developer.github.com/v3/actions/workflow_runs/#list-repository-workflow-runs", + "previews": [], + "headers": [], + "parameters": [ { - "name": "head_sha", - "description": "The SHA of the commit.", - "in": "BODY", + "name": "owner", + "description": "owner parameter", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -17758,11 +11518,11 @@ "deprecated": null }, { - "name": "details_url", - "description": "The URL of the integrator's site that has the full details of the check.", - "in": "BODY", + "name": "repo", + "description": "repo parameter", + "in": "PATH", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -17771,9 +11531,9 @@ "deprecated": null }, { - "name": "external_id", - "description": "A reference for the run on the integrator's system.", - "in": "BODY", + "name": "actor", + "description": "Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run.", + "in": "QUERY", "type": "string", "required": false, "enum": null, @@ -17784,12 +11544,12 @@ "deprecated": null }, { - "name": "status", - "description": "The current status. Can be one of `queued`, `in_progress`, or `completed`.", - "in": "BODY", + "name": "branch", + "description": "Returns workflow runs associated with a branch. Use the name of the branch of the `push`.", + "in": "QUERY", "type": "string", "required": false, - "enum": ["queued", "in_progress", "completed"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -17797,9 +11557,9 @@ "deprecated": null }, { - "name": "started_at", - "description": "The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "BODY", + "name": "event", + "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)\" in the GitHub Help documentation.", + "in": "QUERY", "type": "string", "required": false, "enum": null, @@ -17810,19 +11570,12 @@ "deprecated": null }, { - "name": "conclusion", - "description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`.", - "in": "BODY", + "name": "status", + "description": "Returns workflow runs associated with the check run `status` or `conclusion` you specify. For example, a conclusion can be `success` or a status can be `completed`. For more information, see the `status` and `conclusion` options available in \"[Create a check run](https://developer.github.com/v3/checks/runs/#create-a-check-run).\"", + "in": "QUERY", "type": "string", "required": false, - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "timed_out", - "action_required" - ], + "enum": ["completed", "status", "conclusion"], "allowNull": false, "mapToData": null, "validation": null, @@ -17830,10 +11583,10 @@ "deprecated": null }, { - "name": "completed_at", - "description": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "BODY", - "type": "string", + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -17843,10 +11596,10 @@ "deprecated": null }, { - "name": "output", - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://developer.github.com/v3/checks/runs/#output-object) description.", - "in": "BODY", - "type": "object", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -17854,24 +11607,38 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "output.title", - "description": "The title of the check run.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, + "code": 200, + "description": "response", + "examples": [ + { + "data": "{\"total_count\":1,\"workflow_runs\":[{\"id\":30433642,\"node_id\":\"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\"head_branch\":\"master\",\"head_sha\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"run_number\":562,\"check_suite_id\":414944374,\"event\":\"push\",\"status\":\"queued\",\"conclusion\":null,\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\"html_url\":\"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\"pull_requests\":[],\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"jobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\"logs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\"artifacts_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\"cancel_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\"rerun_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\"workflow_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/30433642\",\"head_commit\":{\"id\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"tree_id\":\"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\"message\":\"Create linter.yml\",\"timestamp\":\"2020-01-22T19:33:05Z\",\"author\":{\"name\":\"Octo Cat\",\"email\":\"octocat@github.com\"},\"committer\":{\"name\":\"GitHub\",\"email\":\"noreply@github.com\"}},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\"},\"head_repository\":{\"id\":217723378,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\"name\":\"octo-repo\",\"full_name\":\"octo-org/octo-repo\",\"private\":true,\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"html_url\":\"https://github.com/octo-org/octo-repo\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/octo-repo\",\"forks_url\":\"https://api.github.com/repos/octo-org/octo-repo/forks\",\"keys_url\":\"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octo-org/octo-repo/teams\",\"hooks_url\":\"https://api.github.com/repos/octo-org/octo-repo/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octo-org/octo-repo/events\",\"assignees_url\":\"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/tags\",\"blobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octo-org/octo-repo/languages\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octo-org/octo-repo/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscription\",\"commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octo-org/octo-repo/merges\",\"archive_url\":\"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octo-org/octo-repo/downloads\",\"issues_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octo-org/octo-repo/deployments\"}}]}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Get a workflow run", + "scope": "actions", + "id": "getWorkflowRun", + "method": "GET", + "url": "/repos/{owner}/{repo}/actions/runs/{run_id}", + "isDeprecated": false, + "isLegacy": false, + "description": "Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.", + "documentationUrl": "https://developer.github.com/v3/actions/workflow_runs/#get-a-workflow-run", + "previews": [], + "headers": [], + "parameters": [ { - "name": "output.summary", - "description": "The summary of the check run. This parameter supports Markdown.", - "in": "BODY", + "name": "owner", + "description": "owner parameter", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -17882,35 +11649,9 @@ "deprecated": null }, { - "name": "output.text", - "description": "The details of the check run. This parameter supports Markdown.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.annotations", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://developer.github.com/v3/checks/runs/#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://help.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://developer.github.com/v3/checks/runs/#annotations-object) description for details about how to use this parameter.", - "in": "BODY", - "type": "object[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.annotations[].path", - "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "in": "BODY", + "name": "repo", + "description": "repo parameter", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -17921,22 +11662,9 @@ "deprecated": null }, { - "name": "output.annotations[].start_line", - "description": "The start line of the annotation.", - "in": "BODY", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "output.annotations[].end_line", - "description": "The end line of the annotation.", - "in": "BODY", + "name": "run_id", + "description": "run_id parameter", + "in": "PATH", "type": "integer", "required": true, "enum": null, @@ -17945,26 +11673,40 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "output.annotations[].start_column", - "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, + "code": 200, + "description": "response", + "examples": [ + { + "data": "{\"id\":30433642,\"node_id\":\"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\"head_branch\":\"master\",\"head_sha\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"run_number\":562,\"check_suite_id\":414944374,\"event\":\"push\",\"status\":\"queued\",\"conclusion\":null,\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\"html_url\":\"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\"pull_requests\":[],\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"jobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\"logs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\"artifacts_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\"cancel_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\"rerun_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\"workflow_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/30433642\",\"head_commit\":{\"id\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"tree_id\":\"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\"message\":\"Create linter.yml\",\"timestamp\":\"2020-01-22T19:33:05Z\",\"author\":{\"name\":\"Octo Cat\",\"email\":\"octocat@github.com\"},\"committer\":{\"name\":\"GitHub\",\"email\":\"noreply@github.com\"}},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\"},\"head_repository\":{\"id\":217723378,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\"name\":\"octo-repo\",\"full_name\":\"octo-org/octo-repo\",\"private\":true,\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"html_url\":\"https://github.com/octo-org/octo-repo\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/octo-repo\",\"forks_url\":\"https://api.github.com/repos/octo-org/octo-repo/forks\",\"keys_url\":\"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octo-org/octo-repo/teams\",\"hooks_url\":\"https://api.github.com/repos/octo-org/octo-repo/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octo-org/octo-repo/events\",\"assignees_url\":\"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/tags\",\"blobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octo-org/octo-repo/languages\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octo-org/octo-repo/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscription\",\"commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octo-org/octo-repo/merges\",\"archive_url\":\"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octo-org/octo-repo/downloads\",\"issues_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octo-org/octo-repo/deployments\"}}" + } + ] + } + ], + "renamed": null + }, + { + "name": "List workflow run artifacts", + "scope": "actions", + "id": "listWorkflowRunArtifacts", + "method": "GET", + "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts", + "isDeprecated": false, + "isLegacy": false, + "description": "Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.", + "documentationUrl": "https://developer.github.com/v3/actions/artifacts/#list-workflow-run-artifacts", + "previews": [], + "headers": [], + "parameters": [ { - "name": "output.annotations[].end_column", - "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "in": "BODY", - "type": "integer", - "required": false, + "name": "owner", + "description": "owner parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -17973,12 +11715,12 @@ "deprecated": null }, { - "name": "output.annotations[].annotation_level", - "description": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.", - "in": "BODY", + "name": "repo", + "description": "repo parameter", + "in": "PATH", "type": "string", "required": true, - "enum": ["notice", "warning", "failure"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -17986,10 +11728,10 @@ "deprecated": null }, { - "name": "output.annotations[].message", - "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "in": "BODY", - "type": "string", + "name": "run_id", + "description": "run_id parameter", + "in": "PATH", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -17999,10 +11741,10 @@ "deprecated": null }, { - "name": "output.annotations[].title", - "description": "The title that represents the annotation. The maximum size is 255 characters.", - "in": "BODY", - "type": "string", + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -18012,10 +11754,10 @@ "deprecated": null }, { - "name": "output.annotations[].raw_details", - "description": "Details about this annotation. The maximum size is 64 KB.", - "in": "BODY", - "type": "string", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -18023,13 +11765,40 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "output.images", - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://developer.github.com/v3/checks/runs/#images-object) description for details.", - "in": "BODY", - "type": "object[]", - "required": false, + "code": 200, + "description": "response", + "examples": [ + { + "data": "{\"total_count\":2,\"artifacts\":[{\"id\":11,\"node_id\":\"MDg6QXJ0aWZhY3QxMQ==\",\"name\":\"Rails\",\"size_in_bytes\":556,\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/5/zip\",\"expired\":\"false\",\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-01-21T14:59:22Z\"},{\"id\":13,\"node_id\":\"MDg6QXJ0aWZhY3QxMw==\",\"name\":\"\",\"size_in_bytes\":453,\"archive_download_url\":\"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/5/zip\",\"expired\":\"false\",\"created_at\":\"2020-01-10T14:59:22Z\",\"expires_at\":\"2020-01-21T14:59:22Z\"}]}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Cancel a workflow run", + "scope": "actions", + "id": "cancelWorkflowRun", + "method": "POST", + "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel", + "isDeprecated": false, + "isLegacy": false, + "description": "Cancels a workflow run using its `id`. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.", + "documentationUrl": "https://developer.github.com/v3/actions/workflow_runs/#cancel-a-workflow-run", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "owner parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -18038,9 +11807,9 @@ "deprecated": null }, { - "name": "output.images[].alt", - "description": "The alternative text for the image.", - "in": "BODY", + "name": "repo", + "description": "repo parameter", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -18051,10 +11820,10 @@ "deprecated": null }, { - "name": "output.images[].image_url", - "description": "The full URL of the image.", - "in": "BODY", - "type": "string", + "name": "run_id", + "description": "run_id parameter", + "in": "PATH", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -18062,13 +11831,30 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [], + "renamed": null + }, + { + "name": "List jobs for a workflow run", + "scope": "actions", + "id": "listJobsForWorkflowRun", + "method": "GET", + "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs", + "isDeprecated": false, + "isLegacy": false, + "description": "Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.", + "documentationUrl": "https://developer.github.com/v3/actions/workflow_jobs/#list-jobs-for-a-workflow-run", + "previews": [], + "headers": [], + "parameters": [ { - "name": "output.images[].caption", - "description": "A short image description.", - "in": "BODY", + "name": "owner", + "description": "owner parameter", + "in": "PATH", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -18077,11 +11863,11 @@ "deprecated": null }, { - "name": "actions", - "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://developer.github.com/v3/activity/events/types/#checkrunevent) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://developer.github.com/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions).\" To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions).\"", - "in": "BODY", - "type": "object[]", - "required": false, + "name": "repo", + "description": "repo parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -18090,10 +11876,10 @@ "deprecated": null }, { - "name": "actions[].label", - "description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", - "in": "BODY", - "type": "string", + "name": "run_id", + "description": "run_id parameter", + "in": "PATH", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -18103,11 +11889,11 @@ "deprecated": null }, { - "name": "actions[].description", - "description": "A short explanation of what this action would do. The maximum size is 40 characters.", - "in": "BODY", - "type": "string", - "required": true, + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -18116,11 +11902,11 @@ "deprecated": null }, { - "name": "actions[].identifier", - "description": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "in": "BODY", - "type": "string", - "required": true, + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -18131,14 +11917,11 @@ ], "responses": [ { - "code": 201, + "code": 200, "description": "response", "examples": [ { - "data": "{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"42\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"http://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"in_progress\",\"conclusion\":null,\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":null,\"output\":{\"title\":\"Mighty Readme Report\",\"summary\":\"\",\"text\":\"\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}" - }, - { - "data": "{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"http://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":\"2018-05-04T01:14:52Z\",\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}" + "data": "{\"total_count\":1,\"jobs\":[{\"id\":399444496,\"run_id\":29679449,\"run_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449\",\"node_id\":\"MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==\",\"head_sha\":\"f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496\",\"html_url\":\"https://github.com/octo-org/octo-repo/runs/399444496\",\"status\":\"completed\",\"conclusion\":\"success\",\"started_at\":\"2020-01-20T17:42:40Z\",\"completed_at\":\"2020-01-20T17:44:39Z\",\"name\":\"build\",\"steps\":[{\"name\":\"Set up job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":1,\"started_at\":\"2020-01-20T09:42:40.000-08:00\",\"completed_at\":\"2020-01-20T09:42:41.000-08:00\"},{\"name\":\"Run actions/checkout@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":2,\"started_at\":\"2020-01-20T09:42:41.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Set up Ruby\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":3,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:45.000-08:00\"},{\"name\":\"Run actions/cache@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":4,\"started_at\":\"2020-01-20T09:42:45.000-08:00\",\"completed_at\":\"2020-01-20T09:42:48.000-08:00\"},{\"name\":\"Install Bundler\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":5,\"started_at\":\"2020-01-20T09:42:48.000-08:00\",\"completed_at\":\"2020-01-20T09:42:52.000-08:00\"},{\"name\":\"Install Gems\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":6,\"started_at\":\"2020-01-20T09:42:52.000-08:00\",\"completed_at\":\"2020-01-20T09:42:53.000-08:00\"},{\"name\":\"Run Tests\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":7,\"started_at\":\"2020-01-20T09:42:53.000-08:00\",\"completed_at\":\"2020-01-20T09:42:59.000-08:00\"},{\"name\":\"Deploy to Heroku\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":8,\"started_at\":\"2020-01-20T09:42:59.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Post actions/cache@v2\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":16,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"},{\"name\":\"Complete job\",\"status\":\"completed\",\"conclusion\":\"success\",\"number\":17,\"started_at\":\"2020-01-20T09:44:39.000-08:00\",\"completed_at\":\"2020-01-20T09:44:39.000-08:00\"}],\"check_run_url\":\"https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496\"}]}" } ] } @@ -18146,22 +11929,17 @@ "renamed": null }, { - "name": "Update a check run", - "scope": "checks", - "id": "update", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}", + "name": "List workflow run logs", + "scope": "actions", + "id": "listWorkflowRunLogs", + "method": "GET", + "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/logs", "isDeprecated": false, "isLegacy": false, - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nUpdates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs.", - "documentationUrl": "https://developer.github.com/v3/checks/runs/#update-a-check-run", - "previews": [{ "name": "antiope" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.antiope-preview+json" - } - ], + "description": "Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.\n\nCall this endpoint using the `-v` flag, which enables verbose output and allows you to see the download URL in the header. To download the file into the current working directory, specify the filename using the `-o` flag.", + "documentationUrl": "https://developer.github.com/v3/actions/workflow_runs/#list-workflow-run-logs", + "previews": [], + "headers": [], "parameters": [ { "name": "owner", @@ -18190,8 +11968,8 @@ "deprecated": null }, { - "name": "check_run_id", - "description": "check_run_id parameter", + "name": "run_id", + "description": "run_id parameter", "in": "PATH", "type": "integer", "required": true, @@ -18203,10 +11981,10 @@ "deprecated": null }, { - "name": "name", - "description": "The name of the check. For example, \"code-coverage\".", - "in": "BODY", - "type": "string", + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -18216,10 +11994,10 @@ "deprecated": null }, { - "name": "details_url", - "description": "The URL of the integrator's site that has the full details of the check.", - "in": "BODY", - "type": "string", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -18227,13 +12005,30 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [], + "renamed": null + }, + { + "name": "Re-run a workflow", + "scope": "actions", + "id": "reRunWorkflow", + "method": "POST", + "url": "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun", + "isDeprecated": false, + "isLegacy": false, + "description": "Re-runs your workflow run using its `id`. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.", + "documentationUrl": "https://developer.github.com/v3/actions/workflow_runs/#re-run-a-workflow", + "previews": [], + "headers": [], + "parameters": [ { - "name": "external_id", - "description": "A reference for the run on the integrator's system.", - "in": "BODY", + "name": "owner", + "description": "owner parameter", + "in": "PATH", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -18242,11 +12037,11 @@ "deprecated": null }, { - "name": "started_at", - "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "BODY", + "name": "repo", + "description": "repo parameter", + "in": "PATH", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -18255,32 +12050,42 @@ "deprecated": null }, { - "name": "status", - "description": "The current status. Can be one of `queued`, `in_progress`, or `completed`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["queued", "in_progress", "completed"], + "name": "run_id", + "description": "run_id parameter", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [], + "renamed": null + }, + { + "name": "List secrets for a repository", + "scope": "actions", + "id": "listSecretsForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/actions/secrets", + "isDeprecated": false, + "isLegacy": false, + "description": "Lists all secrets available in a repository without revealing their encrypted values. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `secrets` permission to use this endpoint.", + "documentationUrl": "https://developer.github.com/v3/actions/secrets/#list-secrets-for-a-repository", + "previews": [], + "headers": [], + "parameters": [ { - "name": "conclusion", - "description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, or `action_required`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`.", - "in": "BODY", + "name": "owner", + "description": "owner parameter", + "in": "PATH", "type": "string", - "required": false, - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "timed_out", - "action_required" - ], + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -18288,11 +12093,11 @@ "deprecated": null }, { - "name": "completed_at", - "description": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "BODY", + "name": "repo", + "description": "repo parameter", + "in": "PATH", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -18301,10 +12106,10 @@ "deprecated": null }, { - "name": "output", - "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://developer.github.com/v3/checks/runs/#output-object-1) description.", - "in": "BODY", - "type": "object", + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -18314,10 +12119,10 @@ "deprecated": null }, { - "name": "output.title", - "description": "**Required**.", - "in": "BODY", - "type": "string", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -18325,11 +12130,38 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "output.summary", - "description": "Can contain Markdown.", - "in": "BODY", + "code": 200, + "description": "response", + "examples": [ + { + "data": "{\"total_count\":2,\"secrets\":[{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"},{\"name\":\"GIST_ID\",\"created_at\":\"2020-01-10T10:59:22Z\",\"updated_at\":\"2020-01-11T11:59:22Z\"}]}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Get your public key", + "scope": "actions", + "id": "getPublicKey", + "method": "GET", + "url": "/repos/{owner}/{repo}/actions/secrets/public-key", + "isDeprecated": false, + "isLegacy": false, + "description": "Gets your public key, which you must store. You need your public key to use other secrets endpoints. Use the returned `key` to encrypt your secrets. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `secrets` permission to use this endpoint.", + "documentationUrl": "https://developer.github.com/v3/actions/secrets/#get-your-public-key", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "owner parameter", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -18340,35 +12172,49 @@ "deprecated": null }, { - "name": "output.text", - "description": "Can contain Markdown.", - "in": "BODY", + "name": "repo", + "description": "repo parameter", + "in": "PATH", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "output.annotations", - "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://developer.github.com/v3/checks/runs/#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://help.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://developer.github.com/v3/checks/runs/#annotations-object-1) description for details.", - "in": "BODY", - "type": "object[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, + "code": 200, + "description": "response", + "examples": [ + { + "data": "{\"key_id\":\"1234\",\"key\":\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\"}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Get a secret", + "scope": "actions", + "id": "getSecret", + "method": "GET", + "url": "/repos/{owner}/{repo}/actions/secrets/{name}", + "isDeprecated": false, + "isLegacy": false, + "description": "Gets a single secret without revealing its encrypted value. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `secrets` permission to use this endpoint.", + "documentationUrl": "https://developer.github.com/v3/actions/secrets/#get-a-secret", + "previews": [], + "headers": [], + "parameters": [ { - "name": "output.annotations[].path", - "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", - "in": "BODY", + "name": "owner", + "description": "owner parameter", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -18379,10 +12225,10 @@ "deprecated": null }, { - "name": "output.annotations[].start_line", - "description": "The start line of the annotation.", - "in": "BODY", - "type": "integer", + "name": "repo", + "description": "repo parameter", + "in": "PATH", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -18392,10 +12238,10 @@ "deprecated": null }, { - "name": "output.annotations[].end_line", - "description": "The end line of the annotation.", - "in": "BODY", - "type": "integer", + "name": "name", + "description": "name parameter", + "in": "PATH", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -18405,9 +12251,9 @@ "deprecated": null }, { - "name": "output.annotations[].start_column", - "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "in": "BODY", + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", "type": "integer", "required": false, "enum": null, @@ -18418,9 +12264,9 @@ "deprecated": null }, { - "name": "output.annotations[].end_column", - "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", - "in": "BODY", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", "type": "integer", "required": false, "enum": null, @@ -18429,14 +12275,41 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "output.annotations[].annotation_level", - "description": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.", - "in": "BODY", + "code": 200, + "description": "response", + "examples": [ + { + "data": "{\"name\":\"GH_TOKEN\",\"created_at\":\"2019-08-10T14:59:22Z\",\"updated_at\":\"2020-01-10T14:59:22Z\"}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Create or update a secret for a repository", + "scope": "actions", + "id": "createOrUpdateSecretForRepo", + "method": "PUT", + "url": "/repos/{owner}/{repo}/actions/secrets/{name}", + "isDeprecated": false, + "isLegacy": false, + "description": "Creates or updates a secret with an encrypted value. Encrypt your secret using [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `secrets` permission to use this endpoint.\n\nEncrypt your secret using the [tweetsodium](https://github.com/mastahyeti/tweetsodium) library.\n\n\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3.\n\n\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n", + "documentationUrl": "https://developer.github.com/v3/actions/secrets/#create-or-update-a-secret-for-a-repository", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "owner parameter", + "in": "PATH", "type": "string", "required": true, - "enum": ["notice", "warning", "failure"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -18444,9 +12317,9 @@ "deprecated": null }, { - "name": "output.annotations[].message", - "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", - "in": "BODY", + "name": "repo", + "description": "repo parameter", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -18457,11 +12330,11 @@ "deprecated": null }, { - "name": "output.annotations[].title", - "description": "The title that represents the annotation. The maximum size is 255 characters.", - "in": "BODY", + "name": "name", + "description": "name parameter", + "in": "PATH", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -18470,8 +12343,8 @@ "deprecated": null }, { - "name": "output.annotations[].raw_details", - "description": "Details about this annotation. The maximum size is 64 KB.", + "name": "encrypted_value", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get your public key](https://developer.github.com/v3/actions/secrets/#get-your-public-key) endpoint.", "in": "BODY", "type": "string", "required": false, @@ -18483,10 +12356,10 @@ "deprecated": null }, { - "name": "output.images", - "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://developer.github.com/v3/checks/runs/#annotations-object-1) description for details.", + "name": "key_id", + "description": "ID of the key you used to encrypt the secret.", "in": "BODY", - "type": "object[]", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -18494,11 +12367,28 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [], + "renamed": null + }, + { + "name": "Delete a secret from a repository", + "scope": "actions", + "id": "deleteSecretFromRepo", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/actions/secrets/{name}", + "isDeprecated": false, + "isLegacy": false, + "description": "Deletes a secret in a repository using the secret name. Anyone with write access to the repository can use this endpoint. GitHub Apps must have the `secrets` permission to use this endpoint.", + "documentationUrl": "https://developer.github.com/v3/actions/secrets/#delete-a-secret-from-a-repository", + "previews": [], + "headers": [], + "parameters": [ { - "name": "output.images[].alt", - "description": "The alternative text for the image.", - "in": "BODY", + "name": "owner", + "description": "owner parameter", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -18509,9 +12399,9 @@ "deprecated": null }, { - "name": "output.images[].image_url", - "description": "The full URL of the image.", - "in": "BODY", + "name": "repo", + "description": "repo parameter", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -18522,24 +12412,41 @@ "deprecated": null }, { - "name": "output.images[].caption", - "description": "A short image description.", - "in": "BODY", + "name": "name", + "description": "name parameter", + "in": "PATH", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [], + "renamed": null + }, + { + "name": "List repository workflows", + "scope": "actions", + "id": "listRepoWorkflows", + "method": "GET", + "url": "/repos/{owner}/{repo}/actions/workflows", + "isDeprecated": false, + "isLegacy": false, + "description": "Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.", + "documentationUrl": "https://developer.github.com/v3/actions/workflows/#list-repository-workflows", + "previews": [], + "headers": [], + "parameters": [ { - "name": "actions", - "description": "Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://developer.github.com/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions).\"", - "in": "BODY", - "type": "object[]", - "required": false, + "name": "owner", + "description": "owner parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -18548,9 +12455,9 @@ "deprecated": null }, { - "name": "actions[].label", - "description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", - "in": "BODY", + "name": "repo", + "description": "repo parameter", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -18561,11 +12468,11 @@ "deprecated": null }, { - "name": "actions[].description", - "description": "A short explanation of what this action would do. The maximum size is 40 characters.", - "in": "BODY", - "type": "string", - "required": true, + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -18574,11 +12481,11 @@ "deprecated": null }, { - "name": "actions[].identifier", - "description": "A reference for the action on the integrator's system. The maximum size is 20 characters.", - "in": "BODY", - "type": "string", - "required": true, + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -18593,7 +12500,7 @@ "description": "response", "examples": [ { - "data": "{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"http://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":\"2018-05-04T01:14:52Z\",\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}" + "data": "{\"total_count\":2,\"workflows\":[{\"id\":161335,\"node_id\":\"MDg6V29ya2Zsb3cxNjEzMzU=\",\"name\":\"CI\",\"path\":\".github/workflows/blank.yml\",\"state\":\"active\",\"created_at\":\"2020-01-08T23:48:37.000-08:00\",\"updated_at\":\"2020-01-08T23:50:21.000-08:00\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335\",\"html_url\":\"https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335\",\"badge_url\":\"https://github.com/octo-org/octo-repo/workflows/CI/badge.svg\"},{\"id\":269289,\"node_id\":\"MDE4OldvcmtmbG93IFNlY29uZGFyeTI2OTI4OQ==\",\"name\":\"Linter\",\"path\":\".github/workflows/linter.yml\",\"state\":\"active\",\"created_at\":\"2020-01-08T23:48:37.000-08:00\",\"updated_at\":\"2020-01-08T23:50:21.000-08:00\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/269289\",\"html_url\":\"https://github.com/octo-org/octo-repo/blob/master/.github/workflows/269289\",\"badge_url\":\"https://github.com/octo-org/octo-repo/workflows/Linter/badge.svg\"}]}" } ] } @@ -18601,22 +12508,17 @@ "renamed": null }, { - "name": "Get a single check run", - "scope": "checks", - "id": "get", + "name": "Get a workflow", + "scope": "actions", + "id": "getWorkflow", "method": "GET", - "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}", + "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}", "isDeprecated": false, "isLegacy": false, - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nGets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.", - "documentationUrl": "https://developer.github.com/v3/checks/runs/#get-a-single-check-run", - "previews": [{ "name": "antiope" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.antiope-preview+json" - } - ], + "description": "Gets a specific workflow. You can also replace `:workflow_id` with `:workflow_file_name`. For example, you could use `main.yml`. Anyone with read access to the repository can use this endpoint. GitHub Apps must have the `actions` permission to use this endpoint.", + "documentationUrl": "https://developer.github.com/v3/actions/workflows/#get-a-workflow", + "previews": [], + "headers": [], "parameters": [ { "name": "owner", @@ -18645,8 +12547,8 @@ "deprecated": null }, { - "name": "check_run_id", - "description": "check_run_id parameter", + "name": "workflow_id", + "description": "workflow_id parameter", "in": "PATH", "type": "integer", "required": true, @@ -18664,7 +12566,7 @@ "description": "response", "examples": [ { - "data": "{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"http://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":\"2018-05-04T01:14:52Z\",\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}" + "data": "{\"id\":161335,\"node_id\":\"MDg6V29ya2Zsb3cxNjEzMzU=\",\"name\":\"CI\",\"path\":\".github/workflows/blank.yml\",\"state\":\"active\",\"created_at\":\"2020-01-08T23:48:37.000-08:00\",\"updated_at\":\"2020-01-08T23:50:21.000-08:00\",\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335\",\"html_url\":\"https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335\",\"badge_url\":\"https://github.com/octo-org/octo-repo/workflows/CI/badge.svg\"}" } ] } @@ -18672,22 +12574,17 @@ "renamed": null }, { - "name": "List annotations for a check run", - "scope": "checks", - "id": "listAnnotations", + "name": "List workflow runs", + "scope": "actions", + "id": "listWorkflowRuns", "method": "GET", - "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations", + "url": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs", "isDeprecated": false, "isLegacy": false, - "description": "Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository.", - "documentationUrl": "https://developer.github.com/v3/checks/runs/#list-annotations-for-a-check-run", - "previews": [{ "name": "antiope" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.antiope-preview+json" - } - ], + "description": "List all workflow runs for a workflow. You can also replace `:workflow_id` with `:workflow_file_name`. For example, you could use `main.yml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://developer.github.com/v3/#parameters).\n\nAnyone with read access to the repository can use this endpoint.", + "documentationUrl": "https://developer.github.com/v3/actions/workflow_runs/#list-workflow-runs", + "previews": [], + "headers": [], "parameters": [ { "name": "owner", @@ -18716,8 +12613,8 @@ "deprecated": null }, { - "name": "check_run_id", - "description": "check_run_id parameter", + "name": "workflow_id", + "description": "workflow_id parameter", "in": "PATH", "type": "integer", "required": true, @@ -18729,10 +12626,10 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", + "name": "actor", + "description": "Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run.", "in": "QUERY", - "type": "integer", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -18742,10 +12639,10 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", + "name": "branch", + "description": "Returns workflow runs associated with a branch. Use the name of the branch of the `push`.", "in": "QUERY", - "type": "integer", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -18753,45 +12650,13 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"path\":\"README.md\",\"start_line\":2,\"end_line\":2,\"start_column\":5,\"end_column\":10,\"annotation_level\":\"warning\",\"title\":\"Spell Checker\",\"message\":\"Check your spelling for 'banaas'.\",\"raw_details\":\"Do you mean 'bananas' or 'banana'?\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a check suite", - "scope": "checks", - "id": "createSuite", - "method": "POST", - "url": "/repos/{owner}/{repo}/check-suites", - "isDeprecated": false, - "isLegacy": false, - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nBy default, check suites are automatically created when you create a [check run](https://developer.github.com/v3/checks/runs/). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"[Set preferences for check suites on a repository](https://developer.github.com/v3/checks/suites/#set-preferences-for-check-suites-on-a-repository)\". Your GitHub App must have the `checks:write` permission to create check suites.", - "documentationUrl": "https://developer.github.com/v3/checks/suites/#create-a-check-suite", - "previews": [{ "name": "antiope" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.antiope-preview+json" - } - ], - "parameters": [ + }, { - "name": "owner", - "description": "owner parameter", - "in": "PATH", + "name": "event", + "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows)\" in the GitHub Help documentation.", + "in": "QUERY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -18800,11 +12665,24 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "status", + "description": "Returns workflow runs associated with the check run `status` or `conclusion` you specify. For example, a conclusion can be `success` or a status can be `completed`. For more information, see the `status` and `conclusion` options available in \"[Create a check run](https://developer.github.com/v3/checks/runs/#create-a-check-run).\"", + "in": "QUERY", "type": "string", - "required": true, + "required": false, + "enum": ["completed", "status", "conclusion"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -18813,11 +12691,11 @@ "deprecated": null }, { - "name": "head_sha", - "description": "The sha of the head commit.", - "in": "BODY", - "type": "string", - "required": true, + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -18828,11 +12706,11 @@ ], "responses": [ { - "code": 201, + "code": 200, "description": "response", "examples": [ { - "data": "{\"id\":5,\"node_id\":\"MDEwOkNoZWNrU3VpdGU1\",\"head_branch\":\"master\",\"head_sha\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"url\":\"https://api.github.com/repos/github/hello-world/check-suites/5\",\"before\":\"146e867f55c26428e5f9fade55a9bbf5e95a7912\",\"after\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"pull_requests\":[],\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}" + "data": "{\"total_count\":1,\"workflow_runs\":[{\"id\":30433642,\"node_id\":\"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\"head_branch\":\"master\",\"head_sha\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"run_number\":562,\"check_suite_id\":414944374,\"event\":\"push\",\"status\":\"queued\",\"conclusion\":null,\"url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\"html_url\":\"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\"pull_requests\":[],\"created_at\":\"2020-01-22T19:33:08Z\",\"updated_at\":\"2020-01-22T19:33:08Z\",\"jobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\"logs_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\"artifacts_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\"cancel_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\"rerun_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\"workflow_url\":\"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/30433642\",\"head_commit\":{\"id\":\"acb5820ced9479c074f688cc328bf03f341a511d\",\"tree_id\":\"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\"message\":\"Create linter.yml\",\"timestamp\":\"2020-01-22T19:33:05Z\",\"author\":{\"name\":\"Octo Cat\",\"email\":\"octocat@github.com\"},\"committer\":{\"name\":\"GitHub\",\"email\":\"noreply@github.com\"}},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\"},\"head_repository\":{\"id\":217723378,\"node_id\":\"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\"name\":\"octo-repo\",\"full_name\":\"octo-org/octo-repo\",\"private\":true,\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"html_url\":\"https://github.com/octo-org/octo-repo\",\"description\":null,\"fork\":false,\"url\":\"https://api.github.com/repos/octo-org/octo-repo\",\"forks_url\":\"https://api.github.com/repos/octo-org/octo-repo/forks\",\"keys_url\":\"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octo-org/octo-repo/teams\",\"hooks_url\":\"https://api.github.com/repos/octo-org/octo-repo/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octo-org/octo-repo/events\",\"assignees_url\":\"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/tags\",\"blobs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octo-org/octo-repo/languages\",\"stargazers_url\":\"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octo-org/octo-repo/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octo-org/octo-repo/subscription\",\"commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octo-org/octo-repo/merges\",\"archive_url\":\"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octo-org/octo-repo/downloads\",\"issues_url\":\"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octo-org/octo-repo/deployments\"}}]}" } ] } @@ -18840,22 +12718,17 @@ "renamed": null }, { - "name": "Set preferences for check suites on a repository", - "scope": "checks", - "id": "setSuitesPreferences", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/check-suites/preferences", + "name": "List assignees", + "scope": "issues", + "id": "listAssignees", + "method": "GET", + "url": "/repos/{owner}/{repo}/assignees", "isDeprecated": false, "isLegacy": false, - "description": "Changes the default automatic flow when creating check suites. By default, the CheckSuiteEvent is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://developer.github.com/v3/checks/suites/#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites.", - "documentationUrl": "https://developer.github.com/v3/checks/suites/#set-preferences-for-check-suites-on-a-repository", - "previews": [{ "name": "antiope" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.antiope-preview+json" - } - ], + "description": "Lists the [available assignees](https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository.", + "documentationUrl": "https://developer.github.com/v3/issues/assignees/#list-assignees", + "previews": [], + "headers": [], "parameters": [ { "name": "owner", @@ -18884,10 +12757,10 @@ "deprecated": null }, { - "name": "auto_trigger_checks", - "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://developer.github.com/v3/checks/suites/#auto_trigger_checks-object) description for details.", - "in": "BODY", - "type": "object[]", + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -18897,24 +12770,11 @@ "deprecated": null }, { - "name": "auto_trigger_checks[].app_id", - "description": "The `id` of the GitHub App.", - "in": "BODY", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "auto_trigger_checks[].setting", - "description": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", - "in": "BODY", - "type": "boolean", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -18929,7 +12789,7 @@ "description": "response", "examples": [ { - "data": "{\"preferences\":{\"auto_trigger_checks\":[{\"app_id\":2,\"setting\":true},{\"app_id\":4,\"setting\":false}]},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}" + "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" } ] } @@ -18937,22 +12797,17 @@ "renamed": null }, { - "name": "Get a single check suite", - "scope": "checks", - "id": "getSuite", + "name": "Check assignee", + "scope": "issues", + "id": "checkAssignee", "method": "GET", - "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}", + "url": "/repos/{owner}/{repo}/assignees/{assignee}", "isDeprecated": false, "isLegacy": false, - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nGets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository.", - "documentationUrl": "https://developer.github.com/v3/checks/suites/#get-a-single-check-suite", - "previews": [{ "name": "antiope" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.antiope-preview+json" - } - ], + "description": "Checks if a user has permission to be assigned to an issue in this repository.\n\nIf the `assignee` can be assigned to issues in the repository, a `204` header with no content is returned.\n\nOtherwise a `404` status code is returned.", + "documentationUrl": "https://developer.github.com/v3/issues/assignees/#check-assignee", + "previews": [], + "headers": [], "parameters": [ { "name": "owner", @@ -18981,10 +12836,10 @@ "deprecated": null }, { - "name": "check_suite_id", - "description": "check_suite_id parameter", + "name": "assignee", + "description": "assignee parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -18994,34 +12849,25 @@ "deprecated": null } ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"id\":5,\"node_id\":\"MDEwOkNoZWNrU3VpdGU1\",\"head_branch\":\"master\",\"head_sha\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"url\":\"https://api.github.com/repos/github/hello-world/check-suites/5\",\"before\":\"146e867f55c26428e5f9fade55a9bbf5e95a7912\",\"after\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"pull_requests\":[],\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}" - } - ] - } - ], + "responses": [], "renamed": null }, { - "name": "List check runs in a check suite", - "scope": "checks", - "id": "listForSuite", - "method": "GET", - "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", + "name": "Enable automated security fixes", + "scope": "repos", + "id": "enableAutomatedSecurityFixes", + "method": "PUT", + "url": "/repos/{owner}/{repo}/automated-security-fixes", "isDeprecated": false, "isLegacy": false, - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.", - "documentationUrl": "https://developer.github.com/v3/checks/runs/#list-check-runs-in-a-check-suite", - "previews": [{ "name": "antiope" }], + "description": "Enables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Configuring automated security fixes](https://help.github.com/en/articles/configuring-automated-security-fixes)\" in the GitHub Help documentation.", + "documentationUrl": "https://developer.github.com/v3/repos/#enable-automated-security-fixes", + "previews": [{ "name": "london" }], "headers": [ { "name": "accept", - "value": "application/vnd.github.antiope-preview+json" + "value": "application/vnd.github.london-preview+json", + "required": true } ], "parameters": [ @@ -19050,12 +12896,35 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [], + "renamed": null + }, + { + "name": "Disable automated security fixes", + "scope": "repos", + "id": "disableAutomatedSecurityFixes", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/automated-security-fixes", + "isDeprecated": false, + "isLegacy": false, + "description": "Disables automated security fixes for a repository. The authenticated user must have admin access to the repository. For more information, see \"[Configuring automated security fixes](https://help.github.com/en/articles/configuring-automated-security-fixes)\" in the GitHub Help documentation.", + "documentationUrl": "https://developer.github.com/v3/repos/#disable-automated-security-fixes", + "previews": [{ "name": "london" }], + "headers": [ { - "name": "check_suite_id", - "description": "check_suite_id parameter", + "name": "accept", + "value": "application/vnd.github.london-preview+json", + "required": true + } + ], + "parameters": [ + { + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -19065,11 +12934,41 @@ "deprecated": null }, { - "name": "check_name", - "description": "Returns check runs with the specified `name`.", - "in": "QUERY", + "name": "repo", + "description": "repo parameter", + "in": "PATH", "type": "string", - "required": false, + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [], + "renamed": null + }, + { + "name": "List branches", + "scope": "repos", + "id": "listBranches", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches", + "isDeprecated": false, + "isLegacy": false, + "description": "", + "documentationUrl": "https://developer.github.com/v3/repos/branches/#list-branches", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "owner parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -19078,12 +12977,12 @@ "deprecated": null }, { - "name": "status", - "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`.", - "in": "QUERY", + "name": "repo", + "description": "repo parameter", + "in": "PATH", "type": "string", - "required": false, - "enum": ["queued", "in_progress", "completed"], + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -19091,12 +12990,12 @@ "deprecated": null }, { - "name": "filter", - "description": "Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`.", + "name": "protected", + "description": "Setting to `true` returns only protected branches. When set to `false`, only unprotected branches are returned. Omitting this parameter returns all branches.", "in": "QUERY", - "type": "string", + "type": "boolean", "required": false, - "enum": ["latest", "all"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -19136,7 +13035,7 @@ "description": "response", "examples": [ { - "data": "{\"total_count\":1,\"check_runs\":[{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"http://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":\"2018-05-04T01:14:52Z\",\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}]}" + "data": "[{\"name\":\"master\",\"commit\":{\"sha\":\"c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\"},\"protected\":true,\"protection\":{\"enabled\":true,\"required_status_checks\":{\"enforcement_level\":\"non_admins\",\"contexts\":[\"ci-test\",\"linter\"]}},\"protection_url\":\"https://api.github.com/repos/octocat/hello-world/branches/master/protection\"}]" } ] } @@ -19144,22 +13043,17 @@ "renamed": null }, { - "name": "Rerequest check suite", - "scope": "checks", - "id": "rerequestSuite", - "method": "POST", - "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest", + "name": "Get branch", + "scope": "repos", + "id": "getBranch", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}", "isDeprecated": false, "isLegacy": false, - "description": "Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://developer.github.com/v3/activity/events/types/#checksuiteevent) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nTo rerequest a check suite, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.", - "documentationUrl": "https://developer.github.com/v3/checks/suites/#rerequest-check-suite", - "previews": [{ "name": "antiope" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.antiope-preview+json" - } - ], + "description": "", + "documentationUrl": "https://developer.github.com/v3/repos/branches/#get-branch", + "previews": [], + "headers": [], "parameters": [ { "name": "owner", @@ -19188,10 +13082,10 @@ "deprecated": null }, { - "name": "check_suite_id", - "description": "check_suite_id parameter", + "name": "branch", + "description": "branch parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -19201,19 +13095,29 @@ "deprecated": null } ], - "responses": [], + "responses": [ + { + "code": 200, + "description": "response", + "examples": [ + { + "data": "{\"name\":\"master\",\"commit\":{\"sha\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"node_id\":\"MDY6Q29tbWl0N2ZkMWE2MGIwMWY5MWIzMTRmNTk5NTVhNGU0ZDRlODBkOGVkZjExZA==\",\"commit\":{\"author\":{\"name\":\"The Octocat\",\"date\":\"2012-03-06T15:06:50-08:00\",\"email\":\"octocat@nowhere.com\"},\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"message\":\"Merge pull request #6 from Spaceghost/patch-1\\n\\nNew line at end of file.\",\"tree\":{\"sha\":\"b4eecafa9be2f2006ce1b709d6857b07069b4608\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608\"},\"committer\":{\"name\":\"The Octocat\",\"date\":\"2012-03-06T15:06:50-08:00\",\"email\":\"octocat@nowhere.com\"},\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"author\":{\"gravatar_id\":\"\",\"avatar_url\":\"https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png\",\"url\":\"https://api.github.com/users/octocat\",\"id\":583231,\"login\":\"octocat\"},\"parents\":[{\"sha\":\"553c2077f0edc3d5dc5d17262f6aa498e69d6f8e\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e\"},{\"sha\":\"762941318ee16e59dabbacb1b4049eec22f0d303\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303\"}],\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"committer\":{\"gravatar_id\":\"\",\"avatar_url\":\"https://secure.gravatar.com/avatar/7ad39074b0584bc555d0417ae3e7d974?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-140.png\",\"url\":\"https://api.github.com/users/octocat\",\"id\":583231,\"login\":\"octocat\"}},\"_links\":{\"html\":\"https://github.com/octocat/Hello-World/tree/master\",\"self\":\"https://api.github.com/repos/octocat/Hello-World/branches/master\"},\"protected\":true,\"protection\":{\"enabled\":true,\"required_status_checks\":{\"enforcement_level\":\"non_admins\",\"contexts\":[\"ci-test\",\"linter\"]}},\"protection_url\":\"https://api.github.com/repos/octocat/hello-world/branches/master/protection\"}" + } + ] + } + ], "renamed": null }, { - "name": "List collaborators", + "name": "Get branch protection", "scope": "repos", - "id": "listCollaborators", + "id": "getBranchProtection", "method": "GET", - "url": "/repos/{owner}/{repo}/collaborators", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection", "isDeprecated": false, "isLegacy": false, - "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\n\nTeam members will include the members of child teams.", - "documentationUrl": "https://developer.github.com/v3/repos/collaborators/#list-collaborators", + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://developer.github.com/v3/repos/branches/#get-branch-protection", "previews": [], "headers": [], "parameters": [ @@ -19244,37 +13148,11 @@ "deprecated": null }, { - "name": "affiliation", - "description": "Filter collaborators returned by their affiliation. Can be one of: \n\\* `outside`: All outside collaborators of an organization-owned repository. \n\\* `direct`: All collaborators with permissions to an organization-owned repository, regardless of organization membership status. \n\\* `all`: All collaborators the authenticated user can see.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["outside", "direct", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "branch", + "description": "branch parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -19289,7 +13167,7 @@ "description": "response", "examples": [ { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false,\"permissions\":{\"pull\":true,\"push\":true,\"admin\":false}}]" + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection\",\"required_status_checks\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks\",\"strict\":true,\"contexts\":[\"continuous-integration/travis-ci\"],\"contexts_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts\"},\"enforce_admins\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins\",\"enabled\":true},\"required_pull_request_reviews\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews\",\"dismissal_restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":2},\"restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams\",\"apps_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"apps\":[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]},\"required_linear_history\":{\"enabled\":true},\"allow_force_pushes\":{\"enabled\":true},\"allow_deletions\":{\"enabled\":true}}" } ] } @@ -19297,15 +13175,15 @@ "renamed": null }, { - "name": "Check if a user is a collaborator", + "name": "Update branch protection", "scope": "repos", - "id": "checkCollaborator", - "method": "GET", - "url": "/repos/{owner}/{repo}/collaborators/{username}", + "id": "updateBranchProtection", + "method": "PUT", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection", "isDeprecated": false, "isLegacy": false, - "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\n\nTeam members will include the members of child teams.", - "documentationUrl": "https://developer.github.com/v3/repos/collaborators/#check-if-a-user-is-a-collaborator", + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nProtecting a branch requires admin or owner permissions to the repository.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.\n\n**Note**: The list of users, apps, and teams in total is limited to 100 items.", + "documentationUrl": "https://developer.github.com/v3/repos/branches/#update-branch-protection", "previews": [], "headers": [], "parameters": [ @@ -19336,8 +13214,8 @@ "deprecated": null }, { - "name": "username", - "description": "username parameter", + "name": "branch", + "description": "branch parameter", "in": "PATH", "type": "string", "required": true, @@ -19347,42 +13225,25 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "Add user as a collaborator", - "scope": "repos", - "id": "addCollaborator", - "method": "PUT", - "url": "/repos/{owner}/{repo}/collaborators/{username}", - "isDeprecated": false, - "isLegacy": false, - "description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://developer.github.com/v3/repos/invitations/).\n\n**Rate limits**\n\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", - "documentationUrl": "https://developer.github.com/v3/repos/collaborators/#add-user-as-a-collaborator", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "owner", - "description": "owner parameter", - "in": "PATH", - "type": "string", + "name": "required_status_checks", + "description": "Require status checks to pass before merging. Set to `null` to disable.", + "in": "BODY", + "type": "object", "required": true, "enum": null, - "allowNull": false, + "allowNull": true, "mapToData": null, "validation": null, "alias": null, "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", - "type": "string", + "name": "required_status_checks.strict", + "description": "Require branches to be up to date before merging.", + "in": "BODY", + "type": "boolean", "required": true, "enum": null, "allowNull": false, @@ -19392,10 +13253,10 @@ "deprecated": null }, { - "name": "username", - "description": "username parameter", - "in": "PATH", - "type": "string", + "name": "required_status_checks.contexts", + "description": "The list of status checks to require in order to merge into this branch", + "in": "BODY", + "type": "string[]", "required": true, "enum": null, "allowNull": false, @@ -19405,51 +13266,63 @@ "deprecated": null }, { - "name": "permission", - "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository.", + "name": "enforce_admins", + "description": "Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable.", "in": "BODY", - "type": "string", + "type": "boolean", + "required": true, + "enum": null, + "allowNull": true, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "required_pull_request_reviews", + "description": "Require at least one approving review on a pull request, before merging. Set to `null` to disable.", + "in": "BODY", + "type": "object", + "required": true, + "enum": null, + "allowNull": true, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "required_pull_request_reviews.dismissal_restrictions", + "description": "Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", + "in": "BODY", + "type": "object", "required": false, - "enum": ["pull", "push", "admin"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ + }, { - "code": 201, - "description": "Response when a new invitation is created", - "examples": [ - { - "data": "{\"id\":1,\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\"},\"invitee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"inviter\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"permissions\":\"write\",\"created_at\":\"2016-06-13T14:52:50-05:00\",\"url\":\"https://api.github.com/user/repository_invitations/1296269\",\"html_url\":\"https://github.com/octocat/Hello-World/invitations\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Remove user as a collaborator", - "scope": "repos", - "id": "removeCollaborator", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/collaborators/{username}", - "isDeprecated": false, - "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/repos/collaborators/#remove-user-as-a-collaborator", - "previews": [], - "headers": [], - "parameters": [ + "name": "required_pull_request_reviews.dismissal_restrictions.users", + "description": "The list of user `login`s with dismissal access", + "in": "BODY", + "type": "string[]", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { - "name": "owner", - "description": "owner parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "required_pull_request_reviews.dismissal_restrictions.teams", + "description": "The list of team `slug`s with dismissal access", + "in": "BODY", + "type": "string[]", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -19458,11 +13331,11 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "required_pull_request_reviews.dismiss_stale_reviews", + "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", + "in": "BODY", + "type": "boolean", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -19471,41 +13344,24 @@ "deprecated": null }, { - "name": "username", - "description": "username parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "required_pull_request_reviews.require_code_owner_reviews", + "description": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) review them.", + "in": "BODY", + "type": "boolean", + "required": false, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "Review a user's permission level", - "scope": "repos", - "id": "getCollaboratorPermissionLevel", - "method": "GET", - "url": "/repos/{owner}/{repo}/collaborators/{username}/permission", - "isDeprecated": false, - "isLegacy": false, - "description": "Possible values for the `permission` key: `admin`, `write`, `read`, `none`.", - "documentationUrl": "https://developer.github.com/v3/repos/collaborators/#review-a-users-permission-level", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "owner", - "description": "owner parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "required_pull_request_reviews.required_approving_review_count", + "description": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.", + "in": "BODY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -19514,23 +13370,23 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", - "type": "string", + "name": "restrictions", + "description": "Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable.", + "in": "BODY", + "type": "object", "required": true, "enum": null, - "allowNull": false, + "allowNull": true, "mapToData": null, "validation": null, "alias": null, "deprecated": null }, { - "name": "username", - "description": "username parameter", - "in": "PATH", - "type": "string", + "name": "restrictions.users", + "description": "The list of user `login`s with push access", + "in": "BODY", + "type": "string[]", "required": true, "enum": null, "allowNull": false, @@ -19538,39 +13394,12 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response if user has admin permissions", - "examples": [ - { - "data": "{\"permission\":\"admin\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List commit comments for a repository", - "scope": "repos", - "id": "listCommitComments", - "method": "GET", - "url": "/repos/{owner}/{repo}/comments", - "isDeprecated": false, - "isLegacy": false, - "description": "Commit Comments use [these custom media types](https://developer.github.com/v3/repos/comments/#custom-media-types). You can read more about the use of media types in the API [here](https://developer.github.com/v3/media/).\n\nComments are ordered by ascending ID.\n\n", - "documentationUrl": "https://developer.github.com/v3/repos/comments/#list-commit-comments-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "owner", - "description": "owner parameter", - "in": "PATH", - "type": "string", + "name": "restrictions.teams", + "description": "The list of team `slug`s with push access", + "in": "BODY", + "type": "string[]", "required": true, "enum": null, "allowNull": false, @@ -19580,11 +13409,11 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "restrictions.apps", + "description": "The list of app `slug`s with push access", + "in": "BODY", + "type": "string[]", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -19593,10 +13422,10 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", + "name": "required_linear_history", + "description": "Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see \"[Requiring a linear commit history](https://help.github.com/github/administering-a-repository/requiring-a-linear-commit-history)\" in the GitHub Help documentation.", + "in": "BODY", + "type": "boolean", "required": false, "enum": null, "allowNull": false, @@ -19606,10 +13435,23 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", + "name": "allow_force_pushes", + "description": "Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://help.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.\"", + "in": "BODY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": true, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "allow_deletions", + "description": "Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see \"[Enabling force pushes to a protected branch](https://help.github.com/en/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)\" in the GitHub Help documentation.", + "in": "BODY", + "type": "boolean", "required": false, "enum": null, "allowNull": false, @@ -19625,7 +13467,7 @@ "description": "response", "examples": [ { - "data": "[{\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/comments/1\",\"id\":1,\"node_id\":\"MDEzOkNvbW1pdENvbW1lbnQx\",\"body\":\"Great stuff\",\"path\":\"file1.txt\",\"position\":4,\"line\":14,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}]" + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection\",\"required_status_checks\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks\",\"strict\":true,\"contexts\":[\"continuous-integration/travis-ci\"],\"contexts_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts\"},\"enforce_admins\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins\",\"enabled\":true},\"required_pull_request_reviews\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews\",\"dismissal_restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":2},\"restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams\",\"apps_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"apps\":[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]},\"required_linear_history\":{\"enabled\":true},\"allow_force_pushes\":{\"enabled\":true},\"allow_deletions\":{\"enabled\":true}}" } ] } @@ -19633,15 +13475,15 @@ "renamed": null }, { - "name": "Get a single commit comment", + "name": "Remove branch protection", "scope": "repos", - "id": "getCommitComment", - "method": "GET", - "url": "/repos/{owner}/{repo}/comments/{comment_id}", + "id": "removeBranchProtection", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/repos/comments/#get-a-single-commit-comment", + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://developer.github.com/v3/repos/branches/#remove-branch-protection", "previews": [], "headers": [], "parameters": [ @@ -19672,10 +13514,10 @@ "deprecated": null }, { - "name": "comment_id", - "description": "comment_id parameter", + "name": "branch", + "description": "branch parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -19685,29 +13527,19 @@ "deprecated": null } ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/comments/1\",\"id\":1,\"node_id\":\"MDEzOkNvbW1pdENvbW1lbnQx\",\"body\":\"Great stuff\",\"path\":\"file1.txt\",\"position\":4,\"line\":14,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}" - } - ] - } - ], + "responses": [], "renamed": null }, { - "name": "Update a commit comment", + "name": "Get admin enforcement of protected branch", "scope": "repos", - "id": "updateCommitComment", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/comments/{comment_id}", + "id": "getProtectedBranchAdminEnforcement", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/repos/comments/#update-a-commit-comment", + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://developer.github.com/v3/repos/branches/#get-admin-enforcement-of-protected-branch", "previews": [], "headers": [], "parameters": [ @@ -19738,22 +13570,9 @@ "deprecated": null }, { - "name": "comment_id", - "description": "comment_id parameter", + "name": "branch", + "description": "branch parameter", "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The contents of the comment", - "in": "BODY", "type": "string", "required": true, "enum": null, @@ -19770,7 +13589,7 @@ "description": "response", "examples": [ { - "data": "{\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/comments/1\",\"id\":1,\"node_id\":\"MDEzOkNvbW1pdENvbW1lbnQx\",\"body\":\"Nice change\",\"path\":\"file1.txt\",\"position\":4,\"line\":14,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}" + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins\",\"enabled\":true}" } ] } @@ -19778,15 +13597,15 @@ "renamed": null }, { - "name": "Delete a commit comment", + "name": "Add admin enforcement of protected branch", "scope": "repos", - "id": "deleteCommitComment", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/comments/{comment_id}", + "id": "addProtectedBranchAdminEnforcement", + "method": "POST", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/repos/comments/#delete-a-commit-comment", + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", + "documentationUrl": "https://developer.github.com/v3/repos/branches/#add-admin-enforcement-of-protected-branch", "previews": [], "headers": [], "parameters": [ @@ -19817,10 +13636,10 @@ "deprecated": null }, { - "name": "comment_id", - "description": "comment_id parameter", + "name": "branch", + "description": "branch parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -19830,26 +13649,31 @@ "deprecated": null } ], - "responses": [], + "responses": [ + { + "code": 200, + "description": "response", + "examples": [ + { + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/enforce_admins\",\"enabled\":true}" + } + ] + } + ], "renamed": null }, { - "name": "List reactions for a commit comment", - "scope": "reactions", - "id": "listForCommitComment", - "method": "GET", - "url": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", + "name": "Remove admin enforcement of protected branch", + "scope": "repos", + "id": "removeProtectedBranchAdminEnforcement", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins", "isDeprecated": false, "isLegacy": false, - "description": "List the reactions to a [commit comment](https://developer.github.com/v3/repos/comments/).", - "documentationUrl": "https://developer.github.com/v3/reactions/#list-reactions-for-a-commit-comment", - "previews": [{ "name": "squirrel-girl" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.squirrel-girl-preview+json" - } - ], + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoving admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", + "documentationUrl": "https://developer.github.com/v3/repos/branches/#remove-admin-enforcement-of-protected-branch", + "previews": [], + "headers": [], "parameters": [ { "name": "owner", @@ -19878,59 +13702,11 @@ "deprecated": null }, { - "name": "comment_id", - "description": "comment_id parameter", + "name": "branch", + "description": "branch parameter", "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a commit comment.", - "in": "QUERY", "type": "string", - "required": false, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -19939,36 +13715,21 @@ "deprecated": null } ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" - } - ] - } - ], + "responses": [], "renamed": null }, { - "name": "Create reaction for a commit comment", - "scope": "reactions", - "id": "createForCommitComment", - "method": "POST", - "url": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", + "name": "Get pull request review enforcement of protected branch", + "scope": "repos", + "id": "getProtectedBranchPullRequestReviewEnforcement", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", "isDeprecated": false, "isLegacy": false, - "description": "Create a reaction to a [commit comment](https://developer.github.com/v3/repos/comments/). A response with a `Status: 200 OK` means that you already added the reaction type to this commit comment.", - "documentationUrl": "https://developer.github.com/v3/reactions/#create-reaction-for-a-commit-comment", - "previews": [{ "name": "squirrel-girl" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.squirrel-girl-preview+json" - } - ], + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://developer.github.com/v3/repos/branches/#get-pull-request-review-enforcement-of-protected-branch", + "previews": [], + "headers": [], "parameters": [ { "name": "owner", @@ -19997,34 +13758,12 @@ "deprecated": null }, { - "name": "comment_id", - "description": "comment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the commit comment.", - "in": "BODY", + "name": "branch", + "description": "branch parameter", + "in": "PATH", "type": "string", "required": true, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -20034,11 +13773,11 @@ ], "responses": [ { - "code": 201, + "code": 200, "description": "response", "examples": [ { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews\",\"dismissal_restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":2}" } ] } @@ -20046,15 +13785,15 @@ "renamed": null }, { - "name": "List commits on a repository", + "name": "Update pull request review enforcement of protected branch", "scope": "repos", - "id": "listCommits", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits", + "id": "updateProtectedBranchPullRequestReviewEnforcement", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", "isDeprecated": false, "isLegacy": false, - "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", - "documentationUrl": "https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository", + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.\n\n**Note**: Passing new arrays of `users` and `teams` replaces their previous values.", + "documentationUrl": "https://developer.github.com/v3/repos/branches/#update-pull-request-review-enforcement-of-protected-branch", "previews": [], "headers": [], "parameters": [ @@ -20085,11 +13824,11 @@ "deprecated": null }, { - "name": "sha", - "description": "SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`).", - "in": "QUERY", + "name": "branch", + "description": "branch parameter", + "in": "PATH", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -20098,10 +13837,10 @@ "deprecated": null }, { - "name": "path", - "description": "Only commits containing this file path will be returned.", - "in": "QUERY", - "type": "string", + "name": "dismissal_restrictions", + "description": "Specify which users and teams can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.", + "in": "BODY", + "type": "object", "required": false, "enum": null, "allowNull": false, @@ -20111,10 +13850,10 @@ "deprecated": null }, { - "name": "author", - "description": "GitHub login or email address by which to filter by commit author.", - "in": "QUERY", - "type": "string", + "name": "dismissal_restrictions.users", + "description": "The list of user `login`s with dismissal access", + "in": "BODY", + "type": "string[]", "required": false, "enum": null, "allowNull": false, @@ -20124,10 +13863,10 @@ "deprecated": null }, { - "name": "since", - "description": "Only commits after this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", + "name": "dismissal_restrictions.teams", + "description": "The list of team `slug`s with dismissal access", + "in": "BODY", + "type": "string[]", "required": false, "enum": null, "allowNull": false, @@ -20137,10 +13876,10 @@ "deprecated": null }, { - "name": "until", - "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", + "name": "dismiss_stale_reviews", + "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", + "in": "BODY", + "type": "boolean", "required": false, "enum": null, "allowNull": false, @@ -20150,10 +13889,10 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", + "name": "require_code_owner_reviews", + "description": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) have reviewed.", + "in": "BODY", + "type": "boolean", "required": false, "enum": null, "allowNull": false, @@ -20163,9 +13902,9 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", + "name": "required_approving_review_count", + "description": "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.", + "in": "BODY", "type": "integer", "required": false, "enum": null, @@ -20182,7 +13921,7 @@ "description": "response", "examples": [ { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}]}]" + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews\",\"dismissal_restrictions\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]},\"dismiss_stale_reviews\":true,\"require_code_owner_reviews\":true,\"required_approving_review_count\":2}" } ] } @@ -20190,19 +13929,17 @@ "renamed": null }, { - "name": "List branches for HEAD commit", + "name": "Remove pull request review enforcement of protected branch", "scope": "repos", - "id": "listBranchesForHeadCommit", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", + "id": "removeProtectedBranchPullRequestReviewEnforcement", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews", "isDeprecated": false, "isLegacy": false, - "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.", - "documentationUrl": "https://developer.github.com/v3/repos/commits/#list-branches-for-head-commit", - "previews": [{ "name": "groot" }], - "headers": [ - { "name": "accept", "value": "application/vnd.github.groot-preview+json" } - ], + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://developer.github.com/v3/repos/branches/#remove-pull-request-review-enforcement-of-protected-branch", + "previews": [], + "headers": [], "parameters": [ { "name": "owner", @@ -20231,8 +13968,8 @@ "deprecated": null }, { - "name": "commit_sha", - "description": "commit_sha parameter", + "name": "branch", + "description": "branch parameter", "in": "PATH", "type": "string", "required": true, @@ -20244,31 +13981,27 @@ "deprecated": null } ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"name\":\"branch_5\",\"commit\":{\"sha\":\"c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\"},\"protected\":\"false\"}]" - } - ] - } - ], + "responses": [], "renamed": null }, { - "name": "List comments for a single commit", + "name": "Get required signatures of protected branch", "scope": "repos", - "id": "listCommentsForCommit", + "id": "getProtectedBranchRequiredSignatures", "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", "isDeprecated": false, "isLegacy": false, - "description": "Use the `:commit_sha` to specify the commit that will have its comments listed.\n\n", - "documentationUrl": "https://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit", - "previews": [], - "headers": [], + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to check whether a branch requires signed commits. An enabled status of `true` indicates you must sign commits on this branch. For more information, see [Signing commits with GPG](https://help.github.com/articles/signing-commits-with-gpg) in GitHub Help.\n\n**Note**: You must enable branch protection to require signed commits.", + "documentationUrl": "https://developer.github.com/v3/repos/branches/#get-required-signatures-of-protected-branch", + "previews": [{ "name": "zzzax" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.zzzax-preview+json", + "required": true + } + ], "parameters": [ { "name": "owner", @@ -20297,8 +14030,8 @@ "deprecated": null }, { - "name": "commit_sha", - "description": "commit_sha parameter", + "name": "branch", + "description": "branch parameter", "in": "PATH", "type": "string", "required": true, @@ -20308,13 +14041,46 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, + "code": 200, + "description": "response", + "examples": [ + { + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures\",\"enabled\":true}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Add required signatures of protected branch", + "scope": "repos", + "id": "addProtectedBranchRequiredSignatures", + "method": "POST", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", + "isDeprecated": false, + "isLegacy": false, + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to require signed commits on a branch. You must enable branch protection to require signed commits.", + "documentationUrl": "https://developer.github.com/v3/repos/branches/#add-required-signatures-of-protected-branch", + "previews": [{ "name": "zzzax" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.zzzax-preview+json", + "required": true + } + ], + "parameters": [ + { + "name": "owner", + "description": "owner parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -20323,11 +14089,11 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "repo", + "description": "repo parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -20336,17 +14102,17 @@ "deprecated": null }, { - "name": "ref", - "description": null, - "in": null, - "type": null, - "required": null, + "name": "branch", + "description": "branch parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, - "allowNull": null, + "allowNull": false, "mapToData": null, "validation": null, - "alias": "commit_sha", - "deprecated": true + "alias": null, + "deprecated": null } ], "responses": [ @@ -20355,7 +14121,7 @@ "description": "response", "examples": [ { - "data": "[{\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/comments/1\",\"id\":1,\"node_id\":\"MDEzOkNvbW1pdENvbW1lbnQx\",\"body\":\"Great stuff\",\"path\":\"file1.txt\",\"position\":4,\"line\":14,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}]" + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures\",\"enabled\":true}" } ] } @@ -20363,17 +14129,23 @@ "renamed": null }, { - "name": "Create a commit comment", + "name": "Remove required signatures of protected branch", "scope": "repos", - "id": "createCommitComment", - "method": "POST", - "url": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", + "id": "removeProtectedBranchRequiredSignatures", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", "isDeprecated": false, "isLegacy": false, - "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.", - "documentationUrl": "https://developer.github.com/v3/repos/comments/#create-a-commit-comment", - "previews": [], - "headers": [], + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nWhen authenticated with admin or owner permissions to the repository, you can use this endpoint to disable required signed commits on a branch. You must enable branch protection to require signed commits.", + "documentationUrl": "https://developer.github.com/v3/repos/branches/#remove-required-signatures-of-protected-branch", + "previews": [{ "name": "zzzax" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.zzzax-preview+json", + "required": true + } + ], "parameters": [ { "name": "owner", @@ -20402,8 +14174,8 @@ "deprecated": null }, { - "name": "commit_sha", - "description": "commit_sha parameter", + "name": "branch", + "description": "branch parameter", "in": "PATH", "type": "string", "required": true, @@ -20413,11 +14185,28 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [], + "renamed": null + }, + { + "name": "Get required status checks of protected branch", + "scope": "repos", + "id": "getProtectedBranchRequiredStatusChecks", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", + "isDeprecated": false, + "isLegacy": false, + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://developer.github.com/v3/repos/branches/#get-required-status-checks-of-protected-branch", + "previews": [], + "headers": [], + "parameters": [ { - "name": "body", - "description": "The contents of the comment.", - "in": "BODY", + "name": "owner", + "description": "owner parameter", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -20428,24 +14217,11 @@ "deprecated": null }, { - "name": "path", - "description": "Relative path of the file to comment on.", - "in": "BODY", + "name": "repo", + "description": "repo parameter", + "in": "PATH", "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "position", - "description": "Line index in the diff to comment on.", - "in": "BODY", - "type": "integer", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -20454,39 +14230,26 @@ "deprecated": null }, { - "name": "line", - "description": "**Deprecated**. Use **position** parameter instead. Line number in the file to comment on.", - "in": "BODY", - "type": "integer", - "required": false, + "name": "branch", + "description": "branch parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - }, - { - "name": "sha", - "description": null, - "in": null, - "type": null, - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": "commit_sha", - "deprecated": true } ], "responses": [ { - "code": 201, + "code": 200, "description": "response", "examples": [ { - "data": "{\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/comments/1\",\"id\":1,\"node_id\":\"MDEzOkNvbW1pdENvbW1lbnQx\",\"body\":\"Great stuff\",\"path\":\"file1.txt\",\"position\":4,\"line\":14,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}" + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks\",\"strict\":true,\"contexts\":[\"continuous-integration/travis-ci\"],\"contexts_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts\"}" } ] } @@ -20494,19 +14257,17 @@ "renamed": null }, { - "name": "List pull requests associated with commit", + "name": "Update required status checks of protected branch", "scope": "repos", - "id": "listPullRequestsAssociatedWithCommit", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{commit_sha}/pulls", + "id": "updateProtectedBranchRequiredStatusChecks", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", "isDeprecated": false, "isLegacy": false, - "description": "Lists all pull requests containing the provided commit SHA, which can be from any point in the commit history. The results will include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests) endpoint.", - "documentationUrl": "https://developer.github.com/v3/repos/commits/#list-pull-requests-associated-with-commit", - "previews": [{ "name": "groot" }], - "headers": [ - { "name": "accept", "value": "application/vnd.github.groot-preview+json" } - ], + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nUpdating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.", + "documentationUrl": "https://developer.github.com/v3/repos/branches/#update-required-status-checks-of-protected-branch", + "previews": [], + "headers": [], "parameters": [ { "name": "owner", @@ -20535,8 +14296,8 @@ "deprecated": null }, { - "name": "commit_sha", - "description": "commit_sha parameter", + "name": "branch", + "description": "branch parameter", "in": "PATH", "type": "string", "required": true, @@ -20548,10 +14309,10 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", + "name": "strict", + "description": "Require branches to be up to date before merging.", + "in": "BODY", + "type": "boolean", "required": false, "enum": null, "allowNull": false, @@ -20561,10 +14322,10 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", + "name": "contexts", + "description": "The list of status checks to require in order to merge into this branch", + "in": "BODY", + "type": "string[]", "required": false, "enum": null, "allowNull": false, @@ -20580,7 +14341,7 @@ "description": "response", "examples": [ { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"draft\":false}]" + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks\",\"strict\":true,\"contexts\":[\"continuous-integration/travis-ci\"],\"contexts_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts\"}" } ] } @@ -20588,15 +14349,15 @@ "renamed": null }, { - "name": "Get a single commit", + "name": "Remove required status checks of protected branch", "scope": "repos", - "id": "getCommit", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{ref}", + "id": "removeProtectedBranchRequiredStatusChecks", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks", "isDeprecated": false, "isLegacy": false, - "description": "Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.\n\nYou can pass the appropriate [media type](https://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests) to fetch `diff` and `patch` formats. Diffs with binary data will have no `patch` property.\n\nTo return only the SHA-1 hash of the commit reference, you can provide the `sha` custom [media type](https://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests) in the `Accept` header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |\n\n", - "documentationUrl": "https://developer.github.com/v3/repos/commits/#get-a-single-commit", + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://developer.github.com/v3/repos/branches/#remove-required-status-checks-of-protected-branch", "previews": [], "headers": [], "parameters": [ @@ -20627,8 +14388,8 @@ "deprecated": null }, { - "name": "ref", - "description": "ref parameter", + "name": "branch", + "description": "branch parameter", "in": "PATH", "type": "string", "required": true, @@ -20638,64 +14399,23 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "sha", - "description": null, - "in": null, - "type": null, - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": "ref", - "deprecated": true - }, - { - "name": "commit_sha", - "description": null, - "in": null, - "type": null, - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": "ref", - "deprecated": true - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}],\"stats\":{\"additions\":104,\"deletions\":4,\"total\":108},\"files\":[{\"filename\":\"file1.txt\",\"additions\":10,\"deletions\":2,\"changes\":12,\"status\":\"modified\",\"raw_url\":\"https://github.com/octocat/Hello-World/raw/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt\",\"blob_url\":\"https://github.com/octocat/Hello-World/blob/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt\",\"patch\":\"@@ -29,7 +29,7 @@\\n.....\"}]}" - } - ] } ], + "responses": [], "renamed": null }, { - "name": "List check runs for a specific ref", - "scope": "checks", - "id": "listForRef", + "name": "List required status checks contexts of protected branch", + "scope": "repos", + "id": "listProtectedBranchRequiredStatusChecksContexts", "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{ref}/check-runs", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", "isDeprecated": false, "isLegacy": false, - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.", - "documentationUrl": "https://developer.github.com/v3/checks/runs/#list-check-runs-for-a-specific-ref", - "previews": [{ "name": "antiope" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.antiope-preview+json" - } - ], + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://developer.github.com/v3/repos/branches/#list-required-status-checks-contexts-of-protected-branch", + "previews": [], + "headers": [], "parameters": [ { "name": "owner", @@ -20724,8 +14444,8 @@ "deprecated": null }, { - "name": "ref", - "description": "ref parameter", + "name": "branch", + "description": "branch parameter", "in": "PATH", "type": "string", "required": true, @@ -20735,103 +14455,29 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "check_name", - "description": "Returns check runs with the specified `name`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "status", - "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["queued", "in_progress", "completed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "filter", - "description": "Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["latest", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null } ], "responses": [ { "code": 200, "description": "response", - "examples": [ - { - "data": "{\"total_count\":1,\"check_runs\":[{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"http://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":\"2018-05-04T01:14:52Z\",\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}]}" - } - ] + "examples": [{ "data": "[\"continuous-integration/travis-ci\"]" }] } ], "renamed": null }, { - "name": "List check suites for a specific ref", - "scope": "checks", - "id": "listSuitesForRef", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{ref}/check-suites", + "name": "Replace required status checks contexts of protected branch", + "scope": "repos", + "id": "replaceProtectedBranchRequiredStatusChecksContexts", + "method": "PUT", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", "isDeprecated": false, "isLegacy": false, - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nLists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository.", - "documentationUrl": "https://developer.github.com/v3/checks/suites/#list-check-suites-for-a-specific-ref", - "previews": [{ "name": "antiope" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.antiope-preview+json" - } - ], + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://developer.github.com/v3/repos/branches/#replace-required-status-checks-contexts-of-protected-branch", + "previews": [], + "headers": [], "parameters": [ { "name": "owner", @@ -20847,21 +14493,8 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "ref parameter", + "name": "repo", + "description": "repo parameter", "in": "PATH", "type": "string", "required": true, @@ -20873,37 +14506,11 @@ "deprecated": null }, { - "name": "app_id", - "description": "Filters check suites by GitHub App `id`.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "check_name", - "description": "Filters checks suites by the name of the [check run](https://developer.github.com/v3/checks/runs/).", - "in": "QUERY", + "name": "branch", + "description": "branch parameter", + "in": "PATH", "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -20912,14 +14519,14 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "contexts", + "description": "contexts parameter", + "in": "BODY", + "type": "string[]", + "required": true, "enum": null, "allowNull": false, - "mapToData": null, + "mapToData": true, "validation": null, "alias": null, "deprecated": null @@ -20929,25 +14536,21 @@ { "code": 200, "description": "response", - "examples": [ - { - "data": "{\"total_count\":1,\"check_suites\":[{\"id\":5,\"node_id\":\"MDEwOkNoZWNrU3VpdGU1\",\"head_branch\":\"master\",\"head_sha\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"url\":\"https://api.github.com/repos/github/hello-world/check-suites/5\",\"before\":\"146e867f55c26428e5f9fade55a9bbf5e95a7912\",\"after\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"pull_requests\":[],\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}]}" - } - ] + "examples": [{ "data": "[\"continuous-integration/travis-ci\"]" }] } ], "renamed": null }, { - "name": "Get the combined status for a specific ref", + "name": "Add required status checks contexts of protected branch", "scope": "repos", - "id": "getCombinedStatusForRef", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{ref}/status", + "id": "addProtectedBranchRequiredStatusChecksContexts", + "method": "POST", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", "isDeprecated": false, "isLegacy": false, - "description": "Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.\n\nThe most recent status for each context is returned, up to 100. This field [paginates](https://developer.github.com/v3/#pagination) if there are over 100 contexts.\n\nAdditionally, a combined `state` is returned. The `state` is one of:\n\n* **failure** if any of the contexts report as `error` or `failure`\n* **pending** if there are no statuses or a context is `pending`\n* **success** if the latest status for all contexts is `success`", - "documentationUrl": "https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref", + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://developer.github.com/v3/repos/branches/#add-required-status-checks-contexts-of-protected-branch", "previews": [], "headers": [], "parameters": [ @@ -20978,8 +14581,8 @@ "deprecated": null }, { - "name": "ref", - "description": "ref parameter", + "name": "branch", + "description": "branch parameter", "in": "PATH", "type": "string", "required": true, @@ -20989,6 +14592,19 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "contexts", + "description": "contexts parameter", + "in": "BODY", + "type": "string[]", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": true, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -20997,7 +14613,7 @@ "description": "response", "examples": [ { - "data": "{\"state\":\"success\",\"statuses\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"id\":1,\"node_id\":\"MDY6U3RhdHVzMQ==\",\"state\":\"success\",\"description\":\"Build has completed successfully\",\"target_url\":\"https://ci.example.com/1000/output\",\"context\":\"continuous-integration/jenkins\",\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\"},{\"url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"id\":2,\"node_id\":\"MDY6U3RhdHVzMg==\",\"state\":\"success\",\"description\":\"Testing has completed successfully\",\"target_url\":\"https://ci.example.com/2000/output\",\"context\":\"security/brakeman\",\"created_at\":\"2012-08-20T01:19:13Z\",\"updated_at\":\"2012-08-20T01:19:13Z\"}],\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"total_count\":2,\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\"},\"commit_url\":\"https://api.github.com/repos/octocat/Hello-World/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/6dcb09b5b57875f334f61aebed695e2e4193db5e/status\"}" + "data": "[\"continuous-integration/travis-ci\",\"continuous-integration/jenkins\"]" } ] } @@ -21005,15 +14621,15 @@ "renamed": null }, { - "name": "List statuses for a specific ref", + "name": "Remove required status checks contexts of protected branch", "scope": "repos", - "id": "listStatusesForRef", - "method": "GET", - "url": "/repos/{owner}/{repo}/commits/{ref}/statuses", + "id": "removeProtectedBranchRequiredStatusChecksContexts", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", "isDeprecated": false, "isLegacy": false, - "description": "Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one.\n\nThis resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`.", - "documentationUrl": "https://developer.github.com/v3/repos/statuses/#list-statuses-for-a-specific-ref", + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://developer.github.com/v3/repos/branches/#remove-required-status-checks-contexts-of-protected-branch", "previews": [], "headers": [], "parameters": [ @@ -21044,8 +14660,8 @@ "deprecated": null }, { - "name": "ref", - "description": "ref parameter", + "name": "branch", + "description": "branch parameter", "in": "PATH", "type": "string", "required": true, @@ -21057,27 +14673,14 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "contexts", + "description": "contexts parameter", + "in": "BODY", + "type": "string[]", + "required": true, "enum": null, "allowNull": false, - "mapToData": null, + "mapToData": true, "validation": null, "alias": null, "deprecated": null @@ -21087,32 +14690,23 @@ { "code": 200, "description": "response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"id\":1,\"node_id\":\"MDY6U3RhdHVzMQ==\",\"state\":\"success\",\"description\":\"Build has completed successfully\",\"target_url\":\"https://ci.example.com/1000/output\",\"context\":\"continuous-integration/jenkins\",\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]" - } - ] + "examples": [{ "data": "[\"continuous-integration/travis-ci\"]" }] } ], "renamed": null }, { - "name": "Get the contents of a repository's code of conduct", - "scope": "codesOfConduct", - "id": "getForRepo", + "name": "Get restrictions of protected branch", + "scope": "repos", + "id": "getProtectedBranchRestrictions", "method": "GET", - "url": "/repos/{owner}/{repo}/community/code_of_conduct", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", "isDeprecated": false, "isLegacy": false, - "description": "This method returns the contents of the repository's code of conduct file, if one is detected.", - "documentationUrl": "https://developer.github.com/v3/codes_of_conduct/#get-the-contents-of-a-repositorys-code-of-conduct", - "previews": [{ "name": "scarlet-witch" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.scarlet-witch-preview+json" - } - ], + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists who has access to this protected branch. {{#note}}\n\n**Note**: Users, apps, and teams `restrictions` are only available for organization-owned repositories.", + "documentationUrl": "https://developer.github.com/v3/repos/branches/#get-restrictions-of-protected-branch", + "previews": [], + "headers": [], "parameters": [ { "name": "owner", @@ -21139,6 +14733,19 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "branch", + "description": "branch parameter", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -21147,7 +14754,7 @@ "description": "response", "examples": [ { - "data": "{\"key\":\"contributor_covenant\",\"name\":\"Contributor Covenant\",\"url\":\"https://github.com/LindseyB/cosee/blob/master/CODE_OF_CONDUCT.md\",\"body\":\"# Contributor Covenant Code of Conduct\\n\\n## Our Pledge\\n\\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\\n\\n## Our Standards\\n\\nExamples of behavior that contributes to creating a positive environment include=>\\n\\n* Using welcoming and inclusive language\\n* Being respectful of differing viewpoints and experiences\\n* Gracefully accepting constructive criticism\\n* Focusing on what is best for the community\\n* Showing empathy towards other community members\\n\\nExamples of unacceptable behavior by participants include=>\\n\\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\\n* Trolling, insulting/derogatory comments, and personal or political attacks\\n* Public or private harassment\\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\\n* Other conduct which could reasonably be considered inappropriate in a professional setting\\n\\n## Our Responsibilities\\n\\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\\nto any instances of unacceptable behavior.\\n\\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\\n\\n## Scope\\n\\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\\nposting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\\n\\n## Enforcement\\n\\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at lindseyb@github.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\\n\\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\\n\\n## Attribution\\n\\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\\n\\n[homepage]: http://contributor-covenant.org\\n[version]: http://contributor-covenant.org/version/1/4/\\n\"}" + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions\",\"users_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/users\",\"teams_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams\",\"apps_url\":\"https://api.github.com/repos/octocat/Hello-World/branches/master/protection/restrictions/teams\",\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"apps\":[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]}" } ] } @@ -21155,15 +14762,15 @@ "renamed": null }, { - "name": "Retrieve community profile metrics", + "name": "Remove restrictions of protected branch", "scope": "repos", - "id": "retrieveCommunityProfileMetrics", - "method": "GET", - "url": "/repos/{owner}/{repo}/community/profile", + "id": "removeProtectedBranchRestrictions", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions", "isDeprecated": false, "isLegacy": false, - "description": "This endpoint will return all community profile metrics, including an overall health score, repository description, the presence of documentation, detected code of conduct, detected license, and the presence of ISSUE\\_TEMPLATE, PULL\\_REQUEST\\_TEMPLATE, README, and CONTRIBUTING files.", - "documentationUrl": "https://developer.github.com/v3/repos/community/#retrieve-community-profile-metrics", + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nDisables the ability to restrict who can push to this branch.", + "documentationUrl": "https://developer.github.com/v3/repos/branches/#remove-restrictions-of-protected-branch", "previews": [], "headers": [], "parameters": [ @@ -21192,31 +14799,34 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ + }, { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"health_percentage\":100,\"description\":\"My first repository on GitHub!\",\"documentation\":true,\"files\":{\"code_of_conduct\":{\"name\":\"Contributor Covenant\",\"key\":\"contributor_covenant\",\"url\":\"https://api.github.com/codes_of_conduct/contributor_covenant\",\"html_url\":\"https://github.com/octocat/Hello-World/blob/master/CODE_OF_CONDUCT.md\"},\"contributing\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/contents/CONTRIBUTING\",\"html_url\":\"https://github.com/octocat/Hello-World/blob/master/CONTRIBUTING\"},\"issue_template\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/contents/ISSUE_TEMPLATE\",\"html_url\":\"https://github.com/octocat/Hello-World/blob/master/ISSUE_TEMPLATE\"},\"pull_request_template\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/contents/PULL_REQUEST_TEMPLATE\",\"html_url\":\"https://github.com/octocat/Hello-World/blob/master/PULL_REQUEST_TEMPLATE\"},\"license\":{\"name\":\"MIT License\",\"key\":\"mit\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"html_url\":\"https://github.com/octocat/Hello-World/blob/master/LICENSE\"},\"readme\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/contents/README.md\",\"html_url\":\"https://github.com/octocat/Hello-World/blob/master/README.md\"}},\"updated_at\":\"2017-02-28T19:09:29Z\"}" - } - ] + "name": "branch", + "description": "branch parameter", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], + "responses": [], "renamed": null }, { - "name": "Compare two commits", + "name": "Get apps with access to protected branch", "scope": "repos", - "id": "compareCommits", + "id": "getAppsWithAccessToProtectedBranch", "method": "GET", - "url": "/repos/{owner}/{repo}/compare/{base}...{head}", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "isDeprecated": false, "isLegacy": false, - "description": "Both `:base` and `:head` must be branch names in `:repo`. To compare branches across other repositories in the same network as `:repo`, use the format `:branch`.\n\nThe response from the API is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. Pass the appropriate [media type](https://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.\n\nThe response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\n**Working with large comparisons**\n\nThe response will include a comparison of up to 250 commits. If you are working with a larger commit range, you can use the [Commit List API](https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository) to enumerate all commits in the range.\n\nFor comparisons with extremely large diffs, you may receive an error response indicating that the diff took too long to generate. You can typically resolve this error by using a smaller commit range.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", - "documentationUrl": "https://developer.github.com/v3/repos/commits/#compare-two-commits", + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.", + "documentationUrl": "https://developer.github.com/v3/repos/branches/#list-apps-with-access-to-protected-branch", "previews": [], "headers": [], "parameters": [ @@ -21247,21 +14857,8 @@ "deprecated": null }, { - "name": "base", - "description": "base parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "head", - "description": "head parameter", + "name": "branch", + "description": "branch parameter", "in": "PATH", "type": "string", "required": true, @@ -21279,7 +14876,7 @@ "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/compare/master...topic\",\"html_url\":\"https://github.com/octocat/Hello-World/compare/master...topic\",\"permalink_url\":\"https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17\",\"diff_url\":\"https://github.com/octocat/Hello-World/compare/master...topic.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/compare/master...topic.patch\",\"base_commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}]},\"merge_base_commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}]},\"status\":\"behind\",\"ahead_by\":1,\"behind_by\":2,\"total_commits\":1,\"commits\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}]}],\"files\":[{\"sha\":\"bbcd538c8e72b8c175046e27cc8f907076331401\",\"filename\":\"file1.txt\",\"status\":\"added\",\"additions\":103,\"deletions\":21,\"changes\":124,\"blob_url\":\"https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt\",\"raw_url\":\"https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"patch\":\"@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test\"}]}" + "data": "[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]" } ] } @@ -21287,15 +14884,15 @@ "renamed": null }, { - "name": "Get contents", + "name": "Replace app restrictions of protected branch", "scope": "repos", - "id": "getContents", - "method": "GET", - "url": "/repos/{owner}/{repo}/contents/{path}", + "id": "replaceProtectedBranchAppRestrictions", + "method": "PUT", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "isDeprecated": false, "isLegacy": false, - "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit `:path`, you will receive the contents of all files in the repository.\n\nFiles and symlinks support [a custom media type](https://developer.github.com/v3/repos/contents/#custom-media-types) for retrieving the raw content or rendered HTML (when supported). All content types support [a custom media type](https://developer.github.com/v3/repos/contents/#custom-media-types) to ensure the content is returned in a consistent object format.\n\n**Note**:\n\n* To get a repository's contents recursively, you can [recursively get the tree](https://developer.github.com/v3/git/trees/).\n* This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees API](https://developer.github.com/v3/git/trees/#get-a-tree).\n* This API supports files up to 1 megabyte in size.\n\nThe response will be an array of objects, one object for each item in the directory.\n\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value _should_ be \"submodule\". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as \"submodule\".\n\nIf the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the API responds with the content of the file (in the [format shown above](https://developer.github.com/v3/repos/contents/#response-if-content-is-a-file)).\n\nOtherwise, the API responds with an object describing the symlink itself:\n\nThe `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit.\n\nIf the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the github.com URLs (`html_url` and `_links[\"html\"]`) will have null values.", - "documentationUrl": "https://developer.github.com/v3/repos/contents/#get-contents", + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of apps that have push access to this branch. This removes all apps that previously had push access and grants push access to the new list of apps. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "documentationUrl": "https://developer.github.com/v3/repos/branches/#replace-app-restrictions-of-protected-branch", "previews": [], "headers": [], "parameters": [ @@ -21326,8 +14923,8 @@ "deprecated": null }, { - "name": "path", - "description": "path parameter", + "name": "branch", + "description": "branch parameter", "in": "PATH", "type": "string", "required": true, @@ -21339,14 +14936,14 @@ "deprecated": null }, { - "name": "ref", - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", - "in": "QUERY", - "type": "string", - "required": false, + "name": "apps", + "description": "apps parameter", + "in": "BODY", + "type": "string[]", + "required": true, "enum": null, "allowNull": false, - "mapToData": null, + "mapToData": true, "validation": null, "alias": null, "deprecated": null @@ -21358,16 +14955,7 @@ "description": "response", "examples": [ { - "data": "{\"type\":\"file\",\"encoding\":\"base64\",\"size\":5362,\"name\":\"README.md\",\"path\":\"README.md\",\"content\":\"encoded content ...\",\"sha\":\"3d21ec53a331a6f037a91c368710b99387d012c1\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md\",\"_links\":{\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\"}}" - }, - { - "data": "[{\"type\":\"file\",\"size\":625,\"name\":\"octokit.rb\",\"path\":\"lib/octokit.rb\",\"sha\":\"fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/lib/octokit.rb\",\"_links\":{\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb\",\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb\"}},{\"type\":\"dir\",\"size\":0,\"name\":\"octokit\",\"path\":\"lib/octokit\",\"sha\":\"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"html_url\":\"https://github.com/octokit/octokit.rb/tree/master/lib/octokit\",\"download_url\":null,\"_links\":{\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit\",\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"html\":\"https://github.com/octokit/octokit.rb/tree/master/lib/octokit\"}}]" - }, - { - "data": "{\"type\":\"symlink\",\"target\":\"/path/to/symlink/target\",\"size\":23,\"name\":\"some-symlink\",\"path\":\"bin/some-symlink\",\"sha\":\"452a98979c88e093d682cab404a3ec82babebb48\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/bin/some-symlink\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/452a98979c88e093d682cab404a3ec82babebb48\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/bin/some-symlink\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/bin/some-symlink\",\"_links\":{\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/452a98979c88e093d682cab404a3ec82babebb48\",\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/bin/some-symlink\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/bin/some-symlink\"}}" - }, - { - "data": "{\"type\":\"submodule\",\"submodule_git_url\":\"git://github.com/jquery/qunit.git\",\"size\":0,\"name\":\"qunit\",\"path\":\"test/qunit\",\"sha\":\"6ca3721222109997540bd6d9ccd396902e0ad2f9\",\"url\":\"https://api.github.com/repos/jquery/jquery/contents/test/qunit?ref=master\",\"git_url\":\"https://api.github.com/repos/jquery/qunit/git/trees/6ca3721222109997540bd6d9ccd396902e0ad2f9\",\"html_url\":\"https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9\",\"download_url\":null,\"_links\":{\"git\":\"https://api.github.com/repos/jquery/qunit/git/trees/6ca3721222109997540bd6d9ccd396902e0ad2f9\",\"self\":\"https://api.github.com/repos/jquery/jquery/contents/test/qunit?ref=master\",\"html\":\"https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9\"}}" + "data": "[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]" } ] } @@ -21375,15 +14963,15 @@ "renamed": null }, { - "name": "Create or update a file", + "name": "Add app restrictions of protected branch", "scope": "repos", - "id": "createOrUpdateFile", - "method": "PUT", - "url": "/repos/{owner}/{repo}/contents/{path}", + "id": "addProtectedBranchAppRestrictions", + "method": "POST", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", "isDeprecated": false, "isLegacy": false, - "description": "Creates a new file or updates an existing file in a repository.", - "documentationUrl": "https://developer.github.com/v3/repos/contents/#create-or-update-a-file", + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified apps push access for this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "documentationUrl": "https://developer.github.com/v3/repos/branches/#add-app-restrictions-of-protected-branch", "previews": [], "headers": [], "parameters": [ @@ -21414,8 +15002,8 @@ "deprecated": null }, { - "name": "path", - "description": "path parameter", + "name": "branch", + "description": "branch parameter", "in": "PATH", "type": "string", "required": true, @@ -21427,22 +15015,49 @@ "deprecated": null }, { - "name": "message", - "description": "The commit message.", + "name": "apps", + "description": "apps parameter", "in": "BODY", - "type": "string", + "type": "string[]", "required": true, "enum": null, "allowNull": false, - "mapToData": null, + "mapToData": true, "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "content", - "description": "The new file content, using Base64 encoding.", - "in": "BODY", + "code": 200, + "description": "response", + "examples": [ + { + "data": "[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]" + } + ] + } + ], + "renamed": null + }, + { + "name": "Remove app restrictions of protected branch", + "scope": "repos", + "id": "removeProtectedBranchAppRestrictions", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + "isDeprecated": false, + "isLegacy": false, + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of an app to push to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch.\n\n| Type | Description |\n| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | The GitHub Apps that have push access to this branch. Use the app's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "documentationUrl": "https://developer.github.com/v3/repos/branches/#remove-app-restrictions-of-protected-branch", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "owner parameter", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -21453,11 +15068,11 @@ "deprecated": null }, { - "name": "sha", - "description": "**Required if you are updating a file**. The blob SHA of the file being replaced.", - "in": "BODY", + "name": "repo", + "description": "repo parameter", + "in": "PATH", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -21467,23 +15082,10 @@ }, { "name": "branch", - "description": "The branch name. Default: the repository’s default branch (usually `master`)", - "in": "BODY", + "description": "branch parameter", + "in": "PATH", "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "committer", - "description": "The person that committed the file. Default: the authenticated user.", - "in": "BODY", - "type": "object", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -21492,22 +15094,49 @@ "deprecated": null }, { - "name": "committer.name", - "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "name": "apps", + "description": "apps parameter", "in": "BODY", - "type": "string", + "type": "string[]", "required": true, "enum": null, "allowNull": false, - "mapToData": null, + "mapToData": true, "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "committer.email", - "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.", - "in": "BODY", + "code": 200, + "description": "response", + "examples": [ + { + "data": "[{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]}]" + } + ] + } + ], + "renamed": null + }, + { + "name": "Get teams with access to protected branch", + "scope": "repos", + "id": "getTeamsWithAccessToProtectedBranch", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + "isDeprecated": false, + "isLegacy": false, + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the teams who have push access to this branch. The list includes child teams.", + "documentationUrl": "https://developer.github.com/v3/repos/branches/#list-teams-with-access-to-protected-branch", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "owner parameter", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -21518,22 +15147,9 @@ "deprecated": null }, { - "name": "author", - "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "author.name", - "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "in": "BODY", + "name": "repo", + "description": "repo parameter", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -21544,9 +15160,9 @@ "deprecated": null }, { - "name": "author.email", - "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.", - "in": "BODY", + "name": "branch", + "description": "branch parameter", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -21563,16 +15179,7 @@ "description": "response", "examples": [ { - "data": "{\"content\":{\"name\":\"hello.txt\",\"path\":\"notes/hello.txt\",\"sha\":\"a56507ed892d05a37c6d6128c260937ea4d287bd\",\"size\":9,\"url\":\"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\"html_url\":\"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\",\"git_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd\",\"download_url\":\"https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt\",\"type\":\"file\",\"_links\":{\"self\":\"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\"git\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd\",\"html\":\"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\"}},\"commit\":{\"sha\":\"18a43cd8e1e3a79c786e3d808a73d23b6d212b16\",\"node_id\":\"MDY6Q29tbWl0MThhNDNjZDhlMWUzYTc5Yzc4NmUzZDgwOGE3M2QyM2I2ZDIxMmIxNg==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/18a43cd8e1e3a79c786e3d808a73d23b6d212b16\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/18a43cd8e1e3a79c786e3d808a73d23b6d212b16\",\"author\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"committer\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"message\":\"my commit message\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f\",\"sha\":\"9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f\"},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/da5a433788da5c255edad7979b328b67d79f53f6\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/da5a433788da5c255edad7979b328b67d79f53f6\",\"sha\":\"da5a433788da5c255edad7979b328b67d79f53f6\"}],\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}}" - } - ] - }, - { - "code": 201, - "description": "response", - "examples": [ - { - "data": "{\"content\":{\"name\":\"hello.txt\",\"path\":\"notes/hello.txt\",\"sha\":\"95b966ae1c166bd92f8ae7d1c313e738c731dfc3\",\"size\":9,\"url\":\"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\"html_url\":\"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\",\"git_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3\",\"download_url\":\"https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt\",\"type\":\"file\",\"_links\":{\"self\":\"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\"git\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3\",\"html\":\"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\"}},\"commit\":{\"sha\":\"7638417db6d59f3c431d3e1f261cc637155684cd\",\"node_id\":\"MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd\",\"author\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"committer\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"message\":\"my commit message\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb\",\"sha\":\"691272480426f78a0138979dd3ce63b77f706feb\"},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\"sha\":\"1acc419d4d6a9ce985db7be48c6349a0475975b5\"}],\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}}" + "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]" } ] } @@ -21580,15 +15187,15 @@ "renamed": null }, { - "name": "Create or update a file", + "name": "Replace team restrictions of protected branch", "scope": "repos", - "id": "createFile", + "id": "replaceProtectedBranchTeamRestrictions", "method": "PUT", - "url": "/repos/{owner}/{repo}/contents/{path}", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", "isDeprecated": false, "isLegacy": false, - "description": "Creates a new file or updates an existing file in a repository.", - "documentationUrl": "https://developer.github.com/v3/repos/contents/#create-or-update-a-file", + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of teams that have push access to this branch. This removes all teams that previously had push access and grants push access to the new list of teams. Team restrictions include child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "documentationUrl": "https://developer.github.com/v3/repos/branches/#replace-team-restrictions-of-protected-branch", "previews": [], "headers": [], "parameters": [ @@ -21619,8 +15226,8 @@ "deprecated": null }, { - "name": "path", - "description": "path parameter", + "name": "branch", + "description": "branch parameter", "in": "PATH", "type": "string", "required": true, @@ -21632,37 +15239,51 @@ "deprecated": null }, { - "name": "message", - "description": "The commit message.", + "name": "teams", + "description": "teams parameter", "in": "BODY", - "type": "string", + "type": "string[]", "required": true, "enum": null, "allowNull": false, - "mapToData": null, + "mapToData": true, "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "content", - "description": "The new file content, using Base64 encoding.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, + "code": 200, + "description": "response", + "examples": [ + { + "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]" + } + ] + } + ], + "renamed": null + }, + { + "name": "Add team restrictions of protected branch", + "scope": "repos", + "id": "addProtectedBranchTeamRestrictions", + "method": "POST", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + "isDeprecated": false, + "isLegacy": false, + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified teams push access for this branch. You can also give push access to child teams.\n\n| Type | Description |\n| ------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| `array` | The teams that can have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "documentationUrl": "https://developer.github.com/v3/repos/branches/#add-team-restrictions-of-protected-branch", + "previews": [], + "headers": [], + "parameters": [ { - "name": "sha", - "description": "**Required if you are updating a file**. The blob SHA of the file being replaced.", - "in": "BODY", + "name": "owner", + "description": "owner parameter", + "in": "PATH", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -21671,11 +15292,11 @@ "deprecated": null }, { - "name": "branch", - "description": "The branch name. Default: the repository’s default branch (usually `master`)", - "in": "BODY", + "name": "repo", + "description": "repo parameter", + "in": "PATH", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -21684,11 +15305,11 @@ "deprecated": null }, { - "name": "committer", - "description": "The person that committed the file. Default: the authenticated user.", - "in": "BODY", - "type": "object", - "required": false, + "name": "branch", + "description": "branch parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -21697,22 +15318,49 @@ "deprecated": null }, { - "name": "committer.name", - "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "name": "teams", + "description": "teams parameter", "in": "BODY", - "type": "string", + "type": "string[]", "required": true, "enum": null, "allowNull": false, - "mapToData": null, + "mapToData": true, "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "committer.email", - "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.", - "in": "BODY", + "code": 200, + "description": "response", + "examples": [ + { + "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]" + } + ] + } + ], + "renamed": null + }, + { + "name": "Remove team restrictions of protected branch", + "scope": "repos", + "id": "removeProtectedBranchTeamRestrictions", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + "isDeprecated": false, + "isLegacy": false, + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a team to push to this branch. You can also remove push access for child teams.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Teams that should no longer have push access. Use the team's `slug`. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "documentationUrl": "https://developer.github.com/v3/repos/branches/#remove-team-restrictions-of-protected-branch", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "owner parameter", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -21723,11 +15371,11 @@ "deprecated": null }, { - "name": "author", - "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", - "in": "BODY", - "type": "object", - "required": false, + "name": "repo", + "description": "repo parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -21736,9 +15384,9 @@ "deprecated": null }, { - "name": "author.name", - "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "in": "BODY", + "name": "branch", + "description": "branch parameter", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -21749,14 +15397,14 @@ "deprecated": null }, { - "name": "author.email", - "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.", + "name": "teams", + "description": "teams parameter", "in": "BODY", - "type": "string", + "type": "string[]", "required": true, "enum": null, "allowNull": false, - "mapToData": null, + "mapToData": true, "validation": null, "alias": null, "deprecated": null @@ -21768,37 +15416,23 @@ "description": "response", "examples": [ { - "data": "{\"content\":{\"name\":\"hello.txt\",\"path\":\"notes/hello.txt\",\"sha\":\"a56507ed892d05a37c6d6128c260937ea4d287bd\",\"size\":9,\"url\":\"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\"html_url\":\"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\",\"git_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd\",\"download_url\":\"https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt\",\"type\":\"file\",\"_links\":{\"self\":\"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\"git\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd\",\"html\":\"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\"}},\"commit\":{\"sha\":\"18a43cd8e1e3a79c786e3d808a73d23b6d212b16\",\"node_id\":\"MDY6Q29tbWl0MThhNDNjZDhlMWUzYTc5Yzc4NmUzZDgwOGE3M2QyM2I2ZDIxMmIxNg==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/18a43cd8e1e3a79c786e3d808a73d23b6d212b16\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/18a43cd8e1e3a79c786e3d808a73d23b6d212b16\",\"author\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"committer\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"message\":\"my commit message\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f\",\"sha\":\"9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f\"},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/da5a433788da5c255edad7979b328b67d79f53f6\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/da5a433788da5c255edad7979b328b67d79f53f6\",\"sha\":\"da5a433788da5c255edad7979b328b67d79f53f6\"}],\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}}" - } - ] - }, - { - "code": 201, - "description": "response", - "examples": [ - { - "data": "{\"content\":{\"name\":\"hello.txt\",\"path\":\"notes/hello.txt\",\"sha\":\"95b966ae1c166bd92f8ae7d1c313e738c731dfc3\",\"size\":9,\"url\":\"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\"html_url\":\"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\",\"git_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3\",\"download_url\":\"https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt\",\"type\":\"file\",\"_links\":{\"self\":\"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\"git\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3\",\"html\":\"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\"}},\"commit\":{\"sha\":\"7638417db6d59f3c431d3e1f261cc637155684cd\",\"node_id\":\"MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd\",\"author\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"committer\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"message\":\"my commit message\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb\",\"sha\":\"691272480426f78a0138979dd3ce63b77f706feb\"},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\"sha\":\"1acc419d4d6a9ce985db7be48c6349a0475975b5\"}],\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}}" + "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]" } ] } ], - "renamed": { - "before": { "scope": "repos", "id": "createFile" }, - "after": { "scope": "repos", "id": "createOrUpdateFile" }, - "date": "2019-06-07", - "note": "\"Create a file\" replaced by \"Create or update a file\"" - } + "renamed": null }, { - "name": "Create or update a file", + "name": "Get users with access to protected branch", "scope": "repos", - "id": "updateFile", - "method": "PUT", - "url": "/repos/{owner}/{repo}/contents/{path}", + "id": "getUsersWithAccessToProtectedBranch", + "method": "GET", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", "isDeprecated": false, "isLegacy": false, - "description": "Creates a new file or updates an existing file in a repository.", - "documentationUrl": "https://developer.github.com/v3/repos/contents/#create-or-update-a-file", + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists the people who have push access to this branch.", + "documentationUrl": "https://developer.github.com/v3/repos/branches/#list-users-with-access-to-protected-branch", "previews": [], "headers": [], "parameters": [ @@ -21829,8 +15463,8 @@ "deprecated": null }, { - "name": "path", - "description": "path parameter", + "name": "branch", + "description": "branch parameter", "in": "PATH", "type": "string", "required": true, @@ -21840,24 +15474,38 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "message", - "description": "The commit message.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, + "code": 200, + "description": "response", + "examples": [ + { + "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" + } + ] + } + ], + "renamed": null + }, + { + "name": "Replace user restrictions of protected branch", + "scope": "repos", + "id": "replaceProtectedBranchUserRestrictions", + "method": "PUT", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + "isDeprecated": false, + "isLegacy": false, + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReplaces the list of people that have push access to this branch. This removes all people that previously had push access and grants push access to the new list of people.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "documentationUrl": "https://developer.github.com/v3/repos/branches/#replace-user-restrictions-of-protected-branch", + "previews": [], + "headers": [], + "parameters": [ { - "name": "content", - "description": "The new file content, using Base64 encoding.", - "in": "BODY", + "name": "owner", + "description": "owner parameter", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -21868,11 +15516,11 @@ "deprecated": null }, { - "name": "sha", - "description": "**Required if you are updating a file**. The blob SHA of the file being replaced.", - "in": "BODY", + "name": "repo", + "description": "repo parameter", + "in": "PATH", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -21882,10 +15530,10 @@ }, { "name": "branch", - "description": "The branch name. Default: the repository’s default branch (usually `master`)", - "in": "BODY", + "description": "branch parameter", + "in": "PATH", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -21894,22 +15542,49 @@ "deprecated": null }, { - "name": "committer", - "description": "The person that committed the file. Default: the authenticated user.", + "name": "users", + "description": "users parameter", "in": "BODY", - "type": "object", - "required": false, + "type": "string[]", + "required": true, "enum": null, "allowNull": false, - "mapToData": null, + "mapToData": true, "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "committer.name", - "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "in": "BODY", + "code": 200, + "description": "response", + "examples": [ + { + "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" + } + ] + } + ], + "renamed": null + }, + { + "name": "Add user restrictions of protected branch", + "scope": "repos", + "id": "addProtectedBranchUserRestrictions", + "method": "POST", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + "isDeprecated": false, + "isLegacy": false, + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nGrants the specified people push access for this branch.\n\n| Type | Description |\n| ------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames for people who can have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "documentationUrl": "https://developer.github.com/v3/repos/branches/#add-user-restrictions-of-protected-branch", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "owner parameter", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -21920,9 +15595,9 @@ "deprecated": null }, { - "name": "committer.email", - "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.", - "in": "BODY", + "name": "repo", + "description": "repo parameter", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -21933,22 +15608,9 @@ "deprecated": null }, { - "name": "author", - "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "author.name", - "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", - "in": "BODY", + "name": "branch", + "description": "branch parameter", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -21959,14 +15621,14 @@ "deprecated": null }, { - "name": "author.email", - "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.", + "name": "users", + "description": "users parameter", "in": "BODY", - "type": "string", + "type": "string[]", "required": true, "enum": null, "allowNull": false, - "mapToData": null, + "mapToData": true, "validation": null, "alias": null, "deprecated": null @@ -21978,37 +15640,23 @@ "description": "response", "examples": [ { - "data": "{\"content\":{\"name\":\"hello.txt\",\"path\":\"notes/hello.txt\",\"sha\":\"a56507ed892d05a37c6d6128c260937ea4d287bd\",\"size\":9,\"url\":\"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\"html_url\":\"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\",\"git_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd\",\"download_url\":\"https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt\",\"type\":\"file\",\"_links\":{\"self\":\"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\"git\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd\",\"html\":\"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\"}},\"commit\":{\"sha\":\"18a43cd8e1e3a79c786e3d808a73d23b6d212b16\",\"node_id\":\"MDY6Q29tbWl0MThhNDNjZDhlMWUzYTc5Yzc4NmUzZDgwOGE3M2QyM2I2ZDIxMmIxNg==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/18a43cd8e1e3a79c786e3d808a73d23b6d212b16\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/18a43cd8e1e3a79c786e3d808a73d23b6d212b16\",\"author\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"committer\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"message\":\"my commit message\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f\",\"sha\":\"9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f\"},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/da5a433788da5c255edad7979b328b67d79f53f6\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/da5a433788da5c255edad7979b328b67d79f53f6\",\"sha\":\"da5a433788da5c255edad7979b328b67d79f53f6\"}],\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}}" - } - ] - }, - { - "code": 201, - "description": "response", - "examples": [ - { - "data": "{\"content\":{\"name\":\"hello.txt\",\"path\":\"notes/hello.txt\",\"sha\":\"95b966ae1c166bd92f8ae7d1c313e738c731dfc3\",\"size\":9,\"url\":\"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\"html_url\":\"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\",\"git_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3\",\"download_url\":\"https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt\",\"type\":\"file\",\"_links\":{\"self\":\"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\"git\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3\",\"html\":\"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\"}},\"commit\":{\"sha\":\"7638417db6d59f3c431d3e1f261cc637155684cd\",\"node_id\":\"MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd\",\"author\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"committer\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"message\":\"my commit message\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb\",\"sha\":\"691272480426f78a0138979dd3ce63b77f706feb\"},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\"sha\":\"1acc419d4d6a9ce985db7be48c6349a0475975b5\"}],\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}}" + "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" } ] } ], - "renamed": { - "before": { "scope": "repos", "id": "updateFile" }, - "after": { "scope": "repos", "id": "createOrUpdateFile" }, - "date": "2019-06-07", - "note": "\"Update a file\" replaced by \"Create or update a file\"" - } + "renamed": null }, { - "name": "Delete a file", + "name": "Remove user restrictions of protected branch", "scope": "repos", - "id": "deleteFile", + "id": "removeProtectedBranchUserRestrictions", "method": "DELETE", - "url": "/repos/{owner}/{repo}/contents/{path}", + "url": "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", "isDeprecated": false, "isLegacy": false, - "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.", - "documentationUrl": "https://developer.github.com/v3/repos/contents/#delete-a-file", + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nRemoves the ability of a user to push to this branch.\n\n| Type | Description |\n| ------- | --------------------------------------------------------------------------------------------------------------------------------------------- |\n| `array` | Usernames of the people who should no longer have push access. **Note**: The list of users, apps, and teams in total is limited to 100 items. |", + "documentationUrl": "https://developer.github.com/v3/repos/branches/#remove-user-restrictions-of-protected-branch", "previews": [], "headers": [], "parameters": [ @@ -22039,8 +15687,8 @@ "deprecated": null }, { - "name": "path", - "description": "path parameter", + "name": "branch", + "description": "branch parameter", "in": "PATH", "type": "string", "required": true, @@ -22052,22 +15700,55 @@ "deprecated": null }, { - "name": "message", - "description": "The commit message.", + "name": "users", + "description": "users parameter", "in": "BODY", - "type": "string", + "type": "string[]", "required": true, "enum": null, "allowNull": false, - "mapToData": null, + "mapToData": true, "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "sha", - "description": "The blob SHA of the file being replaced.", - "in": "BODY", + "code": 200, + "description": "response", + "examples": [ + { + "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" + } + ] + } + ], + "renamed": null + }, + { + "name": "Create a check run", + "scope": "checks", + "id": "create", + "method": "POST", + "url": "/repos/{owner}/{repo}/check-runs", + "isDeprecated": false, + "isLegacy": false, + "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nCreates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.", + "documentationUrl": "https://developer.github.com/v3/checks/runs/#create-a-check-run", + "previews": [{ "name": "antiope" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.antiope-preview+json", + "required": true + } + ], + "parameters": [ + { + "name": "owner", + "description": "owner parameter", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -22078,11 +15759,11 @@ "deprecated": null }, { - "name": "branch", - "description": "The branch name. Default: the repository’s default branch (usually `master`)", - "in": "BODY", + "name": "repo", + "description": "repo parameter", + "in": "PATH", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -22091,11 +15772,11 @@ "deprecated": null }, { - "name": "committer", - "description": "object containing information about the committer.", + "name": "name", + "description": "The name of the check. For example, \"code-coverage\".", "in": "BODY", - "type": "object", - "required": false, + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -22104,11 +15785,11 @@ "deprecated": null }, { - "name": "committer.name", - "description": "The name of the author (or committer) of the commit", + "name": "head_sha", + "description": "The SHA of the commit.", "in": "BODY", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -22117,8 +15798,8 @@ "deprecated": null }, { - "name": "committer.email", - "description": "The email of the author (or committer) of the commit", + "name": "details_url", + "description": "The URL of the integrator's site that has the full details of the check.", "in": "BODY", "type": "string", "required": false, @@ -22130,10 +15811,10 @@ "deprecated": null }, { - "name": "author", - "description": "object containing information about the author.", + "name": "external_id", + "description": "A reference for the run on the integrator's system.", "in": "BODY", - "type": "object", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -22143,12 +15824,12 @@ "deprecated": null }, { - "name": "author.name", - "description": "The name of the author (or committer) of the commit", + "name": "status", + "description": "The current status. Can be one of `queued`, `in_progress`, or `completed`.", "in": "BODY", "type": "string", "required": false, - "enum": null, + "enum": ["queued", "in_progress", "completed"], "allowNull": false, "mapToData": null, "validation": null, @@ -22156,8 +15837,8 @@ "deprecated": null }, { - "name": "author.email", - "description": "The email of the author (or committer) of the commit", + "name": "started_at", + "description": "The time that the check run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "BODY", "type": "string", "required": false, @@ -22167,54 +15848,21 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"content\":null,\"commit\":{\"sha\":\"7638417db6d59f3c431d3e1f261cc637155684cd\",\"node_id\":\"MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd\",\"author\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"committer\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"message\":\"my commit message\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb\",\"sha\":\"691272480426f78a0138979dd3ce63b77f706feb\"},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\"sha\":\"1acc419d4d6a9ce985db7be48c6349a0475975b5\"}],\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List contributors", - "scope": "repos", - "id": "listContributors", - "method": "GET", - "url": "/repos/{owner}/{repo}/contributors", - "isDeprecated": false, - "isLegacy": false, - "description": "Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.\n\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.", - "documentationUrl": "https://developer.github.com/v3/repos/#list-contributors", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "owner parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "conclusion", + "description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.", + "in": "BODY", "type": "string", - "required": true, - "enum": null, + "required": false, + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required" + ], "allowNull": false, "mapToData": null, "validation": null, @@ -22222,9 +15870,9 @@ "deprecated": null }, { - "name": "anon", - "description": "Set to `1` or `true` to include anonymous contributors in results.", - "in": "QUERY", + "name": "completed_at", + "description": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "BODY", "type": "string", "required": false, "enum": null, @@ -22235,10 +15883,10 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", + "name": "output", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://developer.github.com/v3/checks/runs/#output-object) description.", + "in": "BODY", + "type": "object", "required": false, "enum": null, "allowNull": false, @@ -22248,49 +15896,9 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "Response if repository contains content", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false,\"contributions\":32}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List deployments", - "scope": "repos", - "id": "listDeployments", - "method": "GET", - "url": "/repos/{owner}/{repo}/deployments", - "isDeprecated": false, - "isLegacy": false, - "description": "Simple filtering of deployments is available via query parameters:", - "documentationUrl": "https://developer.github.com/v3/repos/deployments/#list-deployments", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "owner parameter", - "in": "PATH", + "name": "output.title", + "description": "The title of the check run.", + "in": "BODY", "type": "string", "required": true, "enum": null, @@ -22301,9 +15909,9 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "output.summary", + "description": "The summary of the check run. This parameter supports Markdown.", + "in": "BODY", "type": "string", "required": true, "enum": null, @@ -22314,22 +15922,9 @@ "deprecated": null }, { - "name": "sha", - "description": "The SHA recorded at creation time.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "ref", - "description": "The name of the ref. This can be a branch, tag, or SHA.", - "in": "QUERY", + "name": "output.text", + "description": "The details of the check run. This parameter supports Markdown.", + "in": "BODY", "type": "string", "required": false, "enum": null, @@ -22340,10 +15935,10 @@ "deprecated": null }, { - "name": "task", - "description": "The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`).", - "in": "QUERY", - "type": "string", + "name": "output.annotations", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible on GitHub in the **Checks** and **Files changed** tab of the pull request. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://developer.github.com/v3/checks/runs/#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about how you can view annotations on GitHub, see \"[About status checks](https://help.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://developer.github.com/v3/checks/runs/#annotations-object) description for details about how to use this parameter.", + "in": "BODY", + "type": "object[]", "required": false, "enum": null, "allowNull": false, @@ -22353,11 +15948,11 @@ "deprecated": null }, { - "name": "environment", - "description": "The name of the environment that was deployed to (e.g., `staging` or `production`).", - "in": "QUERY", + "name": "output.annotations[].path", + "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", + "in": "BODY", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -22366,11 +15961,11 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", + "name": "output.annotations[].start_line", + "description": "The start line of the annotation.", + "in": "BODY", "type": "integer", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -22379,51 +15974,24 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", + "name": "output.annotations[].end_line", + "description": "The end line of the annotation.", + "in": "BODY", "type": "integer", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/example/deployments/1\",\"id\":1,\"node_id\":\"MDEwOkRlcGxveW1lbnQx\",\"sha\":\"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"ref\":\"topic-branch\",\"task\":\"deploy\",\"payload\":{\"deploy\":\"migrate\"},\"original_environment\":\"staging\",\"environment\":\"production\",\"description\":\"Deploy request from hubot\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"statuses_url\":\"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"transient_environment\":false,\"production_environment\":true}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a deployment", - "scope": "repos", - "id": "createDeployment", - "method": "POST", - "url": "/repos/{owner}/{repo}/deployments", - "isDeprecated": false, - "isLegacy": false, - "description": "Deployments offer a few configurable parameters with sane defaults.\n\nThe `ref` parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them before we merge a pull request.\n\nThe `environment` parameter allows deployments to be issued to different runtime environments. Teams often have multiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter makes it easier to track which environments have requested deployments. The default environment is `production`.\n\nThe `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If the ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds, the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will return a failure response.\n\nBy default, [commit statuses](https://developer.github.com/v3/repos/statuses) for every submitted context must be in a `success` state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do not require any contexts or create any commit statuses, the deployment will always succeed.\n\nThe `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text field that will be passed on when a deployment event is dispatched.\n\nThe `task` parameter is used by the deployment system to allow different execution paths. In the web world this might be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an application with debugging enabled.\n\nUsers with `repo` or `repo_deployment` scopes can create a deployment for a given ref:\n\nA simple example putting the user and room into the payload to notify back to chat networks.\n\nA more advanced example specifying required commit statuses and bypassing auto-merging.\n\nYou will see this response when GitHub automatically merges the base branch into the topic branch instead of creating a deployment. This auto-merge happens when:\n\n* Auto-merge option is enabled in the repository\n* Topic branch does not include the latest changes on the base branch, which is `master`in the response example\n* There are no merge conflicts\n\nIf there are no new commits in the base branch, a new request to create a deployment should give a successful response.\n\nThis error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't be merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts.\n\nThis error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`.", - "documentationUrl": "https://developer.github.com/v3/repos/deployments/#create-a-deployment", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "owner", - "description": "owner parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "output.annotations[].start_column", + "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", + "in": "BODY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -22432,11 +16000,11 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "output.annotations[].end_column", + "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", + "in": "BODY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -22445,12 +16013,12 @@ "deprecated": null }, { - "name": "ref", - "description": "The ref to deploy. This can be a branch, tag, or SHA.", + "name": "output.annotations[].annotation_level", + "description": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.", "in": "BODY", "type": "string", "required": true, - "enum": null, + "enum": ["notice", "warning", "failure"], "allowNull": false, "mapToData": null, "validation": null, @@ -22458,11 +16026,11 @@ "deprecated": null }, { - "name": "task", - "description": "Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).", + "name": "output.annotations[].message", + "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", "in": "BODY", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -22471,10 +16039,10 @@ "deprecated": null }, { - "name": "auto_merge", - "description": "Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.", + "name": "output.annotations[].title", + "description": "The title that represents the annotation. The maximum size is 255 characters.", "in": "BODY", - "type": "boolean", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -22484,10 +16052,10 @@ "deprecated": null }, { - "name": "required_contexts", - "description": "The [status](https://developer.github.com/v3/repos/statuses/) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.", + "name": "output.annotations[].raw_details", + "description": "Details about this annotation. The maximum size is 64 KB.", "in": "BODY", - "type": "string[]", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -22497,10 +16065,10 @@ "deprecated": null }, { - "name": "payload", - "description": "JSON payload with extra information about the deployment.", + "name": "output.images", + "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://developer.github.com/v3/checks/runs/#images-object) description for details.", "in": "BODY", - "type": "string", + "type": "object[]", "required": false, "enum": null, "allowNull": false, @@ -22510,11 +16078,11 @@ "deprecated": null }, { - "name": "environment", - "description": "Name for the target deployment environment (e.g., `production`, `staging`, `qa`).", + "name": "output.images[].alt", + "description": "The alternative text for the image.", "in": "BODY", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -22523,11 +16091,11 @@ "deprecated": null }, { - "name": "description", - "description": "Short description of the deployment.", + "name": "output.images[].image_url", + "description": "The full URL of the image.", "in": "BODY", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -22536,10 +16104,10 @@ "deprecated": null }, { - "name": "transient_environment", - "description": "Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type.", + "name": "output.images[].caption", + "description": "A short image description.", "in": "BODY", - "type": "boolean", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -22549,10 +16117,10 @@ "deprecated": null }, { - "name": "production_environment", - "description": "Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type.", + "name": "actions", + "description": "Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://developer.github.com/v3/activity/events/types/#checkrunevent) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://developer.github.com/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions).\" To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions).\"", "in": "BODY", - "type": "boolean", + "type": "object[]", "required": false, "enum": null, "allowNull": false, @@ -22560,62 +16128,11 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/example/deployments/1\",\"id\":1,\"node_id\":\"MDEwOkRlcGxveW1lbnQx\",\"sha\":\"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"ref\":\"topic-branch\",\"task\":\"deploy\",\"payload\":{\"deploy\":\"migrate\"},\"original_environment\":\"staging\",\"environment\":\"production\",\"description\":\"Deploy request from hubot\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"statuses_url\":\"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"transient_environment\":false,\"production_environment\":true}" - }, - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/example/deployments/1\",\"id\":1,\"node_id\":\"MDEwOkRlcGxveW1lbnQx\",\"sha\":\"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"ref\":\"topic-branch\",\"task\":\"deploy\",\"payload\":{\"deploy\":\"migrate\"},\"original_environment\":\"staging\",\"environment\":\"production\",\"description\":\"Deploy request from hubot\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"statuses_url\":\"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"transient_environment\":false,\"production_environment\":true}" - } - ] - }, - { - "code": 202, - "description": "Merged branch response", - "examples": [ - { - "data": "{\"message\":\"Auto-merged master into topic-branch on deployment.\"}" - } - ] }, { - "code": 409, - "description": "response", - "examples": [ - { - "data": "{\"message\":\"Conflict merging master into topic-branch\"}" - }, - { - "data": "{\"message\":\"Conflict: Commit status checks failed for topic-branch.\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a single deployment", - "scope": "repos", - "id": "getDeployment", - "method": "GET", - "url": "/repos/{owner}/{repo}/deployments/{deployment_id}", - "isDeprecated": false, - "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/repos/deployments/#get-a-single-deployment", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "owner parameter", - "in": "PATH", + "name": "actions[].label", + "description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", + "in": "BODY", "type": "string", "required": true, "enum": null, @@ -22626,9 +16143,9 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "actions[].description", + "description": "A short explanation of what this action would do. The maximum size is 40 characters.", + "in": "BODY", "type": "string", "required": true, "enum": null, @@ -22639,10 +16156,10 @@ "deprecated": null }, { - "name": "deployment_id", - "description": "deployment_id parameter", - "in": "PATH", - "type": "integer", + "name": "actions[].identifier", + "description": "A reference for the action on the integrator's system. The maximum size is 20 characters.", + "in": "BODY", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -22654,11 +16171,14 @@ ], "responses": [ { - "code": 200, + "code": 201, "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/example/deployments/1\",\"id\":1,\"node_id\":\"MDEwOkRlcGxveW1lbnQx\",\"sha\":\"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"ref\":\"topic-branch\",\"task\":\"deploy\",\"payload\":{\"deploy\":\"migrate\"},\"original_environment\":\"staging\",\"environment\":\"production\",\"description\":\"Deploy request from hubot\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"statuses_url\":\"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"transient_environment\":false,\"production_environment\":true}" + "data": "{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"42\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"http://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"in_progress\",\"conclusion\":null,\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":null,\"output\":{\"title\":\"Mighty Readme Report\",\"summary\":\"\",\"text\":\"\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}" + }, + { + "data": "{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"http://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":\"2018-05-04T01:14:52Z\",\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}" } ] } @@ -22666,17 +16186,23 @@ "renamed": null }, { - "name": "List deployment statuses", - "scope": "repos", - "id": "listDeploymentStatuses", - "method": "GET", - "url": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", + "name": "Update a check run", + "scope": "checks", + "id": "update", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}", "isDeprecated": false, "isLegacy": false, - "description": "Users with pull access can view deployment statuses for a deployment:", - "documentationUrl": "https://developer.github.com/v3/repos/deployments/#list-deployment-statuses", - "previews": [], - "headers": [], + "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nUpdates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs.", + "documentationUrl": "https://developer.github.com/v3/checks/runs/#update-a-check-run", + "previews": [{ "name": "antiope" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.antiope-preview+json", + "required": true + } + ], "parameters": [ { "name": "owner", @@ -22705,8 +16231,8 @@ "deprecated": null }, { - "name": "deployment_id", - "description": "deployment_id parameter", + "name": "check_run_id", + "description": "check_run_id parameter", "in": "PATH", "type": "integer", "required": true, @@ -22718,10 +16244,10 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", + "name": "name", + "description": "The name of the check. For example, \"code-coverage\".", + "in": "BODY", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -22731,10 +16257,10 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", + "name": "details_url", + "description": "The URL of the integrator's site that has the full details of the check.", + "in": "BODY", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -22742,40 +16268,13 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/example/deployments/42/statuses/1\",\"id\":1,\"node_id\":\"MDE2OkRlcGxveW1lbnRTdGF0dXMx\",\"state\":\"success\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"description\":\"Deployment finished successfully.\",\"environment\":\"production\",\"target_url\":\"https://example.com/deployment/42/output\",\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"deployment_url\":\"https://api.github.com/repos/octocat/example/deployments/42\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"environment_url\":\"\",\"log_url\":\"https://example.com/deployment/42/output\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a deployment status", - "scope": "repos", - "id": "createDeploymentStatus", - "method": "POST", - "url": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", - "isDeprecated": false, - "isLegacy": false, - "description": "Users with `push` access can create deployment statuses for a given deployment.\n\nGitHub Apps require `read & write` access to \"Deployments\" and `read-only` access to \"Repo contents\" (for private repos). OAuth Apps require the `repo_deployment` scope.", - "documentationUrl": "https://developer.github.com/v3/repos/deployments/#create-a-deployment-status", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "owner", - "description": "owner parameter", - "in": "PATH", + "name": "external_id", + "description": "A reference for the run on the integrator's system.", + "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -22784,11 +16283,11 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "started_at", + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -22797,12 +16296,12 @@ "deprecated": null }, { - "name": "deployment_id", - "description": "deployment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, + "name": "status", + "description": "The current status. Can be one of `queued`, `in_progress`, or `completed`.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["queued", "in_progress", "completed"], "allowNull": false, "mapToData": null, "validation": null, @@ -22810,19 +16309,18 @@ "deprecated": null }, { - "name": "state", - "description": "The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued` `pending`, or `success`. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. To use the `in_progress` and `queued` states, you must provide the [`application/vnd.github.flash-preview+json`](https://developer.github.com/v3/previews/#deployment-statuses) custom media type.", + "name": "conclusion", + "description": "**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, or `action_required`. \n**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`.", "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": [ - "error", + "success", "failure", - "inactive", - "in_progress", - "queued", - "pending", - "success" + "neutral", + "cancelled", + "timed_out", + "action_required" ], "allowNull": false, "mapToData": null, @@ -22831,8 +16329,8 @@ "deprecated": null }, { - "name": "target_url", - "description": "The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`.", + "name": "completed_at", + "description": "The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "BODY", "type": "string", "required": false, @@ -22844,10 +16342,10 @@ "deprecated": null }, { - "name": "log_url", - "description": "The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `\"\"` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type.", + "name": "output", + "description": "Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run. See the [`output` object](https://developer.github.com/v3/checks/runs/#output-object-1) description.", "in": "BODY", - "type": "string", + "type": "object", "required": false, "enum": null, "allowNull": false, @@ -22857,8 +16355,8 @@ "deprecated": null }, { - "name": "description", - "description": "A short description of the status. The maximum description length is 140 characters.", + "name": "output.title", + "description": "**Required**.", "in": "BODY", "type": "string", "required": false, @@ -22870,12 +16368,12 @@ "deprecated": null }, { - "name": "environment", - "description": "Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. **Note:** This parameter requires you to use the [`application/vnd.github.flash-preview+json`](https://developer.github.com/v3/previews/#deployment-statuses) custom media type.", + "name": "output.summary", + "description": "Can contain Markdown.", "in": "BODY", "type": "string", - "required": false, - "enum": ["production", "staging", "qa"], + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -22883,8 +16381,8 @@ "deprecated": null }, { - "name": "environment_url", - "description": "Sets the URL for accessing your environment. Default: `\"\"` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type.", + "name": "output.text", + "description": "Can contain Markdown.", "in": "BODY", "type": "string", "required": false, @@ -22896,10 +16394,10 @@ "deprecated": null }, { - "name": "auto_inactive", - "description": "Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` \n**Note:** To add an `inactive` status to `production` environments, you must use the [`application/vnd.github.flash-preview+json`](https://developer.github.com/v3/previews/#deployment-statuses) custom media type. \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type.", + "name": "output.annotations", + "description": "Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://developer.github.com/v3/checks/runs/#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. For details about annotations in the UI, see \"[About status checks](https://help.github.com/articles/about-status-checks#checks)\". See the [`annotations` object](https://developer.github.com/v3/checks/runs/#annotations-object-1) description for details.", "in": "BODY", - "type": "boolean", + "type": "object[]", "required": false, "enum": null, "allowNull": false, @@ -22907,38 +16405,11 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/example/deployments/42/statuses/1\",\"id\":1,\"node_id\":\"MDE2OkRlcGxveW1lbnRTdGF0dXMx\",\"state\":\"success\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"description\":\"Deployment finished successfully.\",\"environment\":\"production\",\"target_url\":\"https://example.com/deployment/42/output\",\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"deployment_url\":\"https://api.github.com/repos/octocat/example/deployments/42\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"environment_url\":\"\",\"log_url\":\"https://example.com/deployment/42/output\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a single deployment status", - "scope": "repos", - "id": "getDeploymentStatus", - "method": "GET", - "url": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}", - "isDeprecated": false, - "isLegacy": false, - "description": "Users with pull access can view a deployment status for a deployment:", - "documentationUrl": "https://developer.github.com/v3/repos/deployments/#get-a-single-deployment-status", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "owner", - "description": "owner parameter", - "in": "PATH", + "name": "output.annotations[].path", + "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", + "in": "BODY", "type": "string", "required": true, "enum": null, @@ -22949,10 +16420,10 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", - "type": "string", + "name": "output.annotations[].start_line", + "description": "The start line of the annotation.", + "in": "BODY", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -22962,9 +16433,9 @@ "deprecated": null }, { - "name": "deployment_id", - "description": "deployment_id parameter", - "in": "PATH", + "name": "output.annotations[].end_line", + "description": "The end line of the annotation.", + "in": "BODY", "type": "integer", "required": true, "enum": null, @@ -22975,52 +16446,38 @@ "deprecated": null }, { - "name": "status_id", - "description": "status_id parameter", - "in": "PATH", + "name": "output.annotations[].start_column", + "description": "The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", + "in": "BODY", "type": "integer", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ + }, { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/example/deployments/42/statuses/1\",\"id\":1,\"node_id\":\"MDE2OkRlcGxveW1lbnRTdGF0dXMx\",\"state\":\"success\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"description\":\"Deployment finished successfully.\",\"environment\":\"production\",\"target_url\":\"https://example.com/deployment/42/output\",\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"deployment_url\":\"https://api.github.com/repos/octocat/example/deployments/42\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"environment_url\":\"\",\"log_url\":\"https://example.com/deployment/42/output\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a repository dispatch event", - "scope": "repos", - "id": "createDispatchEvent", - "method": "POST", - "url": "/repos/{owner}/{repo}/dispatches", - "isDeprecated": false, - "isLegacy": false, - "description": "You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see \"[RepositoryDispatchEvent](https://developer.github.com/v3/activity/events/types/#repositorydispatchevent).\"\n\nThe `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. For a test example, see the [input example](https://developer.github.com/v3/repos/#example-4).\n\nTo give you write access to the repository, you must use a personal access token with the `repo` scope. For more information, see \"[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line)\" in the GitHub Help documentation.\n\nThis input example shows how you can use the `client_payload` as a test to debug your workflow.", - "documentationUrl": "https://developer.github.com/v3/repos/#create-a-repository-dispatch-event", - "previews": [], - "headers": [], - "parameters": [ + "name": "output.annotations[].end_column", + "description": "The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.", + "in": "BODY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { - "name": "owner", - "description": "owner parameter", - "in": "PATH", + "name": "output.annotations[].annotation_level", + "description": "The level of the annotation. Can be one of `notice`, `warning`, or `failure`.", + "in": "BODY", "type": "string", "required": true, - "enum": null, + "enum": ["notice", "warning", "failure"], "allowNull": false, "mapToData": null, "validation": null, @@ -23028,9 +16485,9 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "output.annotations[].message", + "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", + "in": "BODY", "type": "string", "required": true, "enum": null, @@ -23041,8 +16498,8 @@ "deprecated": null }, { - "name": "event_type", - "description": "**Required:** A custom webhook event name.", + "name": "output.annotations[].title", + "description": "The title that represents the annotation. The maximum size is 255 characters.", "in": "BODY", "type": "string", "required": false, @@ -23054,10 +16511,10 @@ "deprecated": null }, { - "name": "client_payload", - "description": "JSON payload with extra information about the webhook event that your action or worklow may use.", + "name": "output.annotations[].raw_details", + "description": "Details about this annotation. The maximum size is 64 KB.", "in": "BODY", - "type": "object", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -23065,30 +16522,13 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "List downloads for a repository", - "scope": "repos", - "id": "listDownloads", - "method": "GET", - "url": "/repos/{owner}/{repo}/downloads", - "isDeprecated": false, - "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/repos/downloads/#list-downloads-for-a-repository", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "owner", - "description": "owner parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "output.images", + "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://developer.github.com/v3/checks/runs/#annotations-object-1) description for details.", + "in": "BODY", + "type": "object[]", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -23097,9 +16537,22 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "output.images[].alt", + "description": "The alternative text for the image.", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "output.images[].image_url", + "description": "The full URL of the image.", + "in": "BODY", "type": "string", "required": true, "enum": null, @@ -23110,10 +16563,10 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", + "name": "output.images[].caption", + "description": "A short image description.", + "in": "BODY", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -23123,10 +16576,10 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", + "name": "actions", + "description": "Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://developer.github.com/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see \"[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions).\"", + "in": "BODY", + "type": "object[]", "required": false, "enum": null, "allowNull": false, @@ -23134,38 +16587,11 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/downloads/1\",\"html_url\":\"https://github.com/repos/octocat/Hello-World/downloads/new_file.jpg\",\"id\":1,\"name\":\"new_file.jpg\",\"description\":\"Description of your download\",\"size\":1024,\"download_count\":40,\"content_type\":\".jpg\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a single download", - "scope": "repos", - "id": "getDownload", - "method": "GET", - "url": "/repos/{owner}/{repo}/downloads/{download_id}", - "isDeprecated": false, - "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/repos/downloads/#get-a-single-download", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "owner", - "description": "owner parameter", - "in": "PATH", + "name": "actions[].label", + "description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", + "in": "BODY", "type": "string", "required": true, "enum": null, @@ -23176,9 +16602,9 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "actions[].description", + "description": "A short explanation of what this action would do. The maximum size is 40 characters.", + "in": "BODY", "type": "string", "required": true, "enum": null, @@ -23189,10 +16615,10 @@ "deprecated": null }, { - "name": "download_id", - "description": "download_id parameter", - "in": "PATH", - "type": "integer", + "name": "actions[].identifier", + "description": "A reference for the action on the integrator's system. The maximum size is 20 characters.", + "in": "BODY", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -23208,7 +16634,7 @@ "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/downloads/1\",\"html_url\":\"https://github.com/repos/octocat/Hello-World/downloads/new_file.jpg\",\"id\":1,\"name\":\"new_file.jpg\",\"description\":\"Description of your download\",\"size\":1024,\"download_count\":40,\"content_type\":\".jpg\"}" + "data": "{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"http://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":\"2018-05-04T01:14:52Z\",\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}" } ] } @@ -23216,17 +16642,23 @@ "renamed": null }, { - "name": "Delete a download", - "scope": "repos", - "id": "deleteDownload", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/downloads/{download_id}", + "name": "Get a single check run", + "scope": "checks", + "id": "get", + "method": "GET", + "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/repos/downloads/#delete-a-download", - "previews": [], - "headers": [], + "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nGets a single check run using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.", + "documentationUrl": "https://developer.github.com/v3/checks/runs/#get-a-single-check-run", + "previews": [{ "name": "antiope" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.antiope-preview+json", + "required": true + } + ], "parameters": [ { "name": "owner", @@ -23255,8 +16687,8 @@ "deprecated": null }, { - "name": "download_id", - "description": "download_id parameter", + "name": "check_run_id", + "description": "check_run_id parameter", "in": "PATH", "type": "integer", "required": true, @@ -23268,90 +16700,37 @@ "deprecated": null } ], - "responses": [], - "renamed": null - }, - { - "name": "List repository events", - "scope": "activity", - "id": "listRepoEvents", - "method": "GET", - "url": "/repos/{owner}/{repo}/events", - "isDeprecated": false, - "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/activity/events/#list-repository-events", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "owner parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "repo parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, + "responses": [ { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null + "code": 200, + "description": "response", + "examples": [ + { + "data": "{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"http://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":\"2018-05-04T01:14:52Z\",\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}" + } + ] } ], - "responses": [], "renamed": null }, { - "name": "List forks", - "scope": "repos", - "id": "listForks", + "name": "List annotations for a check run", + "scope": "checks", + "id": "listAnnotations", "method": "GET", - "url": "/repos/{owner}/{repo}/forks", + "url": "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/repos/forks/#list-forks", - "previews": [], - "headers": [], + "description": "Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository.", + "documentationUrl": "https://developer.github.com/v3/checks/runs/#list-annotations-for-a-check-run", + "previews": [{ "name": "antiope" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.antiope-preview+json", + "required": true + } + ], "parameters": [ { "name": "owner", @@ -23380,12 +16759,12 @@ "deprecated": null }, { - "name": "sort", - "description": "The sort order. Can be either `newest`, `oldest`, or `stargazers`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["newest", "oldest", "stargazers"], + "name": "check_run_id", + "description": "check_run_id parameter", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -23425,7 +16804,7 @@ "description": "response", "examples": [ { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":true,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"}}]" + "data": "[{\"path\":\"README.md\",\"start_line\":2,\"end_line\":2,\"start_column\":5,\"end_column\":10,\"annotation_level\":\"warning\",\"title\":\"Spell Checker\",\"message\":\"Check your spelling for 'banaas'.\",\"raw_details\":\"Do you mean 'bananas' or 'banana'?\"}]" } ] } @@ -23433,17 +16812,23 @@ "renamed": null }, { - "name": "Create a fork", - "scope": "repos", - "id": "createFork", + "name": "Create a check suite", + "scope": "checks", + "id": "createSuite", "method": "POST", - "url": "/repos/{owner}/{repo}/forks", + "url": "/repos/{owner}/{repo}/check-suites", "isDeprecated": false, "isLegacy": false, - "description": "Create a fork for the authenticated user.\n\n**Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://github.com/contact) or [GitHub Premium Support](https://premium.githubsupport.com).", - "documentationUrl": "https://developer.github.com/v3/repos/forks/#create-a-fork", - "previews": [], - "headers": [], + "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nBy default, check suites are automatically created when you create a [check run](https://developer.github.com/v3/checks/runs/). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"[Set preferences for check suites on a repository](https://developer.github.com/v3/checks/suites/#set-preferences-for-check-suites-on-a-repository)\". Your GitHub App must have the `checks:write` permission to create check suites.", + "documentationUrl": "https://developer.github.com/v3/checks/suites/#create-a-check-suite", + "previews": [{ "name": "antiope" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.antiope-preview+json", + "required": true + } + ], "parameters": [ { "name": "owner", @@ -23472,11 +16857,11 @@ "deprecated": null }, { - "name": "organization", - "description": "Optional parameter to specify the organization name if forking into an organization.", + "name": "head_sha", + "description": "The sha of the head commit.", "in": "BODY", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -23487,11 +16872,11 @@ ], "responses": [ { - "code": 202, + "code": 201, "description": "response", "examples": [ { - "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":true,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}" + "data": "{\"id\":5,\"node_id\":\"MDEwOkNoZWNrU3VpdGU1\",\"head_branch\":\"master\",\"head_sha\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"url\":\"https://api.github.com/repos/github/hello-world/check-suites/5\",\"before\":\"146e867f55c26428e5f9fade55a9bbf5e95a7912\",\"after\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"pull_requests\":[],\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}" } ] } @@ -23499,17 +16884,23 @@ "renamed": null }, { - "name": "Create a blob", - "scope": "git", - "id": "createBlob", - "method": "POST", - "url": "/repos/{owner}/{repo}/git/blobs", + "name": "Set preferences for check suites on a repository", + "scope": "checks", + "id": "setSuitesPreferences", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/check-suites/preferences", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/git/blobs/#create-a-blob", - "previews": [], - "headers": [], + "description": "Changes the default automatic flow when creating check suites. By default, the CheckSuiteEvent is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://developer.github.com/v3/checks/suites/#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites.", + "documentationUrl": "https://developer.github.com/v3/checks/suites/#set-preferences-for-check-suites-on-a-repository", + "previews": [{ "name": "antiope" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.antiope-preview+json", + "required": true + } + ], "parameters": [ { "name": "owner", @@ -23538,10 +16929,23 @@ "deprecated": null }, { - "name": "content", - "description": "The new blob's content.", + "name": "auto_trigger_checks", + "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://developer.github.com/v3/checks/suites/#auto_trigger_checks-object) description for details.", "in": "BODY", - "type": "string", + "type": "object[]", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "auto_trigger_checks[].app_id", + "description": "The `id` of the GitHub App.", + "in": "BODY", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -23551,11 +16955,11 @@ "deprecated": null }, { - "name": "encoding", - "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "name": "auto_trigger_checks[].setting", + "description": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", "in": "BODY", - "type": "string", - "required": false, + "type": "boolean", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -23566,11 +16970,11 @@ ], "responses": [ { - "code": 201, + "code": 200, "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15\",\"sha\":\"3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15\"}" + "data": "{\"preferences\":{\"auto_trigger_checks\":[{\"app_id\":2,\"setting\":true},{\"app_id\":4,\"setting\":false}]},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}" } ] } @@ -23578,17 +16982,23 @@ "renamed": null }, { - "name": "Get a blob", - "scope": "git", - "id": "getBlob", + "name": "Get a single check suite", + "scope": "checks", + "id": "getSuite", "method": "GET", - "url": "/repos/{owner}/{repo}/git/blobs/{file_sha}", + "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}", "isDeprecated": false, "isLegacy": false, - "description": "The `content` in the response will always be Base64 encoded.\n\n_Note_: This API supports blobs up to 100 megabytes in size.", - "documentationUrl": "https://developer.github.com/v3/git/blobs/#get-a-blob", - "previews": [], - "headers": [], + "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nGets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository.", + "documentationUrl": "https://developer.github.com/v3/checks/suites/#get-a-single-check-suite", + "previews": [{ "name": "antiope" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.antiope-preview+json", + "required": true + } + ], "parameters": [ { "name": "owner", @@ -23617,10 +17027,10 @@ "deprecated": null }, { - "name": "file_sha", - "description": "file_sha parameter", + "name": "check_suite_id", + "description": "check_suite_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -23636,7 +17046,7 @@ "description": "response", "examples": [ { - "data": "{\"content\":\"Q29udGVudCBvZiB0aGUgYmxvYg==\\n\",\"encoding\":\"base64\",\"url\":\"https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15\",\"sha\":\"3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15\",\"size\":19}" + "data": "{\"id\":5,\"node_id\":\"MDEwOkNoZWNrU3VpdGU1\",\"head_branch\":\"master\",\"head_sha\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"url\":\"https://api.github.com/repos/github/hello-world/check-suites/5\",\"before\":\"146e867f55c26428e5f9fade55a9bbf5e95a7912\",\"after\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"pull_requests\":[],\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}" } ] } @@ -23644,17 +17054,23 @@ "renamed": null }, { - "name": "Create a commit", - "scope": "git", - "id": "createCommit", - "method": "POST", - "url": "/repos/{owner}/{repo}/git/commits", + "name": "List check runs in a check suite", + "scope": "checks", + "id": "listForSuite", + "method": "GET", + "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", "isDeprecated": false, "isLegacy": false, - "description": "Creates a new Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects).\n\nIn this example, the payload of the signature would be:\n\n\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", - "documentationUrl": "https://developer.github.com/v3/git/commits/#create-a-commit", - "previews": [], - "headers": [], + "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.", + "documentationUrl": "https://developer.github.com/v3/checks/runs/#list-check-runs-in-a-check-suite", + "previews": [{ "name": "antiope" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.antiope-preview+json", + "required": true + } + ], "parameters": [ { "name": "owner", @@ -23683,36 +17099,10 @@ "deprecated": null }, { - "name": "message", - "description": "The commit message", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tree", - "description": "The SHA of the tree object this commit points to", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "parents", - "description": "The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.", - "in": "BODY", - "type": "string[]", + "name": "check_suite_id", + "description": "check_suite_id parameter", + "in": "PATH", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -23722,48 +17112,9 @@ "deprecated": null }, { - "name": "author", - "description": "Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "author.name", - "description": "The name of the author (or committer) of the commit", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "author.email", - "description": "The email of the author (or committer) of the commit", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "author.date", - "description": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "BODY", + "name": "check_name", + "description": "Returns check runs with the specified `name`.", + "in": "QUERY", "type": "string", "required": false, "enum": null, @@ -23774,25 +17125,12 @@ "deprecated": null }, { - "name": "committer", - "description": "Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "committer.name", - "description": "The name of the author (or committer) of the commit", - "in": "BODY", + "name": "status", + "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`.", + "in": "QUERY", "type": "string", "required": false, - "enum": null, + "enum": ["queued", "in_progress", "completed"], "allowNull": false, "mapToData": null, "validation": null, @@ -23800,12 +17138,12 @@ "deprecated": null }, { - "name": "committer.email", - "description": "The email of the author (or committer) of the commit", - "in": "BODY", + "name": "filter", + "description": "Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`.", + "in": "QUERY", "type": "string", "required": false, - "enum": null, + "enum": ["latest", "all"], "allowNull": false, "mapToData": null, "validation": null, @@ -23813,10 +17151,10 @@ "deprecated": null }, { - "name": "committer.date", - "description": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "BODY", - "type": "string", + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -23826,10 +17164,10 @@ "deprecated": null }, { - "name": "signature", - "description": "The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits.", - "in": "BODY", - "type": "string", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -23841,11 +17179,11 @@ ], "responses": [ { - "code": 201, + "code": 200, "description": "response", "examples": [ { - "data": "{\"sha\":\"7638417db6d59f3c431d3e1f261cc637155684cd\",\"node_id\":\"MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd\",\"author\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"committer\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"message\":\"my commit message\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/827efc6d56897b048c772eb4087f854f46256132\",\"sha\":\"827efc6d56897b048c772eb4087f854f46256132\"},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7d1b31e74ee336d15cbd21741bc88a537ed063a0\",\"sha\":\"7d1b31e74ee336d15cbd21741bc88a537ed063a0\"}],\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}" + "data": "{\"total_count\":1,\"check_runs\":[{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"http://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":\"2018-05-04T01:14:52Z\",\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}]}" } ] } @@ -23853,17 +17191,23 @@ "renamed": null }, { - "name": "Get a commit", - "scope": "git", - "id": "getCommit", - "method": "GET", - "url": "/repos/{owner}/{repo}/git/commits/{commit_sha}", + "name": "Rerequest check suite", + "scope": "checks", + "id": "rerequestSuite", + "method": "POST", + "url": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest", "isDeprecated": false, "isLegacy": false, - "description": "Gets a Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", - "documentationUrl": "https://developer.github.com/v3/git/commits/#get-a-commit", - "previews": [], - "headers": [], + "description": "Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://developer.github.com/v3/activity/events/types/#checksuiteevent) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nTo rerequest a check suite, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.", + "documentationUrl": "https://developer.github.com/v3/checks/suites/#rerequest-check-suite", + "previews": [{ "name": "antiope" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.antiope-preview+json", + "required": true + } + ], "parameters": [ { "name": "owner", @@ -23892,42 +17236,32 @@ "deprecated": null }, { - "name": "commit_sha", - "description": "commit_sha parameter", + "name": "check_suite_id", + "description": "check_suite_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"sha\":\"7638417db6d59f3c431d3e1f261cc637155684cd\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd\",\"author\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"committer\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"message\":\"added readme, because im a good github citizen\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb\",\"sha\":\"691272480426f78a0138979dd3ce63b77f706feb\"},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\"sha\":\"1acc419d4d6a9ce985db7be48c6349a0475975b5\"}],\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}" - } - ] + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], + "responses": [], "renamed": null }, { - "name": "List matching references", - "scope": "git", - "id": "listMatchingRefs", + "name": "List collaborators", + "scope": "repos", + "id": "listCollaborators", "method": "GET", - "url": "/repos/{owner}/{repo}/git/matching-refs/{ref}", + "url": "/repos/{owner}/{repo}/collaborators", "isDeprecated": false, "isLegacy": false, - "description": "Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.\n\nWhen you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`.\n\n**Note:** You need to explicitly [request a pull request](https://developer.github.com/v3/pulls/#get-a-single-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://developer.github.com/v3/git/#checking-mergeability-of-pull-requests)\".\n\nIf you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`.", - "documentationUrl": "https://developer.github.com/v3/git/refs/#list-matching-references", + "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\n\nTeam members will include the members of child teams.", + "documentationUrl": "https://developer.github.com/v3/repos/collaborators/#list-collaborators", "previews": [], "headers": [], "parameters": [ @@ -23958,12 +17292,12 @@ "deprecated": null }, { - "name": "ref", - "description": "ref parameter", - "in": "PATH", + "name": "affiliation", + "description": "Filter collaborators returned by their affiliation. Can be one of: \n\\* `outside`: All outside collaborators of an organization-owned repository. \n\\* `direct`: All collaborators with permissions to an organization-owned repository, regardless of organization membership status. \n\\* `all`: All collaborators the authenticated user can see.", + "in": "QUERY", "type": "string", - "required": true, - "enum": null, + "required": false, + "enum": ["outside", "direct", "all"], "allowNull": false, "mapToData": null, "validation": null, @@ -24003,7 +17337,7 @@ "description": "response", "examples": [ { - "data": "[{\"ref\":\"refs/heads/feature-a\",\"node_id\":\"MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlLWE=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-a\",\"object\":{\"type\":\"commit\",\"sha\":\"aa218f56b14c9653891f9e74264a383fa43fefbd\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd\"}},{\"ref\":\"refs/heads/feature-b\",\"node_id\":\"MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlLWI=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-b\",\"object\":{\"type\":\"commit\",\"sha\":\"612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac\"}}]" + "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false,\"permissions\":{\"pull\":true,\"push\":true,\"admin\":false}}]" } ] } @@ -24011,15 +17345,15 @@ "renamed": null }, { - "name": "Get a single reference", - "scope": "git", - "id": "getRef", + "name": "Check if a user is a collaborator", + "scope": "repos", + "id": "checkCollaborator", "method": "GET", - "url": "/repos/{owner}/{repo}/git/ref/{ref}", + "url": "/repos/{owner}/{repo}/collaborators/{username}", "isDeprecated": false, "isLegacy": false, - "description": "Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.\n\n**Note:** You need to explicitly [request a pull request](https://developer.github.com/v3/pulls/#get-a-single-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://developer.github.com/v3/git/#checking-mergeability-of-pull-requests)\".\n\nTo get the reference for a branch named `skunkworkz/featureA`, the endpoint route is:", - "documentationUrl": "https://developer.github.com/v3/git/refs/#get-a-single-reference", + "description": "For organization-owned repositories, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners.\n\nTeam members will include the members of child teams.", + "documentationUrl": "https://developer.github.com/v3/repos/collaborators/#check-if-a-user-is-a-collaborator", "previews": [], "headers": [], "parameters": [ @@ -24050,8 +17384,8 @@ "deprecated": null }, { - "name": "ref", - "description": "ref parameter", + "name": "username", + "description": "username parameter", "in": "PATH", "type": "string", "required": true, @@ -24063,29 +17397,19 @@ "deprecated": null } ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"ref\":\"refs/heads/featureA\",\"node_id\":\"MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA\",\"object\":{\"type\":\"commit\",\"sha\":\"aa218f56b14c9653891f9e74264a383fa43fefbd\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd\"}}" - } - ] - } - ], + "responses": [], "renamed": null }, { - "name": "Create a reference", - "scope": "git", - "id": "createRef", - "method": "POST", - "url": "/repos/{owner}/{repo}/git/refs", + "name": "Add user as a collaborator", + "scope": "repos", + "id": "addCollaborator", + "method": "PUT", + "url": "/repos/{owner}/{repo}/collaborators/{username}", "isDeprecated": false, "isLegacy": false, - "description": "Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.", - "documentationUrl": "https://developer.github.com/v3/git/refs/#create-a-reference", + "description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\"\n\nThe invitee will receive a notification that they have been invited to the repository, which they must accept or decline. They may do this via the notifications page, the email they receive, or by using the [repository invitations API endpoints](https://developer.github.com/v3/repos/invitations/).\n\n**Rate limits**\n\nTo prevent abuse, you are limited to sending 50 invitations to a repository per 24 hour period. Note there is no limit if you are inviting organization members to an organization repository.", + "documentationUrl": "https://developer.github.com/v3/repos/collaborators/#add-user-as-a-collaborator", "previews": [], "headers": [], "parameters": [ @@ -24116,9 +17440,9 @@ "deprecated": null }, { - "name": "ref", - "description": "The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.", - "in": "BODY", + "name": "username", + "description": "username parameter", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -24129,12 +17453,12 @@ "deprecated": null }, { - "name": "sha", - "description": "The SHA1 value for this reference.", + "name": "permission", + "description": "The permission to grant the collaborator. **Only valid on organization-owned repositories.** Can be one of: \n\\* `pull` - can pull, but not push to or administer this repository. \n\\* `push` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push and administer this repository.", "in": "BODY", "type": "string", - "required": true, - "enum": null, + "required": false, + "enum": ["pull", "push", "admin"], "allowNull": false, "mapToData": null, "validation": null, @@ -24145,10 +17469,10 @@ "responses": [ { "code": 201, - "description": "response", + "description": "Response when a new invitation is created", "examples": [ { - "data": "{\"ref\":\"refs/heads/featureA\",\"node_id\":\"MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA\",\"object\":{\"type\":\"commit\",\"sha\":\"aa218f56b14c9653891f9e74264a383fa43fefbd\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd\"}}" + "data": "{\"id\":1,\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\"},\"invitee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"inviter\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"permissions\":\"write\",\"created_at\":\"2016-06-13T14:52:50-05:00\",\"url\":\"https://api.github.com/user/repository_invitations/1296269\",\"html_url\":\"https://github.com/octocat/Hello-World/invitations\"}" } ] } @@ -24156,15 +17480,15 @@ "renamed": null }, { - "name": "Update a reference", - "scope": "git", - "id": "updateRef", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/git/refs/{ref}", + "name": "Remove user as a collaborator", + "scope": "repos", + "id": "removeCollaborator", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/collaborators/{username}", "isDeprecated": false, "isLegacy": false, "description": "", - "documentationUrl": "https://developer.github.com/v3/git/refs/#update-a-reference", + "documentationUrl": "https://developer.github.com/v3/repos/collaborators/#remove-user-as-a-collaborator", "previews": [], "headers": [], "parameters": [ @@ -24195,8 +17519,8 @@ "deprecated": null }, { - "name": "ref", - "description": "ref parameter", + "name": "username", + "description": "username parameter", "in": "PATH", "type": "string", "required": true, @@ -24206,57 +17530,21 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "sha", - "description": "The SHA1 value to set this reference to", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "force", - "description": "Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"ref\":\"refs/heads/featureA\",\"node_id\":\"MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA\",\"object\":{\"type\":\"commit\",\"sha\":\"aa218f56b14c9653891f9e74264a383fa43fefbd\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd\"}}" - } - ] } ], + "responses": [], "renamed": null }, { - "name": "Delete a reference", - "scope": "git", - "id": "deleteRef", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/git/refs/{ref}", + "name": "Review a user's permission level", + "scope": "repos", + "id": "getCollaboratorPermissionLevel", + "method": "GET", + "url": "/repos/{owner}/{repo}/collaborators/{username}/permission", "isDeprecated": false, "isLegacy": false, - "description": "```\nDELETE /repos/octocat/Hello-World/git/refs/heads/feature-a\n```\n\n```\nDELETE /repos/octocat/Hello-World/git/refs/tags/v1.0\n```", - "documentationUrl": "https://developer.github.com/v3/git/refs/#delete-a-reference", + "description": "Possible values for the `permission` key: `admin`, `write`, `read`, `none`.", + "documentationUrl": "https://developer.github.com/v3/repos/collaborators/#review-a-users-permission-level", "previews": [], "headers": [], "parameters": [ @@ -24287,8 +17575,8 @@ "deprecated": null }, { - "name": "ref", - "description": "ref parameter", + "name": "username", + "description": "username parameter", "in": "PATH", "type": "string", "required": true, @@ -24300,19 +17588,29 @@ "deprecated": null } ], - "responses": [], + "responses": [ + { + "code": 200, + "description": "Response if user has admin permissions", + "examples": [ + { + "data": "{\"permission\":\"admin\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" + } + ] + } + ], "renamed": null }, { - "name": "Create a tag object", - "scope": "git", - "id": "createTag", - "method": "POST", - "url": "/repos/{owner}/{repo}/git/tags", + "name": "List commit comments for a repository", + "scope": "repos", + "id": "listCommitComments", + "method": "GET", + "url": "/repos/{owner}/{repo}/comments", "isDeprecated": false, "isLegacy": false, - "description": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://developer.github.com/v3/git/refs/#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://developer.github.com/v3/git/refs/#create-a-reference) the tag reference - this call would be unnecessary.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", - "documentationUrl": "https://developer.github.com/v3/git/tags/#create-a-tag-object", + "description": "Commit Comments use [these custom media types](https://developer.github.com/v3/repos/comments/#custom-media-types). You can read more about the use of media types in the API [here](https://developer.github.com/v3/media/).\n\nComments are ordered by ascending ID.\n\n", + "documentationUrl": "https://developer.github.com/v3/repos/comments/#list-commit-comments-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -24343,88 +17641,10 @@ "deprecated": null }, { - "name": "tag", - "description": "The tag's name. This is typically a version (e.g., \"v0.0.1\").", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "message", - "description": "The tag message.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "object", - "description": "The SHA of the git object this is tagging.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "type", - "description": "The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`.", - "in": "BODY", - "type": "string", - "required": true, - "enum": ["commit", "tree", "blob"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tagger", - "description": "An object with information about the individual creating the tag.", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tagger.name", - "description": "The name of the author of the tag", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "tagger.email", - "description": "The email of the author of the tag", - "in": "BODY", - "type": "string", + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -24434,10 +17654,10 @@ "deprecated": null }, { - "name": "tagger.date", - "description": "When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "BODY", - "type": "string", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -24449,11 +17669,11 @@ ], "responses": [ { - "code": 201, + "code": 200, "description": "response", "examples": [ { - "data": "{\"node_id\":\"MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==\",\"tag\":\"v0.0.1\",\"sha\":\"940bd336248efae0f9ee5bc7b2d5c985887b16ac\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac\",\"message\":\"initial version\",\"tagger\":{\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\",\"date\":\"2014-11-07T22:01:45Z\"},\"object\":{\"type\":\"commit\",\"sha\":\"c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c\"},\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}" + "data": "[{\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/comments/1\",\"id\":1,\"node_id\":\"MDEzOkNvbW1pdENvbW1lbnQx\",\"body\":\"Great stuff\",\"path\":\"file1.txt\",\"position\":4,\"line\":14,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}]" } ] } @@ -24461,15 +17681,15 @@ "renamed": null }, { - "name": "Get a tag", - "scope": "git", - "id": "getTag", + "name": "Get a single commit comment", + "scope": "repos", + "id": "getCommitComment", "method": "GET", - "url": "/repos/{owner}/{repo}/git/tags/{tag_sha}", + "url": "/repos/{owner}/{repo}/comments/{comment_id}", "isDeprecated": false, "isLegacy": false, - "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", - "documentationUrl": "https://developer.github.com/v3/git/tags/#get-a-tag", + "description": "", + "documentationUrl": "https://developer.github.com/v3/repos/comments/#get-a-single-commit-comment", "previews": [], "headers": [], "parameters": [ @@ -24500,10 +17720,10 @@ "deprecated": null }, { - "name": "tag_sha", - "description": "tag_sha parameter", + "name": "comment_id", + "description": "comment_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -24519,7 +17739,7 @@ "description": "response", "examples": [ { - "data": "{\"node_id\":\"MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==\",\"tag\":\"v0.0.1\",\"sha\":\"940bd336248efae0f9ee5bc7b2d5c985887b16ac\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac\",\"message\":\"initial version\",\"tagger\":{\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\",\"date\":\"2014-11-07T22:01:45Z\"},\"object\":{\"type\":\"commit\",\"sha\":\"c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c\"},\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}" + "data": "{\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/comments/1\",\"id\":1,\"node_id\":\"MDEzOkNvbW1pdENvbW1lbnQx\",\"body\":\"Great stuff\",\"path\":\"file1.txt\",\"position\":4,\"line\":14,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}" } ] } @@ -24527,15 +17747,15 @@ "renamed": null }, { - "name": "Create a tree", - "scope": "git", - "id": "createTree", - "method": "POST", - "url": "/repos/{owner}/{repo}/git/trees", + "name": "Update a commit comment", + "scope": "repos", + "id": "updateCommitComment", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/comments/{comment_id}", "isDeprecated": false, "isLegacy": false, - "description": "The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.\n\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"[Create a commit](https://developer.github.com/v3/git/commits/#create-a-commit)\" and \"[Update a reference](https://developer.github.com/v3/git/refs/#update-a-reference).\"", - "documentationUrl": "https://developer.github.com/v3/git/trees/#create-a-tree", + "description": "", + "documentationUrl": "https://developer.github.com/v3/repos/comments/#update-a-commit-comment", "previews": [], "headers": [], "parameters": [ @@ -24566,10 +17786,10 @@ "deprecated": null }, { - "name": "tree", - "description": "Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure.", - "in": "BODY", - "type": "object[]", + "name": "comment_id", + "description": "comment_id parameter", + "in": "PATH", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -24579,63 +17799,64 @@ "deprecated": null }, { - "name": "tree[].path", - "description": "The file referenced in the tree.", + "name": "body", + "description": "The contents of the comment", "in": "BODY", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - }, - { - "name": "tree[].mode", - "description": "The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["100644", "100755", "040000", "160000", "120000"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, + } + ], + "responses": [ { - "name": "tree[].type", - "description": "Either `blob`, `tree`, or `commit`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["blob", "tree", "commit"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, + "code": 200, + "description": "response", + "examples": [ + { + "data": "{\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/comments/1\",\"id\":1,\"node_id\":\"MDEzOkNvbW1pdENvbW1lbnQx\",\"body\":\"Nice change\",\"path\":\"file1.txt\",\"position\":4,\"line\":14,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Delete a commit comment", + "scope": "repos", + "id": "deleteCommitComment", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/comments/{comment_id}", + "isDeprecated": false, + "isLegacy": false, + "description": "", + "documentationUrl": "https://developer.github.com/v3/repos/comments/#delete-a-commit-comment", + "previews": [], + "headers": [], + "parameters": [ { - "name": "tree[].sha", - "description": "The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", - "in": "BODY", + "name": "owner", + "description": "owner parameter", + "in": "PATH", "type": "string", - "required": false, + "required": true, "enum": null, - "allowNull": true, + "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null }, { - "name": "tree[].content", - "description": "The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", - "in": "BODY", + "name": "repo", + "description": "repo parameter", + "in": "PATH", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -24644,11 +17865,11 @@ "deprecated": null }, { - "name": "base_tree", - "description": "The SHA1 of the tree you want to update with new data. If you don't set this, the commit will be created on top of everything; however, it will only contain your change, the rest of your files will show up as deleted.", - "in": "BODY", - "type": "string", - "required": false, + "name": "comment_id", + "description": "comment_id parameter", + "in": "PATH", + "type": "integer", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -24657,31 +17878,27 @@ "deprecated": null } ], - "responses": [ - { - "code": 201, - "description": "response", - "examples": [ - { - "data": "{\"sha\":\"cd8274d15fa3ae2ab983129fb037999f264ba9a7\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7\",\"tree\":[{\"path\":\"file.rb\",\"mode\":\"100644\",\"type\":\"blob\",\"size\":132,\"sha\":\"7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b\"}]}" - } - ] - } - ], + "responses": [], "renamed": null }, { - "name": "Get a tree", - "scope": "git", - "id": "getTree", + "name": "List reactions for a commit comment", + "scope": "reactions", + "id": "listForCommitComment", "method": "GET", - "url": "/repos/{owner}/{repo}/git/trees/{tree_sha}", + "url": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", "isDeprecated": false, "isLegacy": false, - "description": "Returns a single tree using the SHA1 value for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, you can clone the repository and iterate over the Git data locally.", - "documentationUrl": "https://developer.github.com/v3/git/trees/#get-a-tree", - "previews": [], - "headers": [], + "description": "List the reactions to a [commit comment](https://developer.github.com/v3/repos/comments/).", + "documentationUrl": "https://developer.github.com/v3/reactions/#list-reactions-for-a-commit-comment", + "previews": [{ "name": "squirrel-girl" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.squirrel-girl-preview+json", + "required": true + } + ], "parameters": [ { "name": "owner", @@ -24710,10 +17927,10 @@ "deprecated": null }, { - "name": "tree_sha", - "description": "tree_sha parameter", + "name": "comment_id", + "description": "comment_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -24723,12 +17940,47 @@ "deprecated": null }, { - "name": "recursive", - "description": "recursive parameter", + "name": "content", + "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a commit comment.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "per_page", + "description": "Results per page (max 100)", "in": "QUERY", "type": "integer", "required": false, - "enum": ["1"], + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -24739,10 +17991,10 @@ "responses": [ { "code": 200, - "description": "If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, you can clone the repository and iterate over the Git data locally.", + "description": "response", "examples": [ { - "data": "{\"sha\":\"9fb037999f264ba9a7fc6274d15fa3ae2ab98312\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/trees/9fb037999f264ba9a7fc6274d15fa3ae2ab98312\",\"tree\":[{\"path\":\"file.rb\",\"mode\":\"100644\",\"type\":\"blob\",\"size\":30,\"sha\":\"44b4fc6d56897b048c772eb4087f854f46256132\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132\"},{\"path\":\"subdir\",\"mode\":\"040000\",\"type\":\"tree\",\"sha\":\"f484d249c660418515fb01c2b9662073663c242e\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/f484d249c660418515fb01c2b9662073663c242e\"},{\"path\":\"exec_file\",\"mode\":\"100755\",\"type\":\"blob\",\"size\":75,\"sha\":\"45b983be36b73c0788dc9cbcb76cbb80fc7bb057\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/45b983be36b73c0788dc9cbcb76cbb80fc7bb057\"}],\"truncated\":false}" + "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" } ] } @@ -24750,17 +18002,23 @@ "renamed": null }, { - "name": "List hooks", - "scope": "repos", - "id": "listHooks", - "method": "GET", - "url": "/repos/{owner}/{repo}/hooks", + "name": "Create reaction for a commit comment", + "scope": "reactions", + "id": "createForCommitComment", + "method": "POST", + "url": "/repos/{owner}/{repo}/comments/{comment_id}/reactions", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/repos/hooks/#list-hooks", - "previews": [], - "headers": [], + "description": "Create a reaction to a [commit comment](https://developer.github.com/v3/repos/comments/). A response with a `Status: 200 OK` means that you already added the reaction type to this commit comment.", + "documentationUrl": "https://developer.github.com/v3/reactions/#create-reaction-for-a-commit-comment", + "previews": [{ "name": "squirrel-girl" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.squirrel-girl-preview+json", + "required": true + } + ], "parameters": [ { "name": "owner", @@ -24789,11 +18047,11 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", + "name": "comment_id", + "description": "comment_id parameter", + "in": "PATH", "type": "integer", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -24802,12 +18060,21 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, + "name": "content", + "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the commit comment.", + "in": "BODY", + "type": "string", + "required": true, + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], "allowNull": false, "mapToData": null, "validation": null, @@ -24817,11 +18084,11 @@ ], "responses": [ { - "code": 200, + "code": 201, "description": "response", "examples": [ { - "data": "[{\"type\":\"Repository\",\"id\":12345678,\"name\":\"web\",\"active\":true,\"events\":[\"push\",\"pull_request\"],\"config\":{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"url\":\"https://example.com/webhook\"},\"updated_at\":\"2019-06-03T00:57:16Z\",\"created_at\":\"2019-06-03T00:57:16Z\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678\",\"test_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test\",\"ping_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings\",\"last_response\":{\"code\":null,\"status\":\"unused\",\"message\":null}}]" + "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" } ] } @@ -24829,15 +18096,15 @@ "renamed": null }, { - "name": "Create a hook", + "name": "List commits on a repository", "scope": "repos", - "id": "createHook", - "method": "POST", - "url": "/repos/{owner}/{repo}/hooks", + "id": "listCommits", + "method": "GET", + "url": "/repos/{owner}/{repo}/commits", "isDeprecated": false, "isLegacy": false, - "description": "Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can share the same `config` as long as those webhooks do not have any `events` that overlap.\n\nHere's how you can create a hook that posts payloads in JSON format:", - "documentationUrl": "https://developer.github.com/v3/repos/hooks/#create-a-hook", + "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "documentationUrl": "https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository", "previews": [], "headers": [], "parameters": [ @@ -24868,9 +18135,9 @@ "deprecated": null }, { - "name": "name", - "description": "Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`.", - "in": "BODY", + "name": "sha", + "description": "SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`).", + "in": "QUERY", "type": "string", "required": false, "enum": null, @@ -24881,24 +18148,11 @@ "deprecated": null }, { - "name": "config", - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/repos/hooks/#create-hook-config-params).", - "in": "BODY", - "type": "object", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "config.url", - "description": "The URL to which the payloads will be delivered.", - "in": "BODY", + "name": "path", + "description": "Only commits containing this file path will be returned.", + "in": "QUERY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -24907,9 +18161,9 @@ "deprecated": null }, { - "name": "config.content_type", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "in": "BODY", + "name": "author", + "description": "GitHub login or email address by which to filter by commit author.", + "in": "QUERY", "type": "string", "required": false, "enum": null, @@ -24920,9 +18174,9 @@ "deprecated": null }, { - "name": "config.secret", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/webhooks/#delivery-headers) header.", - "in": "BODY", + "name": "since", + "description": "Only commits after this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "QUERY", "type": "string", "required": false, "enum": null, @@ -24933,9 +18187,9 @@ "deprecated": null }, { - "name": "config.insecure_ssl", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "in": "BODY", + "name": "until", + "description": "Only commits before this date will be returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "QUERY", "type": "string", "required": false, "enum": null, @@ -24946,10 +18200,10 @@ "deprecated": null }, { - "name": "events", - "description": "Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for.", - "in": "BODY", - "type": "string[]", + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -24959,10 +18213,10 @@ "deprecated": null }, { - "name": "active", - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "in": "BODY", - "type": "boolean", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -24974,11 +18228,11 @@ ], "responses": [ { - "code": 201, + "code": 200, "description": "response", "examples": [ { - "data": "{\"type\":\"Repository\",\"id\":12345678,\"name\":\"web\",\"active\":true,\"events\":[\"push\",\"pull_request\"],\"config\":{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"url\":\"https://example.com/webhook\"},\"updated_at\":\"2019-06-03T00:57:16Z\",\"created_at\":\"2019-06-03T00:57:16Z\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678\",\"test_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test\",\"ping_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings\",\"last_response\":{\"code\":null,\"status\":\"unused\",\"message\":null}}" + "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}]}]" } ] } @@ -24986,17 +18240,23 @@ "renamed": null }, { - "name": "Get single hook", + "name": "List branches for HEAD commit", "scope": "repos", - "id": "getHook", + "id": "listBranchesForHeadCommit", "method": "GET", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}", + "url": "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/repos/hooks/#get-single-hook", - "previews": [], - "headers": [], + "description": "Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nReturns all branches where the given commit SHA is the HEAD, or latest commit for the branch.", + "documentationUrl": "https://developer.github.com/v3/repos/commits/#list-branches-for-head-commit", + "previews": [{ "name": "groot" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.groot-preview+json", + "required": true + } + ], "parameters": [ { "name": "owner", @@ -25025,10 +18285,10 @@ "deprecated": null }, { - "name": "hook_id", - "description": "hook_id parameter", + "name": "commit_sha", + "description": "commit_sha parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -25044,7 +18304,7 @@ "description": "response", "examples": [ { - "data": "{\"type\":\"Repository\",\"id\":12345678,\"name\":\"web\",\"active\":true,\"events\":[\"push\",\"pull_request\"],\"config\":{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"url\":\"https://example.com/webhook\"},\"updated_at\":\"2019-06-03T00:57:16Z\",\"created_at\":\"2019-06-03T00:57:16Z\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678\",\"test_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test\",\"ping_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings\",\"last_response\":{\"code\":null,\"status\":\"unused\",\"message\":null}}" + "data": "[{\"name\":\"branch_5\",\"commit\":{\"sha\":\"c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\"},\"protected\":\"false\"}]" } ] } @@ -25052,15 +18312,15 @@ "renamed": null }, { - "name": "Edit a hook", + "name": "List comments for a single commit", "scope": "repos", - "id": "updateHook", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}", + "id": "listCommentsForCommit", + "method": "GET", + "url": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/repos/hooks/#edit-a-hook", + "description": "Use the `:commit_sha` to specify the commit that will have its comments listed.\n\n", + "documentationUrl": "https://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit", "previews": [], "headers": [], "parameters": [ @@ -25091,10 +18351,10 @@ "deprecated": null }, { - "name": "hook_id", - "description": "hook_id parameter", + "name": "commit_sha", + "description": "commit_sha parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -25104,10 +18364,10 @@ "deprecated": null }, { - "name": "config", - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/repos/hooks/#create-hook-config-params).", - "in": "BODY", - "type": "object", + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -25117,24 +18377,51 @@ "deprecated": null }, { - "name": "config.url", - "description": "The URL to which the payloads will be delivered.", - "in": "BODY", - "type": "string", - "required": true, + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "config.content_type", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "in": "BODY", + "code": 200, + "description": "response", + "examples": [ + { + "data": "[{\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/comments/1\",\"id\":1,\"node_id\":\"MDEzOkNvbW1pdENvbW1lbnQx\",\"body\":\"Great stuff\",\"path\":\"file1.txt\",\"position\":4,\"line\":14,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}]" + } + ] + } + ], + "renamed": null + }, + { + "name": "Create a commit comment", + "scope": "repos", + "id": "createCommitComment", + "method": "POST", + "url": "/repos/{owner}/{repo}/commits/{commit_sha}/comments", + "isDeprecated": false, + "isLegacy": false, + "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.", + "documentationUrl": "https://developer.github.com/v3/repos/comments/#create-a-commit-comment", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "owner parameter", + "in": "PATH", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -25143,11 +18430,11 @@ "deprecated": null }, { - "name": "config.secret", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/webhooks/#delivery-headers) header.", - "in": "BODY", + "name": "repo", + "description": "repo parameter", + "in": "PATH", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -25156,11 +18443,11 @@ "deprecated": null }, { - "name": "config.insecure_ssl", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "in": "BODY", + "name": "commit_sha", + "description": "commit_sha parameter", + "in": "PATH", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -25169,11 +18456,11 @@ "deprecated": null }, { - "name": "events", - "description": "Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for. This replaces the entire array of events.", + "name": "body", + "description": "The contents of the comment.", "in": "BODY", - "type": "string[]", - "required": false, + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -25182,10 +18469,10 @@ "deprecated": null }, { - "name": "add_events", - "description": "Determines a list of events to be added to the list of events that the Hook triggers for.", + "name": "path", + "description": "Relative path of the file to comment on.", "in": "BODY", - "type": "string[]", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -25195,10 +18482,10 @@ "deprecated": null }, { - "name": "remove_events", - "description": "Determines a list of events to be removed from the list of events that the Hook triggers for.", + "name": "position", + "description": "Line index in the diff to comment on.", "in": "BODY", - "type": "string[]", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -25208,10 +18495,10 @@ "deprecated": null }, { - "name": "active", - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "name": "line", + "description": "**Deprecated**. Use **position** parameter instead. Line number in the file to comment on.", "in": "BODY", - "type": "boolean", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -25223,11 +18510,11 @@ ], "responses": [ { - "code": 200, + "code": 201, "description": "response", "examples": [ { - "data": "{\"type\":\"Repository\",\"id\":12345678,\"name\":\"web\",\"active\":true,\"events\":[\"push\",\"pull_request\"],\"config\":{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"url\":\"https://example.com/webhook\"},\"updated_at\":\"2019-06-03T00:57:16Z\",\"created_at\":\"2019-06-03T00:57:16Z\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678\",\"test_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test\",\"ping_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings\",\"last_response\":{\"code\":null,\"status\":\"unused\",\"message\":null}}" + "data": "{\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/comments/1\",\"id\":1,\"node_id\":\"MDEzOkNvbW1pdENvbW1lbnQx\",\"body\":\"Great stuff\",\"path\":\"file1.txt\",\"position\":4,\"line\":14,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}" } ] } @@ -25235,17 +18522,23 @@ "renamed": null }, { - "name": "Delete a hook", + "name": "List pull requests associated with commit", "scope": "repos", - "id": "deleteHook", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}", + "id": "listPullRequestsAssociatedWithCommit", + "method": "GET", + "url": "/repos/{owner}/{repo}/commits/{commit_sha}/pulls", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/repos/hooks/#delete-a-hook", - "previews": [], - "headers": [], + "description": "Lists all pull requests containing the provided commit SHA, which can be from any point in the commit history. The results will include open and closed pull requests. Additional preview headers may be required to see certain details for associated pull requests, such as whether a pull request is in a draft state. For more information about previews that might affect this endpoint, see the [List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests) endpoint.", + "documentationUrl": "https://developer.github.com/v3/repos/commits/#list-pull-requests-associated-with-commit", + "previews": [{ "name": "groot" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.groot-preview+json", + "required": true + } + ], "parameters": [ { "name": "owner", @@ -25274,38 +18567,8 @@ "deprecated": null }, { - "name": "hook_id", - "description": "hook_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "Ping a hook", - "scope": "repos", - "id": "pingHook", - "method": "POST", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}/pings", - "isDeprecated": false, - "isLegacy": false, - "description": "This will trigger a [ping event](https://developer.github.com/webhooks/#ping-event) to be sent to the hook.", - "documentationUrl": "https://developer.github.com/v3/repos/hooks/#ping-a-hook", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "owner parameter", + "name": "commit_sha", + "description": "commit_sha parameter", "in": "PATH", "type": "string", "required": true, @@ -25317,11 +18580,11 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -25330,11 +18593,11 @@ "deprecated": null }, { - "name": "hook_id", - "description": "hook_id parameter", - "in": "PATH", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", "type": "integer", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -25343,19 +18606,29 @@ "deprecated": null } ], - "responses": [], + "responses": [ + { + "code": 200, + "description": "response", + "examples": [ + { + "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"draft\":false}]" + } + ] + } + ], "renamed": null }, { - "name": "Test a push hook", + "name": "Get a single commit", "scope": "repos", - "id": "testPushHook", - "method": "POST", - "url": "/repos/{owner}/{repo}/hooks/{hook_id}/tests", + "id": "getCommit", + "method": "GET", + "url": "/repos/{owner}/{repo}/commits/{ref}", "isDeprecated": false, "isLegacy": false, - "description": "This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated.\n\n**Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test`", - "documentationUrl": "https://developer.github.com/v3/repos/hooks/#test-a-push-hook", + "description": "Returns the contents of a single commit reference. You must have `read` access for the repository to use this endpoint.\n\nYou can pass the appropriate [media type](https://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests) to fetch `diff` and `patch` formats. Diffs with binary data will have no `patch` property.\n\nTo return only the SHA-1 hash of the commit reference, you can provide the `sha` custom [media type](https://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests) in the `Accept` header. You can use this endpoint to check if a remote reference's SHA-1 hash is the same as your local reference's SHA-1 hash by providing the local SHA-1 reference as the ETag.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |\n\n", + "documentationUrl": "https://developer.github.com/v3/repos/commits/#get-a-single-commit", "previews": [], "headers": [], "parameters": [ @@ -25386,10 +18659,10 @@ "deprecated": null }, { - "name": "hook_id", - "description": "hook_id parameter", + "name": "ref", + "description": "ref parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -25399,21 +18672,37 @@ "deprecated": null } ], - "responses": [], + "responses": [ + { + "code": 200, + "description": "response", + "examples": [ + { + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}],\"stats\":{\"additions\":104,\"deletions\":4,\"total\":108},\"files\":[{\"filename\":\"file1.txt\",\"additions\":10,\"deletions\":2,\"changes\":12,\"status\":\"modified\",\"raw_url\":\"https://github.com/octocat/Hello-World/raw/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt\",\"blob_url\":\"https://github.com/octocat/Hello-World/blob/7ca483543807a51b6079e54ac4cc392bc29ae284/file1.txt\",\"patch\":\"@@ -29,7 +29,7 @@\\n.....\"}]}" + } + ] + } + ], "renamed": null }, { - "name": "Start an import", - "scope": "migrations", - "id": "startImport", - "method": "PUT", - "url": "/repos/{owner}/{repo}/import", + "name": "List check runs for a specific ref", + "scope": "checks", + "id": "listForRef", + "method": "GET", + "url": "/repos/{owner}/{repo}/commits/{ref}/check-runs", "isDeprecated": false, "isLegacy": false, - "description": "Start a source import to a GitHub repository using GitHub Importer.", - "documentationUrl": "https://developer.github.com/v3/migrations/source_imports/#start-an-import", - "previews": [], - "headers": [], + "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a commit ref. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.", + "documentationUrl": "https://developer.github.com/v3/checks/runs/#list-check-runs-for-a-specific-ref", + "previews": [{ "name": "antiope" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.antiope-preview+json", + "required": true + } + ], "parameters": [ { "name": "owner", @@ -25442,9 +18731,9 @@ "deprecated": null }, { - "name": "vcs_url", - "description": "The URL of the originating repository.", - "in": "BODY", + "name": "ref", + "description": "ref parameter", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -25455,12 +18744,12 @@ "deprecated": null }, { - "name": "vcs", - "description": "The originating VCS type. Can be one of `subversion`, `git`, `mercurial`, or `tfvc`. Please be aware that without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response.", - "in": "BODY", + "name": "check_name", + "description": "Returns check runs with the specified `name`.", + "in": "QUERY", "type": "string", "required": false, - "enum": ["subversion", "git", "mercurial", "tfvc"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -25468,12 +18757,12 @@ "deprecated": null }, { - "name": "vcs_username", - "description": "If authentication is required, the username to provide to `vcs_url`.", - "in": "BODY", + "name": "status", + "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`.", + "in": "QUERY", "type": "string", "required": false, - "enum": null, + "enum": ["queued", "in_progress", "completed"], "allowNull": false, "mapToData": null, "validation": null, @@ -25481,11 +18770,24 @@ "deprecated": null }, { - "name": "vcs_password", - "description": "If authentication is required, the password to provide to `vcs_url`.", - "in": "BODY", + "name": "filter", + "description": "Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`.", + "in": "QUERY", "type": "string", "required": false, + "enum": ["latest", "all"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -25494,10 +18796,10 @@ "deprecated": null }, { - "name": "tfvc_project", - "description": "For a tfvc import, the name of the project that is being imported.", - "in": "BODY", - "type": "string", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -25509,11 +18811,11 @@ ], "responses": [ { - "code": 201, + "code": 200, "description": "response", "examples": [ { - "data": "{\"vcs\":\"subversion\",\"use_lfs\":\"undecided\",\"vcs_url\":\"http://svn.mycompany.com/svn/myproject\",\"status\":\"importing\",\"status_text\":\"Importing...\",\"has_large_files\":false,\"large_files_size\":0,\"large_files_count\":0,\"authors_count\":0,\"percent\":42,\"commit_count\":1042,\"url\":\"https://api.github.com/repos/octocat/socm/import\",\"html_url\":\"https://import.github.com/octocat/socm/import\",\"authors_url\":\"https://api.github.com/repos/octocat/socm/import/authors\",\"repository_url\":\"https://api.github.com/repos/octocat/socm\"}" + "data": "{\"total_count\":1,\"check_runs\":[{\"id\":4,\"head_sha\":\"ce587453ced02b1526dfb4cb910479d431683101\",\"node_id\":\"MDg6Q2hlY2tSdW40\",\"external_id\":\"\",\"url\":\"https://api.github.com/repos/github/hello-world/check-runs/4\",\"html_url\":\"http://github.com/github/hello-world/runs/4\",\"details_url\":\"https://example.com\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"started_at\":\"2018-05-04T01:14:52Z\",\"completed_at\":\"2018-05-04T01:14:52Z\",\"output\":{\"title\":\"Mighty Readme report\",\"summary\":\"There are 0 failures, 2 warnings, and 1 notice.\",\"text\":\"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\"annotations_count\":2,\"annotations_url\":\"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"},\"name\":\"mighty_readme\",\"check_suite\":{\"id\":5},\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"pull_requests\":[{\"url\":\"https://api.github.com/repos/github/hello-world/pulls/1\",\"id\":1934,\"number\":3956,\"head\":{\"ref\":\"say-hello\",\"sha\":\"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}},\"base\":{\"ref\":\"master\",\"sha\":\"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\"repo\":{\"id\":526,\"url\":\"https://api.github.com/repos/github/hello-world\",\"name\":\"hello-world\"}}}]}]}" } ] } @@ -25521,17 +18823,23 @@ "renamed": null }, { - "name": "Get import progress", - "scope": "migrations", - "id": "getImportProgress", + "name": "List check suites for a specific ref", + "scope": "checks", + "id": "listSuitesForRef", "method": "GET", - "url": "/repos/{owner}/{repo}/import", + "url": "/repos/{owner}/{repo}/commits/{ref}/check-suites", "isDeprecated": false, "isLegacy": false, - "description": "View the progress of an import.\n\n**Import status**\n\nThis section includes details about the possible values of the `status` field of the Import Progress response.\n\nAn import that does not have errors will progress through these steps:\n\n* `detecting` - the \"detection\" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL.\n* `importing` - the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import).\n* `mapping` - the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.\n* `pushing` - the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is \"Writing objects\".\n* `complete` - the import is complete, and the repository is ready on GitHub.\n\nIf there are problems, you will see one of these in the `status` field:\n\n* `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update Existing Import](https://developer.github.com/v3/migrations/source_imports/#update-existing-import) section.\n* `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://github.com/contact) or [GitHub Premium Support](https://premium.githubsupport.com) for more information.\n* `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update Existing Import](https://developer.github.com/v3/migrations/source_imports/#update-existing-import) section.\n* `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://developer.github.com/v3/migrations/source_imports/#cancel-an-import) and [retry](https://developer.github.com/v3/migrations/source_imports/#start-an-import) with the correct URL.\n* `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update Existing Import](https://developer.github.com/v3/migrations/source_imports/#update-existing-import) section.\n\n**The project_choices field**\n\nWhen multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.\n\n**Git LFS related fields**\n\nThis section includes details about Git LFS related fields that may be present in the Import Progress response.\n\n* `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken.\n* `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step.\n* `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository.\n* `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request.", - "documentationUrl": "https://developer.github.com/v3/migrations/source_imports/#get-import-progress", - "previews": [], - "headers": [], + "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nLists check suites for a commit `ref`. The `ref` can be a SHA, branch name, or a tag name. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to list check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository.", + "documentationUrl": "https://developer.github.com/v3/checks/suites/#list-check-suites-for-a-specific-ref", + "previews": [{ "name": "antiope" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.antiope-preview+json", + "required": true + } + ], "parameters": [ { "name": "owner", @@ -25558,40 +18866,26 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ + }, { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"vcs\":\"subversion\",\"use_lfs\":\"opt_in\",\"vcs_url\":\"http://svn.mycompany.com/svn/myproject\",\"status\":\"complete\",\"status_text\":\"Done\",\"has_large_files\":true,\"large_files_size\":132331036,\"large_files_count\":1,\"authors_count\":4,\"url\":\"https://api.github.com/repos/octocat/socm/import\",\"html_url\":\"https://import.github.com/octocat/socm/import\",\"authors_url\":\"https://api.github.com/repos/octocat/socm/import/authors\",\"repository_url\":\"https://api.github.com/repos/octocat/socm\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Update existing import", - "scope": "migrations", - "id": "updateImport", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/import", - "isDeprecated": false, - "isLegacy": false, - "description": "An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API request. If no parameters are provided, the import will be restarted.\n\nSome servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array. You can select the project to import by providing one of the objects in the `project_choices` array in the update request.\n\nThe following example demonstrates the workflow for updating an import with \"project1\" as the project choice. Given a `project_choices` array like such:\n\nTo restart an import, no parameters are provided in the update request.", - "documentationUrl": "https://developer.github.com/v3/migrations/source_imports/#update-existing-import", - "previews": [], - "headers": [], - "parameters": [ + "name": "ref", + "description": "ref parameter", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { - "name": "owner", - "description": "owner parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "app_id", + "description": "Filters check suites by GitHub App `id`.", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -25600,11 +18894,11 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "check_name", + "description": "Filters checks suites by the name of the [check run](https://developer.github.com/v3/checks/runs/).", + "in": "QUERY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -25613,10 +18907,10 @@ "deprecated": null }, { - "name": "vcs_username", - "description": "The username to provide to the originating repository.", - "in": "BODY", - "type": "string", + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -25626,10 +18920,10 @@ "deprecated": null }, { - "name": "vcs_password", - "description": "The password to provide to the originating repository.", - "in": "BODY", - "type": "string", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -25645,13 +18939,7 @@ "description": "response", "examples": [ { - "data": "{\"vcs\":\"subversion\",\"use_lfs\":\"undecided\",\"vcs_url\":\"http://svn.mycompany.com/svn/myproject\",\"status\":\"detecting\",\"url\":\"https://api.github.com/repos/octocat/socm/import\",\"html_url\":\"https://import.github.com/octocat/socm/import\",\"authors_url\":\"https://api.github.com/repos/octocat/socm/import/authors\",\"repository_url\":\"https://api.github.com/repos/octocat/socm\"}" - }, - { - "data": "{\"vcs\":\"tfvc\",\"use_lfs\":\"undecided\",\"vcs_url\":\"http://tfs.mycompany.com/tfs/myproject\",\"tfvc_project\":\"project1\",\"status\":\"importing\",\"status_text\":\"Importing...\",\"has_large_files\":false,\"large_files_size\":0,\"large_files_count\":0,\"authors_count\":0,\"percent\":42,\"commit_count\":1042,\"url\":\"https://api.github.com/repos/octocat/socm/import\",\"html_url\":\"https://import.github.com/octocat/socm/import\",\"authors_url\":\"https://api.github.com/repos/octocat/socm/import/authors\",\"repository_url\":\"https://api.github.com/repos/octocat/socm\"}" - }, - { - "data": "{\"vcs\":\"subversion\",\"use_lfs\":\"undecided\",\"vcs_url\":\"http://svn.mycompany.com/svn/myproject\",\"status\":\"importing\",\"status_text\":\"Importing...\",\"has_large_files\":false,\"large_files_size\":0,\"large_files_count\":0,\"authors_count\":0,\"percent\":42,\"commit_count\":1042,\"url\":\"https://api.github.com/repos/octocat/socm/import\",\"html_url\":\"https://import.github.com/octocat/socm/import\",\"authors_url\":\"https://api.github.com/repos/octocat/socm/import/authors\",\"repository_url\":\"https://api.github.com/repos/octocat/socm\"}" + "data": "{\"total_count\":1,\"check_suites\":[{\"id\":5,\"node_id\":\"MDEwOkNoZWNrU3VpdGU1\",\"head_branch\":\"master\",\"head_sha\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"status\":\"completed\",\"conclusion\":\"neutral\",\"url\":\"https://api.github.com/repos/github/hello-world/check-suites/5\",\"before\":\"146e867f55c26428e5f9fade55a9bbf5e95a7912\",\"after\":\"d6fde92930d4715a2b49857d24b940956b26d2d3\",\"pull_requests\":[],\"app\":{\"id\":1,\"slug\":\"octoapp\",\"node_id\":\"MDExOkludGVncmF0aW9uMQ==\",\"owner\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\"},\"name\":\"Octocat App\",\"description\":\"\",\"external_url\":\"https://example.com\",\"html_url\":\"https://github.com/apps/octoapp\",\"created_at\":\"2017-07-08T16:18:44-04:00\",\"updated_at\":\"2017-07-08T16:18:44-04:00\",\"permissions\":{\"metadata\":\"read\",\"contents\":\"read\",\"issues\":\"write\",\"single_file\":\"write\"},\"events\":[\"push\",\"pull_request\"]},\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}}]}" } ] } @@ -25659,15 +18947,15 @@ "renamed": null }, { - "name": "Cancel an import", - "scope": "migrations", - "id": "cancelImport", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/import", + "name": "Get the combined status for a specific ref", + "scope": "repos", + "id": "getCombinedStatusForRef", + "method": "GET", + "url": "/repos/{owner}/{repo}/commits/{ref}/status", "isDeprecated": false, "isLegacy": false, - "description": "Stop an import for a repository.", - "documentationUrl": "https://developer.github.com/v3/migrations/source_imports/#cancel-an-import", + "description": "Users with pull access in a repository can access a combined view of commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name.\n\nThe most recent status for each context is returned, up to 100. This field [paginates](https://developer.github.com/v3/#pagination) if there are over 100 contexts.\n\nAdditionally, a combined `state` is returned. The `state` is one of:\n\n* **failure** if any of the contexts report as `error` or `failure`\n* **pending** if there are no statuses or a context is `pending`\n* **success** if the latest status for all contexts is `success`", + "documentationUrl": "https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref", "previews": [], "headers": [], "parameters": [ @@ -25696,40 +18984,10 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "Get commit authors", - "scope": "migrations", - "id": "getCommitAuthors", - "method": "GET", - "url": "/repos/{owner}/{repo}/import/authors", - "isDeprecated": false, - "isLegacy": false, - "description": "Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `.\n\nThis API method and the \"Map a commit author\" method allow you to provide correct Git author information.", - "documentationUrl": "https://developer.github.com/v3/migrations/source_imports/#get-commit-authors", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "owner parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null }, { - "name": "repo", - "description": "repo parameter", + "name": "ref", + "description": "ref parameter", "in": "PATH", "type": "string", "required": true, @@ -25739,19 +18997,6 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "since", - "description": "Only authors found after this id are returned. Provide the highest author ID you've seen so far. New authors may be added to the list at any point while the importer is performing the `raw` step.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null } ], "responses": [ @@ -25760,7 +19005,7 @@ "description": "response", "examples": [ { - "data": "[{\"id\":2268557,\"remote_id\":\"nobody@fc7da526-431c-80fe-3c8c-c148ff18d7ef\",\"remote_name\":\"nobody\",\"email\":\"hubot@github.com\",\"name\":\"Hubot\",\"url\":\"https://api.github.com/repos/octocat/socm/import/authors/2268557\",\"import_url\":\"https://api.github.com/repos/octocat/socm/import\"},{\"id\":2268558,\"remote_id\":\"svner@fc7da526-431c-80fe-3c8c-c148ff18d7ef\",\"remote_name\":\"svner\",\"email\":\"svner@fc7da526-431c-80fe-3c8c-c148ff18d7ef\",\"name\":\"svner\",\"url\":\"https://api.github.com/repos/octocat/socm/import/authors/2268558\",\"import_url\":\"https://api.github.com/repos/octocat/socm/import\"},{\"id\":2268559,\"remote_id\":\"svner@example.com@fc7da526-431c-80fe-3c8c-c148ff18d7ef\",\"remote_name\":\"svner@example.com\",\"email\":\"svner@example.com@fc7da526-431c-80fe-3c8c-c148ff18d7ef\",\"name\":\"svner@example.com\",\"url\":\"https://api.github.com/repos/octocat/socm/import/authors/2268559\",\"import_url\":\"https://api.github.com/repos/octocat/socm/import\"}]" + "data": "{\"state\":\"success\",\"statuses\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"id\":1,\"node_id\":\"MDY6U3RhdHVzMQ==\",\"state\":\"success\",\"description\":\"Build has completed successfully\",\"target_url\":\"https://ci.example.com/1000/output\",\"context\":\"continuous-integration/jenkins\",\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\"},{\"url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"id\":2,\"node_id\":\"MDY6U3RhdHVzMg==\",\"state\":\"success\",\"description\":\"Testing has completed successfully\",\"target_url\":\"https://ci.example.com/2000/output\",\"context\":\"security/brakeman\",\"created_at\":\"2012-08-20T01:19:13Z\",\"updated_at\":\"2012-08-20T01:19:13Z\"}],\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"total_count\":2,\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\"},\"commit_url\":\"https://api.github.com/repos/octocat/Hello-World/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/6dcb09b5b57875f334f61aebed695e2e4193db5e/status\"}" } ] } @@ -25768,15 +19013,15 @@ "renamed": null }, { - "name": "Map a commit author", - "scope": "migrations", - "id": "mapCommitAuthor", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/import/authors/{author_id}", + "name": "List statuses for a specific ref", + "scope": "repos", + "id": "listStatusesForRef", + "method": "GET", + "url": "/repos/{owner}/{repo}/commits/{ref}/statuses", "isDeprecated": false, "isLegacy": false, - "description": "Update an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository.", - "documentationUrl": "https://developer.github.com/v3/migrations/source_imports/#map-a-commit-author", + "description": "Users with pull access in a repository can view commit statuses for a given ref. The ref can be a SHA, a branch name, or a tag name. Statuses are returned in reverse chronological order. The first status in the list will be the latest one.\n\nThis resource is also available via a legacy route: `GET /repos/:owner/:repo/statuses/:ref`.", + "documentationUrl": "https://developer.github.com/v3/repos/statuses/#list-statuses-for-a-specific-ref", "previews": [], "headers": [], "parameters": [ @@ -25807,10 +19052,10 @@ "deprecated": null }, { - "name": "author_id", - "description": "author_id parameter", + "name": "ref", + "description": "ref parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -25820,10 +19065,10 @@ "deprecated": null }, { - "name": "email", - "description": "The new Git author email.", - "in": "BODY", - "type": "string", + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -25833,10 +19078,10 @@ "deprecated": null }, { - "name": "name", - "description": "The new Git author name.", - "in": "BODY", - "type": "string", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -25852,7 +19097,7 @@ "description": "response", "examples": [ { - "data": "{\"id\":2268557,\"remote_id\":\"nobody@fc7da526-431c-80fe-3c8c-c148ff18d7ef\",\"remote_name\":\"nobody\",\"email\":\"hubot@github.com\",\"name\":\"Hubot\",\"url\":\"https://api.github.com/repos/octocat/socm/import/authors/2268557\",\"import_url\":\"https://api.github.com/repos/octocat/socm/import\"}" + "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"id\":1,\"node_id\":\"MDY6U3RhdHVzMQ==\",\"state\":\"success\",\"description\":\"Build has completed successfully\",\"target_url\":\"https://ci.example.com/1000/output\",\"context\":\"continuous-integration/jenkins\",\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]" } ] } @@ -25860,17 +19105,23 @@ "renamed": null }, { - "name": "Get large files", - "scope": "migrations", - "id": "getLargeFiles", + "name": "Get the contents of a repository's code of conduct", + "scope": "codesOfConduct", + "id": "getForRepo", "method": "GET", - "url": "/repos/{owner}/{repo}/import/large_files", + "url": "/repos/{owner}/{repo}/community/code_of_conduct", "isDeprecated": false, "isLegacy": false, - "description": "List files larger than 100MB found during the import", - "documentationUrl": "https://developer.github.com/v3/migrations/source_imports/#get-large-files", - "previews": [], - "headers": [], + "description": "This method returns the contents of the repository's code of conduct file, if one is detected.", + "documentationUrl": "https://developer.github.com/v3/codes_of_conduct/#get-the-contents-of-a-repositorys-code-of-conduct", + "previews": [{ "name": "scarlet-witch" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.scarlet-witch-preview+json", + "required": true + } + ], "parameters": [ { "name": "owner", @@ -25905,7 +19156,7 @@ "description": "response", "examples": [ { - "data": "[{\"ref_name\":\"refs/heads/master\",\"path\":\"foo/bar/1\",\"oid\":\"d3d9446802a44259755d38e6d163e820\",\"size\":10485760},{\"ref_name\":\"refs/heads/master\",\"path\":\"foo/bar/2\",\"oid\":\"6512bd43d9caa6e02c990b0a82652dca\",\"size\":11534336},{\"ref_name\":\"refs/heads/master\",\"path\":\"foo/bar/3\",\"oid\":\"c20ad4d76fe97759aa27a0c99bff6710\",\"size\":12582912}]" + "data": "{\"key\":\"contributor_covenant\",\"name\":\"Contributor Covenant\",\"url\":\"https://github.com/LindseyB/cosee/blob/master/CODE_OF_CONDUCT.md\",\"body\":\"# Contributor Covenant Code of Conduct\\n\\n## Our Pledge\\n\\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\\n\\n## Our Standards\\n\\nExamples of behavior that contributes to creating a positive environment include=>\\n\\n* Using welcoming and inclusive language\\n* Being respectful of differing viewpoints and experiences\\n* Gracefully accepting constructive criticism\\n* Focusing on what is best for the community\\n* Showing empathy towards other community members\\n\\nExamples of unacceptable behavior by participants include=>\\n\\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\\n* Trolling, insulting/derogatory comments, and personal or political attacks\\n* Public or private harassment\\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\\n* Other conduct which could reasonably be considered inappropriate in a professional setting\\n\\n## Our Responsibilities\\n\\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\\nto any instances of unacceptable behavior.\\n\\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\\n\\n## Scope\\n\\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\\nposting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\\n\\n## Enforcement\\n\\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at lindseyb@github.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\\n\\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\\n\\n## Attribution\\n\\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]\\n\\n[homepage]: http://contributor-covenant.org\\n[version]: http://contributor-covenant.org/version/1/4/\\n\"}" } ] } @@ -25913,15 +19164,15 @@ "renamed": null }, { - "name": "Set Git LFS preference", - "scope": "migrations", - "id": "setLfsPreference", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/import/lfs", + "name": "Retrieve community profile metrics", + "scope": "repos", + "id": "retrieveCommunityProfileMetrics", + "method": "GET", + "url": "/repos/{owner}/{repo}/community/profile", "isDeprecated": false, "isLegacy": false, - "description": "You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by [Git LFS](https://git-lfs.github.com). You can learn more about our LFS feature and working with large files [on our help site](https://help.github.com/articles/versioning-large-files/).", - "documentationUrl": "https://developer.github.com/v3/migrations/source_imports/#set-git-lfs-preference", + "description": "This endpoint will return all community profile metrics, including an overall health score, repository description, the presence of documentation, detected code of conduct, detected license, and the presence of ISSUE\\_TEMPLATE, PULL\\_REQUEST\\_TEMPLATE, README, and CONTRIBUTING files.", + "documentationUrl": "https://developer.github.com/v3/repos/community/#retrieve-community-profile-metrics", "previews": [], "headers": [], "parameters": [ @@ -25950,19 +19201,6 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "use_lfs", - "description": "Can be one of `opt_in` (large files will be stored using Git LFS) or `opt_out` (large files will be removed during the import).", - "in": "BODY", - "type": "string", - "required": true, - "enum": ["opt_in", "opt_out"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null } ], "responses": [ @@ -25971,7 +19209,7 @@ "description": "response", "examples": [ { - "data": "{\"vcs\":\"subversion\",\"use_lfs\":\"opt_in\",\"vcs_url\":\"http://svn.mycompany.com/svn/myproject\",\"status\":\"complete\",\"status_text\":\"Done\",\"has_large_files\":true,\"large_files_size\":132331036,\"large_files_count\":1,\"authors_count\":4,\"url\":\"https://api.github.com/repos/octocat/socm/import\",\"html_url\":\"https://import.github.com/octocat/socm/import\",\"authors_url\":\"https://api.github.com/repos/octocat/socm/import/authors\",\"repository_url\":\"https://api.github.com/repos/octocat/socm\"}" + "data": "{\"health_percentage\":100,\"description\":\"My first repository on GitHub!\",\"documentation\":true,\"files\":{\"code_of_conduct\":{\"name\":\"Contributor Covenant\",\"key\":\"contributor_covenant\",\"url\":\"https://api.github.com/codes_of_conduct/contributor_covenant\",\"html_url\":\"https://github.com/octocat/Hello-World/blob/master/CODE_OF_CONDUCT.md\"},\"contributing\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/contents/CONTRIBUTING\",\"html_url\":\"https://github.com/octocat/Hello-World/blob/master/CONTRIBUTING\"},\"issue_template\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/contents/ISSUE_TEMPLATE\",\"html_url\":\"https://github.com/octocat/Hello-World/blob/master/ISSUE_TEMPLATE\"},\"pull_request_template\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/contents/PULL_REQUEST_TEMPLATE\",\"html_url\":\"https://github.com/octocat/Hello-World/blob/master/PULL_REQUEST_TEMPLATE\"},\"license\":{\"name\":\"MIT License\",\"key\":\"mit\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"html_url\":\"https://github.com/octocat/Hello-World/blob/master/LICENSE\"},\"readme\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/contents/README.md\",\"html_url\":\"https://github.com/octocat/Hello-World/blob/master/README.md\"}},\"updated_at\":\"2017-02-28T19:09:29Z\"}" } ] } @@ -25979,22 +19217,17 @@ "renamed": null }, { - "name": "Get a repository installation", - "scope": "apps", - "id": "getRepoInstallation", + "name": "Compare two commits", + "scope": "repos", + "id": "compareCommits", "method": "GET", - "url": "/repos/{owner}/{repo}/installation", + "url": "/repos/{owner}/{repo}/compare/{base}...{head}", "isDeprecated": false, "isLegacy": false, - "description": "Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.\n\nYou must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://developer.github.com/v3/apps/#get-a-repository-installation", - "previews": [{ "name": "machine-man" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.machine-man-preview+json" - } - ], + "description": "Both `:base` and `:head` must be branch names in `:repo`. To compare branches across other repositories in the same network as `:repo`, use the format `:branch`.\n\nThe response from the API is equivalent to running the `git log base..head` command; however, commits are returned in chronological order. Pass the appropriate [media type](https://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.\n\nThe response also includes details on the files that were changed between the two commits. This includes the status of the change (for example, if a file was added, removed, modified, or renamed), and details of the change itself. For example, files with a `renamed` status have a `previous_filename` field showing the previous filename of the file, and files with a `modified` status have a `patch` field showing the changes made to the file.\n\n**Working with large comparisons**\n\nThe response will include a comparison of up to 250 commits. If you are working with a larger commit range, you can use the [Commit List API](https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository) to enumerate all commits in the range.\n\nFor comparisons with extremely large diffs, you may receive an error response indicating that the diff took too long to generate. You can typically resolve this error by using a smaller commit range.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "documentationUrl": "https://developer.github.com/v3/repos/commits/#compare-two-commits", + "previews": [], + "headers": [], "parameters": [ { "name": "owner", @@ -26021,42 +19254,10 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"id\":1,\"account\":{\"login\":\"github\",\"id\":1,\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/orgs/github\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"repository_selection\":\"all\",\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"created_at\":\"2018-02-09T20:51:14Z\",\"updated_at\":\"2018-02-09T20:51:14Z\",\"single_file_name\":null}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a repository installation", - "scope": "apps", - "id": "findRepoInstallation", - "method": "GET", - "url": "/repos/{owner}/{repo}/installation", - "isDeprecated": false, - "isLegacy": false, - "description": "Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.\n\nYou must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://developer.github.com/v3/apps/#get-a-repository-installation", - "previews": [{ "name": "machine-man" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.machine-man-preview+json" - } - ], - "parameters": [ + }, { - "name": "owner", - "description": "owner parameter", + "name": "base", + "description": "base parameter", "in": "PATH", "type": "string", "required": true, @@ -26068,8 +19269,8 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", + "name": "head", + "description": "head parameter", "in": "PATH", "type": "string", "required": true, @@ -26087,35 +19288,25 @@ "description": "response", "examples": [ { - "data": "{\"id\":1,\"account\":{\"login\":\"github\",\"id\":1,\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/orgs/github\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"repository_selection\":\"all\",\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"created_at\":\"2018-02-09T20:51:14Z\",\"updated_at\":\"2018-02-09T20:51:14Z\",\"single_file_name\":null}" + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/compare/master...topic\",\"html_url\":\"https://github.com/octocat/Hello-World/compare/master...topic\",\"permalink_url\":\"https://github.com/octocat/Hello-World/compare/octocat:bbcd538c8e72b8c175046e27cc8f907076331401...octocat:0328041d1152db8ae77652d1618a02e57f745f17\",\"diff_url\":\"https://github.com/octocat/Hello-World/compare/master...topic.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/compare/master...topic.patch\",\"base_commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}]},\"merge_base_commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}]},\"status\":\"behind\",\"ahead_by\":1,\"behind_by\":2,\"total_commits\":1,\"commits\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}]}],\"files\":[{\"sha\":\"bbcd538c8e72b8c175046e27cc8f907076331401\",\"filename\":\"file1.txt\",\"status\":\"added\",\"additions\":103,\"deletions\":21,\"changes\":124,\"blob_url\":\"https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt\",\"raw_url\":\"https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"patch\":\"@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test\"}]}" } ] } ], - "renamed": { - "before": { "scope": "apps", "id": "findRepoInstallation" }, - "after": { "scope": "apps", "id": "getRepoInstallation" }, - "date": "2019-04-10", - "note": "\"Find repository installation\" renamed to \"Get a repository installation\"" - } + "renamed": null }, { - "name": "Get interaction restrictions for a repository", - "scope": "interactions", - "id": "getRestrictionsForRepo", + "name": "Get contents", + "scope": "repos", + "id": "getContents", "method": "GET", - "url": "/repos/{owner}/{repo}/interaction-limits", + "url": "/repos/{owner}/{repo}/contents/{path}", "isDeprecated": false, "isLegacy": false, - "description": "Shows which group of GitHub users can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response.", - "documentationUrl": "https://developer.github.com/v3/interactions/repos/#get-interaction-restrictions-for-a-repository", - "previews": [{ "name": "sombra" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.sombra-preview+json" - } - ], + "description": "Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit `:path`, you will receive the contents of all files in the repository.\n\nFiles and symlinks support [a custom media type](https://developer.github.com/v3/repos/contents/#custom-media-types) for retrieving the raw content or rendered HTML (when supported). All content types support [a custom media type](https://developer.github.com/v3/repos/contents/#custom-media-types) to ensure the content is returned in a consistent object format.\n\n**Note**:\n\n* To get a repository's contents recursively, you can [recursively get the tree](https://developer.github.com/v3/git/trees/).\n* This API has an upper limit of 1,000 files for a directory. If you need to retrieve more files, use the [Git Trees API](https://developer.github.com/v3/git/trees/#get-a-tree).\n* This API supports files up to 1 megabyte in size.\n\nThe response will be an array of objects, one object for each item in the directory.\n\nWhen listing the contents of a directory, submodules have their \"type\" specified as \"file\". Logically, the value _should_ be \"submodule\". This behavior exists in API v3 [for backwards compatibility purposes](https://git.io/v1YCW). In the next major version of the API, the type will be returned as \"submodule\".\n\nIf the requested `:path` points to a symlink, and the symlink's target is a normal file in the repository, then the API responds with the content of the file (in the [format shown above](https://developer.github.com/v3/repos/contents/#response-if-content-is-a-file)).\n\nOtherwise, the API responds with an object describing the symlink itself:\n\nThe `submodule_git_url` identifies the location of the submodule repository, and the `sha` identifies a specific commit within the submodule repository. Git uses the given URL when cloning the submodule repository, and checks out the submodule at that specific commit.\n\nIf the submodule repository is not hosted on github.com, the Git URLs (`git_url` and `_links[\"git\"]`) and the github.com URLs (`html_url` and `_links[\"html\"]`) will have null values.", + "documentationUrl": "https://developer.github.com/v3/repos/contents/#get-contents", + "previews": [], + "headers": [], "parameters": [ { "name": "owner", @@ -26142,6 +19333,32 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "path", + "description": "path parameter", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", + "in": "QUERY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -26150,7 +19367,16 @@ "description": "response", "examples": [ { - "data": "{\"limit\":\"collaborators_only\",\"origin\":\"repository\",\"expires_at\":\"2018-08-17T04:18:39Z\"}" + "data": "{\"type\":\"file\",\"encoding\":\"base64\",\"size\":5362,\"name\":\"README.md\",\"path\":\"README.md\",\"content\":\"encoded content ...\",\"sha\":\"3d21ec53a331a6f037a91c368710b99387d012c1\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md\",\"_links\":{\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\"}}" + }, + { + "data": "[{\"type\":\"file\",\"size\":625,\"name\":\"octokit.rb\",\"path\":\"lib/octokit.rb\",\"sha\":\"fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/lib/octokit.rb\",\"_links\":{\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit.rb\",\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/fff6fe3a23bf1c8ea0692b4a883af99bee26fd3b\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/lib/octokit.rb\"}},{\"type\":\"dir\",\"size\":0,\"name\":\"octokit\",\"path\":\"lib/octokit\",\"sha\":\"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"html_url\":\"https://github.com/octokit/octokit.rb/tree/master/lib/octokit\",\"download_url\":null,\"_links\":{\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/lib/octokit\",\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/trees/a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"html\":\"https://github.com/octokit/octokit.rb/tree/master/lib/octokit\"}}]" + }, + { + "data": "{\"type\":\"symlink\",\"target\":\"/path/to/symlink/target\",\"size\":23,\"name\":\"some-symlink\",\"path\":\"bin/some-symlink\",\"sha\":\"452a98979c88e093d682cab404a3ec82babebb48\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/bin/some-symlink\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/452a98979c88e093d682cab404a3ec82babebb48\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/bin/some-symlink\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/bin/some-symlink\",\"_links\":{\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/452a98979c88e093d682cab404a3ec82babebb48\",\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/bin/some-symlink\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/bin/some-symlink\"}}" + }, + { + "data": "{\"type\":\"submodule\",\"submodule_git_url\":\"git://github.com/jquery/qunit.git\",\"size\":0,\"name\":\"qunit\",\"path\":\"test/qunit\",\"sha\":\"6ca3721222109997540bd6d9ccd396902e0ad2f9\",\"url\":\"https://api.github.com/repos/jquery/jquery/contents/test/qunit?ref=master\",\"git_url\":\"https://api.github.com/repos/jquery/qunit/git/trees/6ca3721222109997540bd6d9ccd396902e0ad2f9\",\"html_url\":\"https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9\",\"download_url\":null,\"_links\":{\"git\":\"https://api.github.com/repos/jquery/qunit/git/trees/6ca3721222109997540bd6d9ccd396902e0ad2f9\",\"self\":\"https://api.github.com/repos/jquery/jquery/contents/test/qunit?ref=master\",\"html\":\"https://github.com/jquery/qunit/tree/6ca3721222109997540bd6d9ccd396902e0ad2f9\"}}" } ] } @@ -26158,22 +19384,17 @@ "renamed": null }, { - "name": "Add or update interaction restrictions for a repository", - "scope": "interactions", - "id": "addOrUpdateRestrictionsForRepo", + "name": "Create or update a file", + "scope": "repos", + "id": "createOrUpdateFile", "method": "PUT", - "url": "/repos/{owner}/{repo}/interaction-limits", + "url": "/repos/{owner}/{repo}/contents/{path}", "isDeprecated": false, "isLegacy": false, - "description": "Temporarily restricts interactions to certain GitHub users within the given repository. You must have owner or admin access to set restrictions.", - "documentationUrl": "https://developer.github.com/v3/interactions/repos/#add-or-update-interaction-restrictions-for-a-repository", - "previews": [{ "name": "sombra" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.sombra-preview+json" - } - ], + "description": "Creates a new file or updates an existing file in a repository.", + "documentationUrl": "https://developer.github.com/v3/repos/contents/#create-or-update-a-file", + "previews": [], + "headers": [], "parameters": [ { "name": "owner", @@ -26202,54 +19423,87 @@ "deprecated": null }, { - "name": "limit", - "description": "Specifies the group of GitHub users who can comment, open issues, or create pull requests for the given repository. Must be one of: `existing_users`, `contributors_only`, or `collaborators_only`.", + "name": "path", + "description": "path parameter", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "message", + "description": "The commit message.", "in": "BODY", "type": "string", "required": true, - "enum": ["existing_users", "contributors_only", "collaborators_only"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ + }, { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"limit\":\"collaborators_only\",\"origin\":\"repository\",\"expires_at\":\"2018-08-17T04:18:39Z\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Remove interaction restrictions for a repository", - "scope": "interactions", - "id": "removeRestrictionsForRepo", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/interaction-limits", - "isDeprecated": false, - "isLegacy": false, - "description": "Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions.", - "documentationUrl": "https://developer.github.com/v3/interactions/repos/#remove-interaction-restrictions-for-a-repository", - "previews": [{ "name": "sombra" }], - "headers": [ + "name": "content", + "description": "The new file content, using Base64 encoding.", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { - "name": "accept", - "value": "application/vnd.github.sombra-preview+json" - } - ], - "parameters": [ + "name": "sha", + "description": "**Required if you are updating a file**. The blob SHA of the file being replaced.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { - "name": "owner", - "description": "owner parameter", - "in": "PATH", + "name": "branch", + "description": "The branch name. Default: the repository’s default branch (usually `master`)", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "committer", + "description": "The person that committed the file. Default: the authenticated user.", + "in": "BODY", + "type": "object", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "committer.name", + "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "in": "BODY", "type": "string", "required": true, "enum": null, @@ -26260,9 +19514,48 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "committer.email", + "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "author", + "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", + "in": "BODY", + "type": "object", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "author.name", + "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "author.email", + "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.", + "in": "BODY", "type": "string", "required": true, "enum": null, @@ -26273,19 +19566,38 @@ "deprecated": null } ], - "responses": [], + "responses": [ + { + "code": 200, + "description": "response", + "examples": [ + { + "data": "{\"content\":{\"name\":\"hello.txt\",\"path\":\"notes/hello.txt\",\"sha\":\"a56507ed892d05a37c6d6128c260937ea4d287bd\",\"size\":9,\"url\":\"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\"html_url\":\"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\",\"git_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd\",\"download_url\":\"https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt\",\"type\":\"file\",\"_links\":{\"self\":\"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\"git\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd\",\"html\":\"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\"}},\"commit\":{\"sha\":\"18a43cd8e1e3a79c786e3d808a73d23b6d212b16\",\"node_id\":\"MDY6Q29tbWl0MThhNDNjZDhlMWUzYTc5Yzc4NmUzZDgwOGE3M2QyM2I2ZDIxMmIxNg==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/18a43cd8e1e3a79c786e3d808a73d23b6d212b16\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/18a43cd8e1e3a79c786e3d808a73d23b6d212b16\",\"author\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"committer\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"message\":\"my commit message\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f\",\"sha\":\"9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f\"},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/da5a433788da5c255edad7979b328b67d79f53f6\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/da5a433788da5c255edad7979b328b67d79f53f6\",\"sha\":\"da5a433788da5c255edad7979b328b67d79f53f6\"}],\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}}" + } + ] + }, + { + "code": 201, + "description": "response", + "examples": [ + { + "data": "{\"content\":{\"name\":\"hello.txt\",\"path\":\"notes/hello.txt\",\"sha\":\"95b966ae1c166bd92f8ae7d1c313e738c731dfc3\",\"size\":9,\"url\":\"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\"html_url\":\"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\",\"git_url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3\",\"download_url\":\"https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt\",\"type\":\"file\",\"_links\":{\"self\":\"https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt\",\"git\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3\",\"html\":\"https://github.com/octocat/Hello-World/blob/master/notes/hello.txt\"}},\"commit\":{\"sha\":\"7638417db6d59f3c431d3e1f261cc637155684cd\",\"node_id\":\"MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd\",\"author\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"committer\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"message\":\"my commit message\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb\",\"sha\":\"691272480426f78a0138979dd3ce63b77f706feb\"},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\"sha\":\"1acc419d4d6a9ce985db7be48c6349a0475975b5\"}],\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}}" + } + ] + } + ], "renamed": null }, { - "name": "List invitations for a repository", - "scope": "repos", - "id": "listInvitations", - "method": "GET", - "url": "/repos/{owner}/{repo}/invitations", + "name": "Delete a file", + "scope": "repos", + "id": "deleteFile", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/contents/{path}", "isDeprecated": false, "isLegacy": false, - "description": "When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.\n\n", - "documentationUrl": "https://developer.github.com/v3/repos/invitations/#list-invitations-for-a-repository", + "description": "Deletes a file in a repository.\n\nYou can provide an additional `committer` parameter, which is an object containing information about the committer. Or, you can provide an `author` parameter, which is an object containing information about the author.\n\nThe `author` section is optional and is filled in with the `committer` information if omitted. If the `committer` information is omitted, the authenticated user's information is used.\n\nYou must provide values for both `name` and `email`, whether you choose to use `author` or `committer`. Otherwise, you'll receive a `422` status code.", + "documentationUrl": "https://developer.github.com/v3/repos/contents/#delete-a-file", "previews": [], "headers": [], "parameters": [ @@ -26316,11 +19628,11 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "path", + "description": "path parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -26329,49 +19641,22 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "message", + "description": "The commit message.", + "in": "BODY", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"id\":1,\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\"},\"invitee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"inviter\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"permissions\":\"write\",\"created_at\":\"2016-06-13T14:52:50-05:00\",\"url\":\"https://api.github.com/user/repository_invitations/1296269\",\"html_url\":\"https://github.com/octocat/Hello-World/invitations\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Delete a repository invitation", - "scope": "repos", - "id": "deleteInvitation", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/invitations/{invitation_id}", - "isDeprecated": false, - "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/repos/invitations/#delete-a-repository-invitation", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "owner", - "description": "owner parameter", - "in": "PATH", + "name": "sha", + "description": "The blob SHA of the file being replaced.", + "in": "BODY", "type": "string", "required": true, "enum": null, @@ -26382,11 +19667,11 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "branch", + "description": "The branch name. Default: the repository’s default branch (usually `master`)", + "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -26395,41 +19680,24 @@ "deprecated": null }, { - "name": "invitation_id", - "description": "invitation_id parameter", - "in": "PATH", - "type": "integer", - "required": true, + "name": "committer", + "description": "object containing information about the committer.", + "in": "BODY", + "type": "object", + "required": false, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "Update a repository invitation", - "scope": "repos", - "id": "updateInvitation", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/invitations/{invitation_id}", - "isDeprecated": false, - "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/repos/invitations/#update-a-repository-invitation", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "owner", - "description": "owner parameter", - "in": "PATH", + "name": "committer.name", + "description": "The name of the author (or committer) of the commit", + "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -26438,11 +19706,11 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "committer.email", + "description": "The email of the author (or committer) of the commit", + "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -26451,11 +19719,11 @@ "deprecated": null }, { - "name": "invitation_id", - "description": "invitation_id parameter", - "in": "PATH", - "type": "integer", - "required": true, + "name": "author", + "description": "object containing information about the author.", + "in": "BODY", + "type": "object", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -26464,12 +19732,25 @@ "deprecated": null }, { - "name": "permissions", - "description": "The permissions that the associated user will have on the repository. Valid values are `read`, `write`, and `admin`.", + "name": "author.name", + "description": "The name of the author (or committer) of the commit", "in": "BODY", "type": "string", "required": false, - "enum": ["read", "write", "admin"], + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "author.email", + "description": "The email of the author (or committer) of the commit", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -26483,7 +19764,7 @@ "description": "response", "examples": [ { - "data": "{\"id\":1,\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\"},\"invitee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"inviter\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"permissions\":\"write\",\"created_at\":\"2016-06-13T14:52:50-05:00\",\"url\":\"https://api.github.com/user/repository_invitations/1296269\",\"html_url\":\"https://github.com/octocat/Hello-World/invitations\"}" + "data": "{\"content\":null,\"commit\":{\"sha\":\"7638417db6d59f3c431d3e1f261cc637155684cd\",\"node_id\":\"MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd\",\"author\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"committer\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"message\":\"my commit message\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb\",\"sha\":\"691272480426f78a0138979dd3ce63b77f706feb\"},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\"html_url\":\"https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\"sha\":\"1acc419d4d6a9ce985db7be48c6349a0475975b5\"}],\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}}" } ] } @@ -26491,15 +19772,15 @@ "renamed": null }, { - "name": "List issues for a repository", - "scope": "issues", - "id": "listForRepo", + "name": "List contributors", + "scope": "repos", + "id": "listContributors", "method": "GET", - "url": "/repos/{owner}/{repo}/issues", + "url": "/repos/{owner}/{repo}/contributors", "isDeprecated": false, "isLegacy": false, - "description": "**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key.\n\nBe aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests)\" endpoint.\n\n", - "documentationUrl": "https://developer.github.com/v3/issues/#list-issues-for-a-repository", + "description": "Lists contributors to the specified repository and sorts them by the number of commits per contributor in descending order. This endpoint may return information that is a few hours old because the GitHub REST API v3 caches contributor data to improve performance.\n\nGitHub identifies contributors by author email address. This endpoint groups contribution counts by GitHub user, which includes all associated email addresses. To improve performance, only the first 500 author email addresses in the repository link to GitHub users. The rest will appear as anonymous contributors without associated GitHub user information.", + "documentationUrl": "https://developer.github.com/v3/repos/#list-contributors", "previews": [], "headers": [], "parameters": [ @@ -26530,8 +19811,8 @@ "deprecated": null }, { - "name": "milestone", - "description": "If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned.", + "name": "anon", + "description": "Set to `1` or `true` to include anonymous contributors in results.", "in": "QUERY", "type": "string", "required": false, @@ -26543,12 +19824,12 @@ "deprecated": null }, { - "name": "state", - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "name": "per_page", + "description": "Results per page (max 100)", "in": "QUERY", - "type": "string", + "type": "integer", "required": false, - "enum": ["open", "closed", "all"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -26556,10 +19837,10 @@ "deprecated": null }, { - "name": "assignee", - "description": "Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user.", + "name": "page", + "description": "Page number of the results to fetch.", "in": "QUERY", - "type": "string", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -26567,13 +19848,40 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "creator", - "description": "The user that created the issue.", - "in": "QUERY", + "code": 200, + "description": "Response if repository contains content", + "examples": [ + { + "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false,\"contributions\":32}]" + } + ] + } + ], + "renamed": null + }, + { + "name": "List deployments", + "scope": "repos", + "id": "listDeployments", + "method": "GET", + "url": "/repos/{owner}/{repo}/deployments", + "isDeprecated": false, + "isLegacy": false, + "description": "Simple filtering of deployments is available via query parameters:", + "documentationUrl": "https://developer.github.com/v3/repos/deployments/#list-deployments", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "owner parameter", + "in": "PATH", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -26582,11 +19890,11 @@ "deprecated": null }, { - "name": "mentioned", - "description": "A user that's mentioned in the issue.", - "in": "QUERY", + "name": "repo", + "description": "repo parameter", + "in": "PATH", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -26595,8 +19903,8 @@ "deprecated": null }, { - "name": "labels", - "description": "A list of comma separated label names. Example: `bug,ui,@high`", + "name": "sha", + "description": "The SHA recorded at creation time.", "in": "QUERY", "type": "string", "required": false, @@ -26608,12 +19916,12 @@ "deprecated": null }, { - "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "name": "ref", + "description": "The name of the ref. This can be a branch, tag, or SHA.", "in": "QUERY", "type": "string", "required": false, - "enum": ["created", "updated", "comments"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -26621,12 +19929,12 @@ "deprecated": null }, { - "name": "direction", - "description": "The direction of the sort. Can be either `asc` or `desc`.", + "name": "task", + "description": "The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`).", "in": "QUERY", "type": "string", "required": false, - "enum": ["asc", "desc"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -26634,8 +19942,8 @@ "deprecated": null }, { - "name": "since", - "description": "Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "name": "environment", + "description": "The name of the environment that was deployed to (e.g., `staging` or `production`).", "in": "QUERY", "type": "string", "required": false, @@ -26679,7 +19987,7 @@ "description": "response", "examples": [ { - "data": "[{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\"}]" + "data": "[{\"url\":\"https://api.github.com/repos/octocat/example/deployments/1\",\"id\":1,\"node_id\":\"MDEwOkRlcGxveW1lbnQx\",\"sha\":\"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"ref\":\"topic-branch\",\"task\":\"deploy\",\"payload\":{\"deploy\":\"migrate\"},\"original_environment\":\"staging\",\"environment\":\"production\",\"description\":\"Deploy request from hubot\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"statuses_url\":\"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"transient_environment\":false,\"production_environment\":true}]" } ] } @@ -26687,15 +19995,15 @@ "renamed": null }, { - "name": "Create an issue", - "scope": "issues", - "id": "create", + "name": "Create a deployment", + "scope": "repos", + "id": "createDeployment", "method": "POST", - "url": "/repos/{owner}/{repo}/issues", + "url": "/repos/{owner}/{repo}/deployments", "isDeprecated": false, "isLegacy": false, - "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.", - "documentationUrl": "https://developer.github.com/v3/issues/#create-an-issue", + "description": "Deployments offer a few configurable parameters with sane defaults.\n\nThe `ref` parameter can be any named branch, tag, or SHA. At GitHub we often deploy branches and verify them before we merge a pull request.\n\nThe `environment` parameter allows deployments to be issued to different runtime environments. Teams often have multiple environments for verifying their applications, such as `production`, `staging`, and `qa`. This parameter makes it easier to track which environments have requested deployments. The default environment is `production`.\n\nThe `auto_merge` parameter is used to ensure that the requested ref is not behind the repository's default branch. If the ref _is_ behind the default branch for the repository, we will attempt to merge it for you. If the merge succeeds, the API will return a successful merge commit. If merge conflicts prevent the merge from succeeding, the API will return a failure response.\n\nBy default, [commit statuses](https://developer.github.com/v3/repos/statuses) for every submitted context must be in a `success` state. The `required_contexts` parameter allows you to specify a subset of contexts that must be `success`, or to specify contexts that have not yet been submitted. You are not required to use commit statuses to deploy. If you do not require any contexts or create any commit statuses, the deployment will always succeed.\n\nThe `payload` parameter is available for any extra information that a deployment system might need. It is a JSON text field that will be passed on when a deployment event is dispatched.\n\nThe `task` parameter is used by the deployment system to allow different execution paths. In the web world this might be `deploy:migrations` to run schema changes on the system. In the compiled world this could be a flag to compile an application with debugging enabled.\n\nUsers with `repo` or `repo_deployment` scopes can create a deployment for a given ref:\n\nA simple example putting the user and room into the payload to notify back to chat networks.\n\nA more advanced example specifying required commit statuses and bypassing auto-merging.\n\nYou will see this response when GitHub automatically merges the base branch into the topic branch instead of creating a deployment. This auto-merge happens when:\n\n* Auto-merge option is enabled in the repository\n* Topic branch does not include the latest changes on the base branch, which is `master`in the response example\n* There are no merge conflicts\n\nIf there are no new commits in the base branch, a new request to create a deployment should give a successful response.\n\nThis error happens when the `auto_merge` option is enabled and when the default branch (in this case `master`), can't be merged into the branch that's being deployed (in this case `topic-branch`), due to merge conflicts.\n\nThis error happens when the `required_contexts` parameter indicates that one or more contexts need to have a `success` status for the commit to be deployed, but one or more of the required contexts do not have a state of `success`.", + "documentationUrl": "https://developer.github.com/v3/repos/deployments/#create-a-deployment", "previews": [], "headers": [], "parameters": [ @@ -26726,8 +20034,8 @@ "deprecated": null }, { - "name": "title", - "description": "The title of the issue.", + "name": "ref", + "description": "The ref to deploy. This can be a branch, tag, or SHA.", "in": "BODY", "type": "string", "required": true, @@ -26739,21 +20047,8 @@ "deprecated": null }, { - "name": "body", - "description": "The contents of the issue.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "assignee", - "description": "Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_", + "name": "task", + "description": "Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).", "in": "BODY", "type": "string", "required": false, @@ -26765,10 +20060,10 @@ "deprecated": null }, { - "name": "milestone", - "description": "The `number` of the milestone to associate this issue with. _NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise._", + "name": "auto_merge", + "description": "Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.", "in": "BODY", - "type": "integer", + "type": "boolean", "required": false, "enum": null, "allowNull": false, @@ -26778,8 +20073,8 @@ "deprecated": null }, { - "name": "labels", - "description": "Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._", + "name": "required_contexts", + "description": "The [status](https://developer.github.com/v3/repos/statuses/) contexts to verify against commit status checks. If you omit this parameter, GitHub verifies all unique contexts before creating a deployment. To bypass checking entirely, pass an empty array. Defaults to all unique contexts.", "in": "BODY", "type": "string[]", "required": false, @@ -26791,51 +20086,11 @@ "deprecated": null }, { - "name": "assignees", - "description": "Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", + "name": "payload", + "description": "JSON payload with extra information about the deployment.", "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"closed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List comments in a repository", - "scope": "issues", - "id": "listCommentsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/comments", - "isDeprecated": false, - "isLegacy": false, - "description": "By default, Issue Comments are ordered by ascending ID.\n\n", - "documentationUrl": "https://developer.github.com/v3/issues/comments/#list-comments-in-a-repository", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "owner parameter", - "in": "PATH", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -26844,11 +20099,11 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "environment", + "description": "Name for the target deployment environment (e.g., `production`, `staging`, `qa`).", + "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -26857,12 +20112,12 @@ "deprecated": null }, { - "name": "sort", - "description": "Either `created` or `updated`.", - "in": "QUERY", + "name": "description", + "description": "Short description of the deployment.", + "in": "BODY", "type": "string", "required": false, - "enum": ["created", "updated"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -26870,12 +20125,12 @@ "deprecated": null }, { - "name": "direction", - "description": "Either `asc` or `desc`. Ignored without the `sort` parameter.", - "in": "QUERY", - "type": "string", + "name": "transient_environment", + "description": "Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future. Default: `false` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type.", + "in": "BODY", + "type": "boolean", "required": false, - "enum": ["asc", "desc"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -26883,10 +20138,10 @@ "deprecated": null }, { - "name": "since", - "description": "Only comments updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", - "type": "string", + "name": "production_environment", + "description": "Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise. \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type.", + "in": "BODY", + "type": "boolean", "required": false, "enum": null, "allowNull": false, @@ -26898,11 +20153,35 @@ ], "responses": [ { - "code": 200, + "code": 201, "description": "response", "examples": [ { - "data": "[{\"id\":1,\"node_id\":\"MDEyOklzc3VlQ29tbWVudDE=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments/1\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347#issuecomment-1\",\"body\":\"Me too\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}]" + "data": "{\"url\":\"https://api.github.com/repos/octocat/example/deployments/1\",\"id\":1,\"node_id\":\"MDEwOkRlcGxveW1lbnQx\",\"sha\":\"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"ref\":\"topic-branch\",\"task\":\"deploy\",\"payload\":{\"deploy\":\"migrate\"},\"original_environment\":\"staging\",\"environment\":\"production\",\"description\":\"Deploy request from hubot\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"statuses_url\":\"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"transient_environment\":false,\"production_environment\":true}" + }, + { + "data": "{\"url\":\"https://api.github.com/repos/octocat/example/deployments/1\",\"id\":1,\"node_id\":\"MDEwOkRlcGxveW1lbnQx\",\"sha\":\"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"ref\":\"topic-branch\",\"task\":\"deploy\",\"payload\":{\"deploy\":\"migrate\"},\"original_environment\":\"staging\",\"environment\":\"production\",\"description\":\"Deploy request from hubot\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"statuses_url\":\"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"transient_environment\":false,\"production_environment\":true}" + } + ] + }, + { + "code": 202, + "description": "Merged branch response", + "examples": [ + { + "data": "{\"message\":\"Auto-merged master into topic-branch on deployment.\"}" + } + ] + }, + { + "code": 409, + "description": "response", + "examples": [ + { + "data": "{\"message\":\"Conflict merging master into topic-branch\"}" + }, + { + "data": "{\"message\":\"Conflict: Commit status checks failed for topic-branch.\"}" } ] } @@ -26910,15 +20189,15 @@ "renamed": null }, { - "name": "Get a single comment", - "scope": "issues", - "id": "getComment", + "name": "Get a single deployment", + "scope": "repos", + "id": "getDeployment", "method": "GET", - "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}", + "url": "/repos/{owner}/{repo}/deployments/{deployment_id}", "isDeprecated": false, "isLegacy": false, "description": "", - "documentationUrl": "https://developer.github.com/v3/issues/comments/#get-a-single-comment", + "documentationUrl": "https://developer.github.com/v3/repos/deployments/#get-a-single-deployment", "previews": [], "headers": [], "parameters": [ @@ -26949,8 +20228,8 @@ "deprecated": null }, { - "name": "comment_id", - "description": "comment_id parameter", + "name": "deployment_id", + "description": "deployment_id parameter", "in": "PATH", "type": "integer", "required": true, @@ -26968,7 +20247,7 @@ "description": "response", "examples": [ { - "data": "{\"id\":1,\"node_id\":\"MDEyOklzc3VlQ29tbWVudDE=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments/1\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347#issuecomment-1\",\"body\":\"Me too\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}" + "data": "{\"url\":\"https://api.github.com/repos/octocat/example/deployments/1\",\"id\":1,\"node_id\":\"MDEwOkRlcGxveW1lbnQx\",\"sha\":\"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\"ref\":\"topic-branch\",\"task\":\"deploy\",\"payload\":{\"deploy\":\"migrate\"},\"original_environment\":\"staging\",\"environment\":\"production\",\"description\":\"Deploy request from hubot\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"statuses_url\":\"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"transient_environment\":false,\"production_environment\":true}" } ] } @@ -26976,15 +20255,15 @@ "renamed": null }, { - "name": "Edit a comment", - "scope": "issues", - "id": "updateComment", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}", + "name": "List deployment statuses", + "scope": "repos", + "id": "listDeploymentStatuses", + "method": "GET", + "url": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/issues/comments/#edit-a-comment", + "description": "Users with pull access can view deployment statuses for a deployment:", + "documentationUrl": "https://developer.github.com/v3/repos/deployments/#list-deployment-statuses", "previews": [], "headers": [], "parameters": [ @@ -27015,8 +20294,8 @@ "deprecated": null }, { - "name": "comment_id", - "description": "comment_id parameter", + "name": "deployment_id", + "description": "deployment_id parameter", "in": "PATH", "type": "integer", "required": true, @@ -27028,11 +20307,24 @@ "deprecated": null }, { - "name": "body", - "description": "The contents of the comment.", - "in": "BODY", - "type": "string", - "required": true, + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -27047,7 +20339,7 @@ "description": "response", "examples": [ { - "data": "{\"id\":1,\"node_id\":\"MDEyOklzc3VlQ29tbWVudDE=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments/1\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347#issuecomment-1\",\"body\":\"Me too\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}" + "data": "[{\"url\":\"https://api.github.com/repos/octocat/example/deployments/42/statuses/1\",\"id\":1,\"node_id\":\"MDE2OkRlcGxveW1lbnRTdGF0dXMx\",\"state\":\"success\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"description\":\"Deployment finished successfully.\",\"environment\":\"production\",\"target_url\":\"https://example.com/deployment/42/output\",\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"deployment_url\":\"https://api.github.com/repos/octocat/example/deployments/42\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"environment_url\":\"\",\"log_url\":\"https://example.com/deployment/42/output\"}]" } ] } @@ -27055,15 +20347,15 @@ "renamed": null }, { - "name": "Delete a comment", - "scope": "issues", - "id": "deleteComment", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}", + "name": "Create a deployment status", + "scope": "repos", + "id": "createDeploymentStatus", + "method": "POST", + "url": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/issues/comments/#delete-a-comment", + "description": "Users with `push` access can create deployment statuses for a given deployment.\n\nGitHub Apps require `read & write` access to \"Deployments\" and `read-only` access to \"Repo contents\" (for private repos). OAuth Apps require the `repo_deployment` scope.", + "documentationUrl": "https://developer.github.com/v3/repos/deployments/#create-a-deployment-status", "previews": [], "headers": [], "parameters": [ @@ -27094,8 +20386,8 @@ "deprecated": null }, { - "name": "comment_id", - "description": "comment_id parameter", + "name": "deployment_id", + "description": "deployment_id parameter", "in": "PATH", "type": "integer", "required": true, @@ -27105,35 +20397,34 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "List reactions for an issue comment", - "scope": "reactions", - "id": "listForIssueComment", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", - "isDeprecated": false, - "isLegacy": false, - "description": "List the reactions to an [issue comment](https://developer.github.com/v3/issues/comments/).", - "documentationUrl": "https://developer.github.com/v3/reactions/#list-reactions-for-an-issue-comment", - "previews": [{ "name": "squirrel-girl" }], - "headers": [ + }, { - "name": "accept", - "value": "application/vnd.github.squirrel-girl-preview+json" - } - ], - "parameters": [ + "name": "state", + "description": "The state of the status. Can be one of `error`, `failure`, `inactive`, `in_progress`, `queued` `pending`, or `success`. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. To use the `in_progress` and `queued` states, you must provide the [`application/vnd.github.flash-preview+json`](https://developer.github.com/v3/previews/#deployment-statuses) custom media type.", + "in": "BODY", + "type": "string", + "required": true, + "enum": [ + "error", + "failure", + "inactive", + "in_progress", + "queued", + "pending", + "success" + ], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { - "name": "owner", - "description": "owner parameter", - "in": "PATH", + "name": "target_url", + "description": "The target URL to associate with this status. This URL should contain output to keep the user updated while the task is running or serve as historical information for what happened in the deployment. **Note:** It's recommended to use the `log_url` parameter, which replaces `target_url`.", + "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -27142,11 +20433,11 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "log_url", + "description": "The full URL of the deployment's output. This parameter replaces `target_url`. We will continue to accept `target_url` to support legacy uses, but we recommend replacing `target_url` with `log_url`. Setting `log_url` will automatically set `target_url` to the same value. Default: `\"\"` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type.", + "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -27155,11 +20446,11 @@ "deprecated": null }, { - "name": "comment_id", - "description": "comment_id parameter", - "in": "PATH", - "type": "integer", - "required": true, + "name": "description", + "description": "A short description of the status. The maximum description length is 140 characters.", + "in": "BODY", + "type": "string", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -27168,21 +20459,12 @@ "deprecated": null }, { - "name": "content", - "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue comment.", - "in": "QUERY", + "name": "environment", + "description": "Name for the target deployment environment, which can be changed when setting a deploy status. For example, `production`, `staging`, or `qa`. **Note:** This parameter requires you to use the [`application/vnd.github.flash-preview+json`](https://developer.github.com/v3/previews/#deployment-statuses) custom media type.", + "in": "BODY", "type": "string", "required": false, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], + "enum": ["production", "staging", "qa"], "allowNull": false, "mapToData": null, "validation": null, @@ -27190,10 +20472,10 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", + "name": "environment_url", + "description": "Sets the URL for accessing your environment. Default: `\"\"` \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type. **Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type.", + "in": "BODY", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -27203,10 +20485,10 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", + "name": "auto_inactive", + "description": "Adds a new `inactive` status to all prior non-transient, non-production environment deployments with the same repository and `environment` name as the created status's deployment. An `inactive` status is only added to deployments that had a `success` state. Default: `true` \n**Note:** To add an `inactive` status to `production` environments, you must use the [`application/vnd.github.flash-preview+json`](https://developer.github.com/v3/previews/#deployment-statuses) custom media type. \n**Note:** This parameter requires you to use the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/v3/previews/#enhanced-deployments) custom media type.", + "in": "BODY", + "type": "boolean", "required": false, "enum": null, "allowNull": false, @@ -27218,11 +20500,11 @@ ], "responses": [ { - "code": 200, + "code": 201, "description": "response", "examples": [ { - "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" + "data": "{\"url\":\"https://api.github.com/repos/octocat/example/deployments/42/statuses/1\",\"id\":1,\"node_id\":\"MDE2OkRlcGxveW1lbnRTdGF0dXMx\",\"state\":\"success\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"description\":\"Deployment finished successfully.\",\"environment\":\"production\",\"target_url\":\"https://example.com/deployment/42/output\",\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"deployment_url\":\"https://api.github.com/repos/octocat/example/deployments/42\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"environment_url\":\"\",\"log_url\":\"https://example.com/deployment/42/output\"}" } ] } @@ -27230,22 +20512,17 @@ "renamed": null }, { - "name": "Create reaction for an issue comment", - "scope": "reactions", - "id": "createForIssueComment", - "method": "POST", - "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", + "name": "Get a single deployment status", + "scope": "repos", + "id": "getDeploymentStatus", + "method": "GET", + "url": "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}", "isDeprecated": false, "isLegacy": false, - "description": "Create a reaction to an [issue comment](https://developer.github.com/v3/issues/comments/). A response with a `Status: 200 OK` means that you already added the reaction type to this issue comment.", - "documentationUrl": "https://developer.github.com/v3/reactions/#create-reaction-for-an-issue-comment", - "previews": [{ "name": "squirrel-girl" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.squirrel-girl-preview+json" - } - ], + "description": "Users with pull access can view a deployment status for a deployment:", + "documentationUrl": "https://developer.github.com/v3/repos/deployments/#get-a-single-deployment-status", + "previews": [], + "headers": [], "parameters": [ { "name": "owner", @@ -27274,8 +20551,8 @@ "deprecated": null }, { - "name": "comment_id", - "description": "comment_id parameter", + "name": "deployment_id", + "description": "deployment_id parameter", "in": "PATH", "type": "integer", "required": true, @@ -27287,21 +20564,12 @@ "deprecated": null }, { - "name": "content", - "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the issue comment.", - "in": "BODY", - "type": "string", + "name": "status_id", + "description": "status_id parameter", + "in": "PATH", + "type": "integer", "required": true, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -27311,11 +20579,11 @@ ], "responses": [ { - "code": 201, + "code": 200, "description": "response", "examples": [ { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" + "data": "{\"url\":\"https://api.github.com/repos/octocat/example/deployments/42/statuses/1\",\"id\":1,\"node_id\":\"MDE2OkRlcGxveW1lbnRTdGF0dXMx\",\"state\":\"success\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"description\":\"Deployment finished successfully.\",\"environment\":\"production\",\"target_url\":\"https://example.com/deployment/42/output\",\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"deployment_url\":\"https://api.github.com/repos/octocat/example/deployments/42\",\"repository_url\":\"https://api.github.com/repos/octocat/example\",\"environment_url\":\"\",\"log_url\":\"https://example.com/deployment/42/output\"}" } ] } @@ -27323,15 +20591,15 @@ "renamed": null }, { - "name": "List events for a repository", - "scope": "issues", - "id": "listEventsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/events", + "name": "Create a repository dispatch event", + "scope": "repos", + "id": "createDispatchEvent", + "method": "POST", + "url": "/repos/{owner}/{repo}/dispatches", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/issues/events/#list-events-for-a-repository", + "description": "You can use this endpoint to trigger a webhook event called `repository_dispatch` when you want activity that happens outside of GitHub to trigger a GitHub Actions workflow or GitHub App webhook. You must configure your GitHub Actions workflow or GitHub App to run when the `repository_dispatch` event occurs. For an example `repository_dispatch` webhook payload, see \"[RepositoryDispatchEvent](https://developer.github.com/v3/activity/events/types/#repositorydispatchevent).\"\n\nThe `client_payload` parameter is available for any extra information that your workflow might need. This parameter is a JSON payload that will be passed on when the webhook event is dispatched. For example, the `client_payload` can include a message that a user would like to send using a GitHub Actions workflow. Or the `client_payload` can be used as a test to debug your workflow. For a test example, see the [input example](https://developer.github.com/v3/repos/#example-4).\n\nTo give you write access to the repository, you must use a personal access token with the `repo` scope. For more information, see \"[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line)\" in the GitHub Help documentation.\n\nThis input example shows how you can use the `client_payload` as a test to debug your workflow.", + "documentationUrl": "https://developer.github.com/v3/repos/#create-a-repository-dispatch-event", "previews": [], "headers": [], "parameters": [ @@ -27362,10 +20630,10 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", + "name": "event_type", + "description": "**Required:** A custom webhook event name.", + "in": "BODY", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -27375,10 +20643,10 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", + "name": "client_payload", + "description": "JSON payload with extra information about the webhook event that your action or worklow may use.", + "in": "BODY", + "type": "object", "required": false, "enum": null, "allowNull": false, @@ -27388,29 +20656,19 @@ "deprecated": null } ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDEwOklzc3VlRXZlbnQx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events/1\",\"actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"event\":\"closed\",\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"commit_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"created_at\":\"2011-04-14T16:00:49Z\",\"issue\":{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\"}}]" - } - ] - } - ], + "responses": [], "renamed": null }, { - "name": "Get a single event", - "scope": "issues", - "id": "getEvent", + "name": "List downloads for a repository", + "scope": "repos", + "id": "listDownloads", "method": "GET", - "url": "/repos/{owner}/{repo}/issues/events/{event_id}", + "url": "/repos/{owner}/{repo}/downloads", "isDeprecated": false, "isLegacy": false, "description": "", - "documentationUrl": "https://developer.github.com/v3/issues/events/#get-a-single-event", + "documentationUrl": "https://developer.github.com/v3/repos/downloads/#list-downloads-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -27441,11 +20699,24 @@ "deprecated": null }, { - "name": "event_id", - "description": "event_id parameter", - "in": "PATH", + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", "type": "integer", - "required": true, + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -27460,7 +20731,7 @@ "description": "response", "examples": [ { - "data": "{\"id\":1,\"node_id\":\"MDEwOklzc3VlRXZlbnQx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events/1\",\"actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"event\":\"closed\",\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"commit_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"created_at\":\"2011-04-14T16:00:49Z\",\"issue\":{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\"}}" + "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/downloads/1\",\"html_url\":\"https://github.com/repos/octocat/Hello-World/downloads/new_file.jpg\",\"id\":1,\"name\":\"new_file.jpg\",\"description\":\"Description of your download\",\"size\":1024,\"download_count\":40,\"content_type\":\".jpg\"}]" } ] } @@ -27468,15 +20739,15 @@ "renamed": null }, { - "name": "Get a single issue", - "scope": "issues", - "id": "get", + "name": "Get a single download", + "scope": "repos", + "id": "getDownload", "method": "GET", - "url": "/repos/{owner}/{repo}/issues/{issue_number}", + "url": "/repos/{owner}/{repo}/downloads/{download_id}", "isDeprecated": false, "isLegacy": false, - "description": "The API returns a [`301 Moved Permanently` status](https://developer.github.com/v3/#http-redirects) if the issue was [transferred](https://help.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe to the [`issues`](https://developer.github.com/v3/activity/events/types/#issuesevent) webhook.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key.\n\nBe aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests)\" endpoint.\n\n", - "documentationUrl": "https://developer.github.com/v3/issues/#get-a-single-issue", + "description": "", + "documentationUrl": "https://developer.github.com/v3/repos/downloads/#get-a-single-download", "previews": [], "headers": [], "parameters": [ @@ -27507,8 +20778,8 @@ "deprecated": null }, { - "name": "issue_number", - "description": "issue_number parameter", + "name": "download_id", + "description": "download_id parameter", "in": "PATH", "type": "integer", "required": true, @@ -27518,19 +20789,6 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "number", - "description": null, - "in": null, - "type": null, - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": "issue_number", - "deprecated": true } ], "responses": [ @@ -27539,7 +20797,7 @@ "description": "response", "examples": [ { - "data": "{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"closed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/downloads/1\",\"html_url\":\"https://github.com/repos/octocat/Hello-World/downloads/new_file.jpg\",\"id\":1,\"name\":\"new_file.jpg\",\"description\":\"Description of your download\",\"size\":1024,\"download_count\":40,\"content_type\":\".jpg\"}" } ] } @@ -27547,15 +20805,15 @@ "renamed": null }, { - "name": "Edit an issue", - "scope": "issues", - "id": "update", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/issues/{issue_number}", + "name": "Delete a download", + "scope": "repos", + "id": "deleteDownload", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/downloads/{download_id}", "isDeprecated": false, "isLegacy": false, - "description": "Issue owners and users with push access can edit an issue.", - "documentationUrl": "https://developer.github.com/v3/issues/#edit-an-issue", + "description": "", + "documentationUrl": "https://developer.github.com/v3/repos/downloads/#delete-a-download", "previews": [], "headers": [], "parameters": [ @@ -27586,8 +20844,8 @@ "deprecated": null }, { - "name": "issue_number", - "description": "issue_number parameter", + "name": "download_id", + "description": "download_id parameter", "in": "PATH", "type": "integer", "required": true, @@ -27597,135 +20855,21 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "title", - "description": "The title of the issue.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The contents of the issue.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "assignee", - "description": "Login for the user that this issue should be assigned to. **This field is deprecated.**", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "State of the issue. Either `open` or `closed`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["open", "closed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "milestone", - "description": "The `number` of the milestone to associate this issue with or `null` to remove current. _NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise._", - "in": "BODY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": true, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "labels", - "description": "Labels to associate with this issue. Pass one or more Labels to _replace_ the set of Labels on this Issue. Send an empty array (`[]`) to clear all Labels from the Issue. _NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise._", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "assignees", - "description": "Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "number", - "description": null, - "in": null, - "type": null, - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": "issue_number", - "deprecated": true - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"closed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" - } - ] } ], + "responses": [], "renamed": null }, { - "name": "Add assignees to an issue", - "scope": "issues", - "id": "addAssignees", - "method": "POST", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", + "name": "List repository events", + "scope": "activity", + "id": "listRepoEvents", + "method": "GET", + "url": "/repos/{owner}/{repo}/events", "isDeprecated": false, "isLegacy": false, - "description": "Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.\n\nThis example adds two assignees to the existing `octocat` assignee.", - "documentationUrl": "https://developer.github.com/v3/issues/assignees/#add-assignees-to-an-issue", + "description": "", + "documentationUrl": "https://developer.github.com/v3/activity/events/#list-repository-events", "previews": [], "headers": [], "parameters": [ @@ -27756,11 +20900,11 @@ "deprecated": null }, { - "name": "issue_number", - "description": "issue_number parameter", - "in": "PATH", + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", "type": "integer", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -27769,10 +20913,10 @@ "deprecated": null }, { - "name": "assignees", - "description": "Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._", - "in": "BODY", - "type": "string[]", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -27780,44 +20924,21 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "number", - "description": null, - "in": null, - "type": null, - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": "issue_number", - "deprecated": true - } - ], - "responses": [ - { - "code": 201, - "description": "response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true},{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\"}" - } - ] } ], + "responses": [], "renamed": null }, { - "name": "Remove assignees from an issue", - "scope": "issues", - "id": "removeAssignees", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", + "name": "List forks", + "scope": "repos", + "id": "listForks", + "method": "GET", + "url": "/repos/{owner}/{repo}/forks", "isDeprecated": false, "isLegacy": false, - "description": "Removes one or more assignees from an issue.\n\nThis example removes two of three assignees, leaving the `octocat` assignee.", - "documentationUrl": "https://developer.github.com/v3/issues/assignees/#remove-assignees-from-an-issue", + "description": "", + "documentationUrl": "https://developer.github.com/v3/repos/forks/#list-forks", "previews": [], "headers": [], "parameters": [ @@ -27848,12 +20969,12 @@ "deprecated": null }, { - "name": "issue_number", - "description": "issue_number parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, + "name": "sort", + "description": "The sort order. Can be either `newest`, `oldest`, or `stargazers`.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["newest", "oldest", "stargazers"], "allowNull": false, "mapToData": null, "validation": null, @@ -27861,10 +20982,10 @@ "deprecated": null }, { - "name": "assignees", - "description": "Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._", - "in": "BODY", - "type": "string[]", + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -27874,17 +20995,17 @@ "deprecated": null }, { - "name": "number", - "description": null, - "in": null, - "type": null, - "required": null, + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, - "allowNull": null, + "allowNull": false, "mapToData": null, "validation": null, - "alias": "issue_number", - "deprecated": true + "alias": null, + "deprecated": null } ], "responses": [ @@ -27893,7 +21014,7 @@ "description": "response", "examples": [ { - "data": "{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\"}" + "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":true,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"}}]" } ] } @@ -27901,15 +21022,15 @@ "renamed": null }, { - "name": "List comments on an issue", - "scope": "issues", - "id": "listComments", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/comments", + "name": "Create a fork", + "scope": "repos", + "id": "createFork", + "method": "POST", + "url": "/repos/{owner}/{repo}/forks", "isDeprecated": false, "isLegacy": false, - "description": "Issue Comments are ordered by ascending ID.\n\n", - "documentationUrl": "https://developer.github.com/v3/issues/comments/#list-comments-on-an-issue", + "description": "Create a fork for the authenticated user.\n\n**Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Support](https://github.com/contact) or [GitHub Premium Support](https://premium.githubsupport.com).", + "documentationUrl": "https://developer.github.com/v3/repos/forks/#create-a-fork", "previews": [], "headers": [], "parameters": [ @@ -27940,22 +21061,9 @@ "deprecated": null }, { - "name": "issue_number", - "description": "issue_number parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "Only comments updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", + "name": "organization", + "description": "Optional parameter to specify the organization name if forking into an organization.", + "in": "BODY", "type": "string", "required": false, "enum": null, @@ -27964,54 +21072,15 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "number", - "description": null, - "in": null, - "type": null, - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": "issue_number", - "deprecated": true } ], "responses": [ { - "code": 200, + "code": 202, "description": "response", "examples": [ { - "data": "[{\"id\":1,\"node_id\":\"MDEyOklzc3VlQ29tbWVudDE=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments/1\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347#issuecomment-1\",\"body\":\"Me too\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}]" + "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":true,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}" } ] } @@ -28019,15 +21088,15 @@ "renamed": null }, { - "name": "Create a comment", - "scope": "issues", - "id": "createComment", + "name": "Create a blob", + "scope": "git", + "id": "createBlob", "method": "POST", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/comments", + "url": "/repos/{owner}/{repo}/git/blobs", "isDeprecated": false, "isLegacy": false, - "description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.", - "documentationUrl": "https://developer.github.com/v3/issues/comments/#create-a-comment", + "description": "", + "documentationUrl": "https://developer.github.com/v3/git/blobs/#create-a-blob", "previews": [], "headers": [], "parameters": [ @@ -28058,10 +21127,10 @@ "deprecated": null }, { - "name": "issue_number", - "description": "issue_number parameter", - "in": "PATH", - "type": "integer", + "name": "content", + "description": "The new blob's content.", + "in": "BODY", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -28071,30 +21140,17 @@ "deprecated": null }, { - "name": "body", - "description": "The contents of the comment.", + "name": "encoding", + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - }, - { - "name": "number", - "description": null, - "in": null, - "type": null, - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": "issue_number", - "deprecated": true } ], "responses": [ @@ -28103,7 +21159,7 @@ "description": "response", "examples": [ { - "data": "{\"id\":1,\"node_id\":\"MDEyOklzc3VlQ29tbWVudDE=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments/1\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347#issuecomment-1\",\"body\":\"Me too\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}" + "data": "{\"url\":\"https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15\",\"sha\":\"3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15\"}" } ] } @@ -28111,15 +21167,15 @@ "renamed": null }, { - "name": "List events for an issue", - "scope": "issues", - "id": "listEvents", + "name": "Get a blob", + "scope": "git", + "id": "getBlob", "method": "GET", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/events", + "url": "/repos/{owner}/{repo}/git/blobs/{file_sha}", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/issues/events/#list-events-for-an-issue", + "description": "The `content` in the response will always be Base64 encoded.\n\n_Note_: This API supports blobs up to 100 megabytes in size.", + "documentationUrl": "https://developer.github.com/v3/git/blobs/#get-a-blob", "previews": [], "headers": [], "parameters": [ @@ -28150,10 +21206,10 @@ "deprecated": null }, { - "name": "issue_number", - "description": "issue_number parameter", + "name": "file_sha", + "description": "file_sha parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -28161,45 +21217,6 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "number", - "description": null, - "in": null, - "type": null, - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": "issue_number", - "deprecated": true } ], "responses": [ @@ -28208,7 +21225,7 @@ "description": "response", "examples": [ { - "data": "[{\"id\":1,\"node_id\":\"MDEwOklzc3VlRXZlbnQx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events/1\",\"actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"event\":\"closed\",\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"commit_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"created_at\":\"2011-04-14T16:00:49Z\"}]" + "data": "{\"content\":\"Q29udGVudCBvZiB0aGUgYmxvYg==\\n\",\"encoding\":\"base64\",\"url\":\"https://api.github.com/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15\",\"sha\":\"3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15\",\"size\":19}" } ] } @@ -28216,15 +21233,15 @@ "renamed": null }, { - "name": "List labels on an issue", - "scope": "issues", - "id": "listLabelsOnIssue", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", + "name": "Create a commit", + "scope": "git", + "id": "createCommit", + "method": "POST", + "url": "/repos/{owner}/{repo}/git/commits", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/issues/labels/#list-labels-on-an-issue", + "description": "Creates a new Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects).\n\nIn this example, the payload of the signature would be:\n\n\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "documentationUrl": "https://developer.github.com/v3/git/commits/#create-a-commit", "previews": [], "headers": [], "parameters": [ @@ -28255,10 +21272,10 @@ "deprecated": null }, { - "name": "issue_number", - "description": "issue_number parameter", - "in": "PATH", - "type": "integer", + "name": "message", + "description": "The commit message", + "in": "BODY", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -28268,11 +21285,11 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "tree", + "description": "The SHA of the tree object this commit points to", + "in": "BODY", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -28281,11 +21298,11 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "parents", + "description": "The SHAs of the commits that were the parents of this commit. If omitted or empty, the commit will be written as a root commit. For a single parent, an array of one SHA should be provided; for a merge commit, an array of more than one should be provided.", + "in": "BODY", + "type": "string[]", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -28294,51 +21311,24 @@ "deprecated": null }, { - "name": "number", - "description": null, - "in": null, - "type": null, - "required": null, + "name": "author", + "description": "Information about the author of the commit. By default, the `author` will be the authenticated user and the current date. See the `author` and `committer` object below for details.", + "in": "BODY", + "type": "object", + "required": false, "enum": null, - "allowNull": null, + "allowNull": false, "mapToData": null, "validation": null, - "alias": "issue_number", - "deprecated": true - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true},{\"id\":208045947,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDc=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/enhancement\",\"name\":\"enhancement\",\"description\":\"New feature or request\",\"color\":\"a2eeef\",\"default\":false}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Add labels to an issue", - "scope": "issues", - "id": "addLabels", - "method": "POST", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "isDeprecated": false, - "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/issues/labels/#add-labels-to-an-issue", - "previews": [], - "headers": [], - "parameters": [ + "alias": null, + "deprecated": null + }, { - "name": "owner", - "description": "owner parameter", - "in": "PATH", + "name": "author.name", + "description": "The name of the author (or committer) of the commit", + "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -28347,11 +21337,11 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "author.email", + "description": "The email of the author (or committer) of the commit", + "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -28360,11 +21350,11 @@ "deprecated": null }, { - "name": "issue_number", - "description": "issue_number parameter", - "in": "PATH", - "type": "integer", - "required": true, + "name": "author.date", + "description": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "BODY", + "type": "string", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -28373,11 +21363,11 @@ "deprecated": null }, { - "name": "labels", - "description": "The name of the label to add to the issue. Must contain at least one label. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", + "name": "committer", + "description": "Information about the person who is making the commit. By default, `committer` will use the information set in `author`. See the `author` and `committer` object below for details.", "in": "BODY", - "type": "string[]", - "required": true, + "type": "object", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -28386,51 +21376,11 @@ "deprecated": null }, { - "name": "number", - "description": null, - "in": null, - "type": null, - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": "issue_number", - "deprecated": true - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true},{\"id\":208045947,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDc=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/enhancement\",\"name\":\"enhancement\",\"description\":\"New feature or request\",\"color\":\"a2eeef\",\"default\":false}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Replace all labels for an issue", - "scope": "issues", - "id": "replaceLabels", - "method": "PUT", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", - "isDeprecated": false, - "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/issues/labels/#replace-all-labels-for-an-issue", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "owner parameter", - "in": "PATH", + "name": "committer.name", + "description": "The name of the author (or committer) of the commit", + "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -28439,11 +21389,11 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "committer.email", + "description": "The email of the author (or committer) of the commit", + "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -28452,11 +21402,11 @@ "deprecated": null }, { - "name": "issue_number", - "description": "issue_number parameter", - "in": "PATH", - "type": "integer", - "required": true, + "name": "committer.date", + "description": "Indicates when this commit was authored (or committed). This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "BODY", + "type": "string", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -28465,10 +21415,10 @@ "deprecated": null }, { - "name": "labels", - "description": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", + "name": "signature", + "description": "The [PGP signature](https://en.wikipedia.org/wiki/Pretty_Good_Privacy) of the commit. GitHub adds the signature to the `gpgsig` header of the created commit. For a commit signature to be verifiable by Git or GitHub, it must be an ASCII-armored detached PGP signature over the string commit as it would be written to the object database. To pass a `signature` parameter, you need to first manually create a valid PGP signature, which can be complicated. You may find it easier to [use the command line](https://git-scm.com/book/id/v2/Git-Tools-Signing-Your-Work) to create signed commits.", "in": "BODY", - "type": "string[]", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -28476,28 +21426,15 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "number", - "description": null, - "in": null, - "type": null, - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": "issue_number", - "deprecated": true } ], "responses": [ { - "code": 200, + "code": 201, "description": "response", "examples": [ { - "data": "[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true},{\"id\":208045947,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDc=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/enhancement\",\"name\":\"enhancement\",\"description\":\"New feature or request\",\"color\":\"a2eeef\",\"default\":false}]" + "data": "{\"sha\":\"7638417db6d59f3c431d3e1f261cc637155684cd\",\"node_id\":\"MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd\",\"author\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"committer\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"message\":\"my commit message\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/827efc6d56897b048c772eb4087f854f46256132\",\"sha\":\"827efc6d56897b048c772eb4087f854f46256132\"},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7d1b31e74ee336d15cbd21741bc88a537ed063a0\",\"sha\":\"7d1b31e74ee336d15cbd21741bc88a537ed063a0\"}],\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}" } ] } @@ -28505,15 +21442,15 @@ "renamed": null }, { - "name": "Remove all labels from an issue", - "scope": "issues", - "id": "removeLabels", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", + "name": "Get a commit", + "scope": "git", + "id": "getCommit", + "method": "GET", + "url": "/repos/{owner}/{repo}/git/commits/{commit_sha}", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/issues/labels/#remove-all-labels-from-an-issue", + "description": "Gets a Git [commit object](https://git-scm.com/book/en/v1/Git-Internals-Git-Objects#Commit-Objects).\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "documentationUrl": "https://developer.github.com/v3/git/commits/#get-a-commit", "previews": [], "headers": [], "parameters": [ @@ -28544,10 +21481,10 @@ "deprecated": null }, { - "name": "issue_number", - "description": "issue_number parameter", + "name": "commit_sha", + "description": "commit_sha parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -28555,34 +21492,31 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "number", - "description": null, - "in": null, - "type": null, - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": "issue_number", - "deprecated": true + "code": 200, + "description": "response", + "examples": [ + { + "data": "{\"sha\":\"7638417db6d59f3c431d3e1f261cc637155684cd\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd\",\"author\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"committer\":{\"date\":\"2014-11-07T22:01:45Z\",\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\"},\"message\":\"added readme, because im a good github citizen\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb\",\"sha\":\"691272480426f78a0138979dd3ce63b77f706feb\"},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5\",\"sha\":\"1acc419d4d6a9ce985db7be48c6349a0475975b5\"}],\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}" + } + ] } ], - "responses": [], "renamed": null }, { - "name": "Remove a label from an issue", - "scope": "issues", - "id": "removeLabel", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}", + "name": "List matching references", + "scope": "git", + "id": "listMatchingRefs", + "method": "GET", + "url": "/repos/{owner}/{repo}/git/matching-refs/{ref}", "isDeprecated": false, "isLegacy": false, - "description": "Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist.", - "documentationUrl": "https://developer.github.com/v3/issues/labels/#remove-a-label-from-an-issue", + "description": "Returns an array of references from your Git database that match the supplied name. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't exist in the repository, but existing refs start with `:ref`, they will be returned as an array.\n\nWhen you use this endpoint without providing a `:ref`, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`.\n\n**Note:** You need to explicitly [request a pull request](https://developer.github.com/v3/pulls/#get-a-single-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://developer.github.com/v3/git/#checking-mergeability-of-pull-requests)\".\n\nIf you request matching references for a branch named `feature` but the branch `feature` doesn't exist, the response can still include other matching head refs that start with the word `feature`, such as `featureA` and `featureB`.", + "documentationUrl": "https://developer.github.com/v3/git/refs/#list-matching-references", "previews": [], "headers": [], "parameters": [ @@ -28613,10 +21547,10 @@ "deprecated": null }, { - "name": "issue_number", - "description": "issue_number parameter", + "name": "ref", + "description": "ref parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -28626,11 +21560,11 @@ "deprecated": null }, { - "name": "name", - "description": "name parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -28639,17 +21573,17 @@ "deprecated": null }, { - "name": "number", - "description": null, - "in": null, - "type": null, - "required": null, + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, - "allowNull": null, + "allowNull": false, "mapToData": null, "validation": null, - "alias": "issue_number", - "deprecated": true + "alias": null, + "deprecated": null } ], "responses": [ @@ -28658,7 +21592,7 @@ "description": "response", "examples": [ { - "data": "[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}]" + "data": "[{\"ref\":\"refs/heads/feature-a\",\"node_id\":\"MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlLWE=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-a\",\"object\":{\"type\":\"commit\",\"sha\":\"aa218f56b14c9653891f9e74264a383fa43fefbd\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd\"}},{\"ref\":\"refs/heads/feature-b\",\"node_id\":\"MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlLWI=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-b\",\"object\":{\"type\":\"commit\",\"sha\":\"612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac\"}}]" } ] } @@ -28666,15 +21600,15 @@ "renamed": null }, { - "name": "Lock an issue", - "scope": "issues", - "id": "lock", - "method": "PUT", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/lock", + "name": "Get a single reference", + "scope": "git", + "id": "getRef", + "method": "GET", + "url": "/repos/{owner}/{repo}/git/ref/{ref}", "isDeprecated": false, "isLegacy": false, - "description": "Users with push access can lock an issue or pull request's conversation.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\"", - "documentationUrl": "https://developer.github.com/v3/issues/#lock-an-issue", + "description": "Returns a single reference from your Git database. The `:ref` in the URL must be formatted as `heads/` for branches and `tags/` for tags. If the `:ref` doesn't match an existing ref, a `404` is returned.\n\n**Note:** You need to explicitly [request a pull request](https://developer.github.com/v3/pulls/#get-a-single-pull-request) to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see \"[Checking mergeability of pull requests](https://developer.github.com/v3/git/#checking-mergeability-of-pull-requests)\".\n\nTo get the reference for a branch named `skunkworkz/featureA`, the endpoint route is:", + "documentationUrl": "https://developer.github.com/v3/git/refs/#get-a-single-reference", "previews": [], "headers": [], "parameters": [ @@ -28705,10 +21639,10 @@ "deprecated": null }, { - "name": "issue_number", - "description": "issue_number parameter", + "name": "ref", + "description": "ref parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -28716,47 +21650,31 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "lock_reason", - "description": "The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \n\\* `off-topic` \n\\* `too heated` \n\\* `resolved` \n\\* `spam`", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["off-topic", "too heated", "resolved", "spam"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, + } + ], + "responses": [ { - "name": "number", - "description": null, - "in": null, - "type": null, - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": "issue_number", - "deprecated": true + "code": 200, + "description": "response", + "examples": [ + { + "data": "{\"ref\":\"refs/heads/featureA\",\"node_id\":\"MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA\",\"object\":{\"type\":\"commit\",\"sha\":\"aa218f56b14c9653891f9e74264a383fa43fefbd\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd\"}}" + } + ] } ], - "responses": [], "renamed": null }, { - "name": "Unlock an issue", - "scope": "issues", - "id": "unlock", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/lock", + "name": "Create a reference", + "scope": "git", + "id": "createRef", + "method": "POST", + "url": "/repos/{owner}/{repo}/git/refs", "isDeprecated": false, "isLegacy": false, - "description": "Users with push access can unlock an issue's conversation.", - "documentationUrl": "https://developer.github.com/v3/issues/#unlock-an-issue", + "description": "Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.", + "documentationUrl": "https://developer.github.com/v3/git/refs/#create-a-reference", "previews": [], "headers": [], "parameters": [ @@ -28787,10 +21705,10 @@ "deprecated": null }, { - "name": "issue_number", - "description": "issue_number parameter", - "in": "PATH", - "type": "integer", + "name": "ref", + "description": "The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.", + "in": "BODY", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -28800,39 +21718,44 @@ "deprecated": null }, { - "name": "number", - "description": null, - "in": null, - "type": null, - "required": null, + "name": "sha", + "description": "The SHA1 value for this reference.", + "in": "BODY", + "type": "string", + "required": true, "enum": null, - "allowNull": null, + "allowNull": false, "mapToData": null, "validation": null, - "alias": "issue_number", - "deprecated": true + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 201, + "description": "response", + "examples": [ + { + "data": "{\"ref\":\"refs/heads/featureA\",\"node_id\":\"MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA\",\"object\":{\"type\":\"commit\",\"sha\":\"aa218f56b14c9653891f9e74264a383fa43fefbd\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd\"}}" + } + ] } ], - "responses": [], "renamed": null }, { - "name": "List reactions for an issue", - "scope": "reactions", - "id": "listForIssue", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", + "name": "Update a reference", + "scope": "git", + "id": "updateRef", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/git/refs/{ref}", "isDeprecated": false, "isLegacy": false, - "description": "List the reactions to an [issue](https://developer.github.com/v3/issues/).", - "documentationUrl": "https://developer.github.com/v3/reactions/#list-reactions-for-an-issue", - "previews": [{ "name": "squirrel-girl" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.squirrel-girl-preview+json" - } - ], + "description": "", + "documentationUrl": "https://developer.github.com/v3/git/refs/#update-a-reference", + "previews": [], + "headers": [], "parameters": [ { "name": "owner", @@ -28847,48 +21770,13 @@ "alias": null, "deprecated": null }, - { - "name": "repo", - "description": "repo parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "issue_number", - "description": "issue_number parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], + { + "name": "repo", + "description": "repo parameter", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -28896,11 +21784,11 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "ref", + "description": "ref parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -28909,11 +21797,11 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "sha", + "description": "The SHA1 value to set this reference to", + "in": "BODY", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -28922,17 +21810,17 @@ "deprecated": null }, { - "name": "number", - "description": null, - "in": null, - "type": null, - "required": null, + "name": "force", + "description": "Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work.", + "in": "BODY", + "type": "boolean", + "required": false, "enum": null, - "allowNull": null, + "allowNull": false, "mapToData": null, "validation": null, - "alias": "issue_number", - "deprecated": true + "alias": null, + "deprecated": null } ], "responses": [ @@ -28941,7 +21829,7 @@ "description": "response", "examples": [ { - "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" + "data": "{\"ref\":\"refs/heads/featureA\",\"node_id\":\"MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA\",\"object\":{\"type\":\"commit\",\"sha\":\"aa218f56b14c9653891f9e74264a383fa43fefbd\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd\"}}" } ] } @@ -28949,22 +21837,17 @@ "renamed": null }, { - "name": "Create reaction for an issue", - "scope": "reactions", - "id": "createForIssue", - "method": "POST", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", + "name": "Delete a reference", + "scope": "git", + "id": "deleteRef", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/git/refs/{ref}", "isDeprecated": false, "isLegacy": false, - "description": "Create a reaction to an [issue](https://developer.github.com/v3/issues/). A response with a `Status: 200 OK` means that you already added the reaction type to this issue.", - "documentationUrl": "https://developer.github.com/v3/reactions/#create-reaction-for-an-issue", - "previews": [{ "name": "squirrel-girl" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.squirrel-girl-preview+json" - } - ], + "description": "```\nDELETE /repos/octocat/Hello-World/git/refs/heads/feature-a\n```\n\n```\nDELETE /repos/octocat/Hello-World/git/refs/tags/v1.0\n```", + "documentationUrl": "https://developer.github.com/v3/git/refs/#delete-a-reference", + "previews": [], + "headers": [], "parameters": [ { "name": "owner", @@ -28993,84 +21876,34 @@ "deprecated": null }, { - "name": "issue_number", - "description": "issue_number parameter", + "name": "ref", + "description": "ref parameter", "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the issue.", - "in": "BODY", "type": "string", "required": true, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - }, - { - "name": "number", - "description": null, - "in": null, - "type": null, - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": "issue_number", - "deprecated": true - } - ], - "responses": [ - { - "code": 201, - "description": "response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] } ], + "responses": [], "renamed": null }, { - "name": "List events for an issue", - "scope": "issues", - "id": "listEventsForTimeline", - "method": "GET", - "url": "/repos/{owner}/{repo}/issues/{issue_number}/timeline", + "name": "Create a tag object", + "scope": "git", + "id": "createTag", + "method": "POST", + "url": "/repos/{owner}/{repo}/git/tags", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/issues/timeline/#list-events-for-an-issue", - "previews": [{ "name": "mockingbird" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.mockingbird-preview+json" - } - ], + "description": "Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then [create](https://developer.github.com/v3/git/refs/#create-a-reference) the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you only have to [create](https://developer.github.com/v3/git/refs/#create-a-reference) the tag reference - this call would be unnecessary.\n\n**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "documentationUrl": "https://developer.github.com/v3/git/tags/#create-a-tag-object", + "previews": [], + "headers": [], "parameters": [ { "name": "owner", @@ -29099,10 +21932,10 @@ "deprecated": null }, { - "name": "issue_number", - "description": "issue_number parameter", - "in": "PATH", - "type": "integer", + "name": "tag", + "description": "The tag's name. This is typically a version (e.g., \"v0.0.1\").", + "in": "BODY", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -29112,10 +21945,49 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", + "name": "message", + "description": "The tag message.", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "object", + "description": "The SHA of the git object this is tagging.", + "in": "BODY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "type", + "description": "The type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`.", + "in": "BODY", + "type": "string", + "required": true, + "enum": ["commit", "tree", "blob"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "tagger", + "description": "An object with information about the individual creating the tag.", + "in": "BODY", + "type": "object", "required": false, "enum": null, "allowNull": false, @@ -29125,10 +21997,10 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", + "name": "tagger.name", + "description": "The name of the author of the tag", + "in": "BODY", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -29138,26 +22010,39 @@ "deprecated": null }, { - "name": "number", - "description": null, - "in": null, - "type": null, - "required": null, + "name": "tagger.email", + "description": "The email of the author of the tag", + "in": "BODY", + "type": "string", + "required": false, "enum": null, - "allowNull": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "tagger.date", + "description": "When this object was tagged. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, "mapToData": null, "validation": null, - "alias": "issue_number", - "deprecated": true + "alias": null, + "deprecated": null } ], "responses": [ { - "code": 200, + "code": 201, "description": "response", "examples": [ { - "data": "[{\"id\":1,\"node_id\":\"MDEwOklzc3VlRXZlbnQx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events/1\",\"actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"event\":\"closed\",\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"commit_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"created_at\":\"2011-04-14T16:00:49Z\"}]" + "data": "{\"node_id\":\"MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==\",\"tag\":\"v0.0.1\",\"sha\":\"940bd336248efae0f9ee5bc7b2d5c985887b16ac\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac\",\"message\":\"initial version\",\"tagger\":{\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\",\"date\":\"2014-11-07T22:01:45Z\"},\"object\":{\"type\":\"commit\",\"sha\":\"c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c\"},\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}" } ] } @@ -29165,15 +22050,15 @@ "renamed": null }, { - "name": "List deploy keys", - "scope": "repos", - "id": "listDeployKeys", + "name": "Get a tag", + "scope": "git", + "id": "getTag", "method": "GET", - "url": "/repos/{owner}/{repo}/keys", + "url": "/repos/{owner}/{repo}/git/tags/{tag_sha}", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/repos/keys/#list-deploy-keys", + "description": "**Signature verification object**\n\nThe response will include a `verification` object that describes the result of verifying the commit's signature. The following fields are included in the `verification` object:\n\nThese are the possible values for `reason` in the `verification` object:\n\n| Value | Description |\n| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| `expired_key` | The key that made the signature is expired. |\n| `not_signing_key` | The \"signing\" flag is not among the usage flags in the GPG key that made the signature. |\n| `gpgverify_error` | There was an error communicating with the signature verification service. |\n| `gpgverify_unavailable` | The signature verification service is currently unavailable. |\n| `unsigned` | The object does not include a signature. |\n| `unknown_signature_type` | A non-PGP signature was found in the commit. |\n| `no_user` | No user was associated with the `committer` email address in the commit. |\n| `unverified_email` | The `committer` email address in the commit was associated with a user, but the email address is not verified on her/his account. |\n| `bad_email` | The `committer` email address in the commit is not included in the identities of the PGP key that made the signature. |\n| `unknown_key` | The key that made the signature has not been registered with any user's account. |\n| `malformed_signature` | There was an error parsing the signature. |\n| `invalid` | The signature could not be cryptographically verified using the key whose key-id was found in the signature. |\n| `valid` | None of the above errors applied, so the signature is considered to be verified. |", + "documentationUrl": "https://developer.github.com/v3/git/tags/#get-a-tag", "previews": [], "headers": [], "parameters": [ @@ -29204,24 +22089,11 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "tag_sha", + "description": "tag_sha parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -29236,7 +22108,7 @@ "description": "response", "examples": [ { - "data": "[{\"id\":1,\"key\":\"ssh-rsa AAA...\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/keys/1\",\"title\":\"octocat@octomac\",\"verified\":true,\"created_at\":\"2014-12-10T15:53:42Z\",\"read_only\":true}]" + "data": "{\"node_id\":\"MDM6VGFnOTQwYmQzMzYyNDhlZmFlMGY5ZWU1YmM3YjJkNWM5ODU4ODdiMTZhYw==\",\"tag\":\"v0.0.1\",\"sha\":\"940bd336248efae0f9ee5bc7b2d5c985887b16ac\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/tags/940bd336248efae0f9ee5bc7b2d5c985887b16ac\",\"message\":\"initial version\",\"tagger\":{\"name\":\"Monalisa Octocat\",\"email\":\"octocat@github.com\",\"date\":\"2014-11-07T22:01:45Z\"},\"object\":{\"type\":\"commit\",\"sha\":\"c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c\"},\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}}" } ] } @@ -29244,15 +22116,15 @@ "renamed": null }, { - "name": "Add a new deploy key", - "scope": "repos", - "id": "addDeployKey", + "name": "Create a tree", + "scope": "git", + "id": "createTree", "method": "POST", - "url": "/repos/{owner}/{repo}/keys", + "url": "/repos/{owner}/{repo}/git/trees", "isDeprecated": false, "isLegacy": false, - "description": "Here's how you can create a read-only deploy key:\n\n", - "documentationUrl": "https://developer.github.com/v3/repos/keys/#add-a-new-deploy-key", + "description": "The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure.\n\nIf you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see \"[Create a commit](https://developer.github.com/v3/git/commits/#create-a-commit)\" and \"[Update a reference](https://developer.github.com/v3/git/refs/#update-a-reference).\"", + "documentationUrl": "https://developer.github.com/v3/git/trees/#create-a-tree", "previews": [], "headers": [], "parameters": [ @@ -29283,11 +22155,11 @@ "deprecated": null }, { - "name": "title", - "description": "A name for the key.", + "name": "tree", + "description": "Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure.", "in": "BODY", - "type": "string", - "required": false, + "type": "object[]", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -29296,11 +22168,11 @@ "deprecated": null }, { - "name": "key", - "description": "The contents of the key.", + "name": "tree[].path", + "description": "The file referenced in the tree.", "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -29309,64 +22181,50 @@ "deprecated": null }, { - "name": "read_only", - "description": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://help.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://help.github.com/articles/permission-levels-for-a-user-account-repository/).\"", + "name": "tree[].mode", + "description": "The file mode; one of `100644` for file (blob), `100755` for executable (blob), `040000` for subdirectory (tree), `160000` for submodule (commit), or `120000` for a blob that specifies the path of a symlink.", "in": "BODY", - "type": "boolean", + "type": "string", "required": false, - "enum": null, + "enum": ["100644", "100755", "040000", "160000", "120000"], "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ + }, { - "code": 201, - "description": "response", - "examples": [ - { - "data": "{\"id\":1,\"key\":\"ssh-rsa AAA...\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/keys/1\",\"title\":\"octocat@octomac\",\"verified\":true,\"created_at\":\"2014-12-10T15:53:42Z\",\"read_only\":true}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a deploy key", - "scope": "repos", - "id": "getDeployKey", - "method": "GET", - "url": "/repos/{owner}/{repo}/keys/{key_id}", - "isDeprecated": false, - "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/repos/keys/#get-a-deploy-key", - "previews": [], - "headers": [], - "parameters": [ + "name": "tree[].type", + "description": "Either `blob`, `tree`, or `commit`.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["blob", "tree", "commit"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { - "name": "owner", - "description": "owner parameter", - "in": "PATH", + "name": "tree[].sha", + "description": "The SHA1 checksum ID of the object in the tree. Also called `tree.sha`. If the value is `null` then the file will be deleted. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", + "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, - "allowNull": false, + "allowNull": true, "mapToData": null, "validation": null, "alias": null, "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "tree[].content", + "description": "The content you want this file to have. GitHub will write this blob out and use that SHA for this entry. Use either this, or `tree.sha`. \n \n**Note:** Use either `tree.sha` or `content` to specify the contents of the entry. Using both `tree.sha` and `content` will return an error.", + "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -29375,11 +22233,11 @@ "deprecated": null }, { - "name": "key_id", - "description": "key_id parameter", - "in": "PATH", - "type": "integer", - "required": true, + "name": "base_tree", + "description": "The SHA1 of the tree you want to update with new data. If you don't set this, the commit will be created on top of everything; however, it will only contain your change, the rest of your files will show up as deleted.", + "in": "BODY", + "type": "string", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -29390,11 +22248,11 @@ ], "responses": [ { - "code": 200, + "code": 201, "description": "response", "examples": [ { - "data": "{\"id\":1,\"key\":\"ssh-rsa AAA...\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/keys/1\",\"title\":\"octocat@octomac\",\"verified\":true,\"created_at\":\"2014-12-10T15:53:42Z\",\"read_only\":true}" + "data": "{\"sha\":\"cd8274d15fa3ae2ab983129fb037999f264ba9a7\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/trees/cd8274d15fa3ae2ab983129fb037999f264ba9a7\",\"tree\":[{\"path\":\"file.rb\",\"mode\":\"100644\",\"type\":\"blob\",\"size\":132,\"sha\":\"7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/7c258a9869f33c1e1e1f74fbb32f07c86cb5a75b\"}]}" } ] } @@ -29402,15 +22260,15 @@ "renamed": null }, { - "name": "Remove a deploy key", - "scope": "repos", - "id": "removeDeployKey", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/keys/{key_id}", + "name": "Get a tree", + "scope": "git", + "id": "getTree", + "method": "GET", + "url": "/repos/{owner}/{repo}/git/trees/{tree_sha}", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/repos/keys/#remove-a-deploy-key", + "description": "Returns a single tree using the SHA1 value for that tree.\n\nIf `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, you can clone the repository and iterate over the Git data locally.", + "documentationUrl": "https://developer.github.com/v3/git/trees/#get-a-tree", "previews": [], "headers": [], "parameters": [ @@ -29441,10 +22299,10 @@ "deprecated": null }, { - "name": "key_id", - "description": "key_id parameter", + "name": "tree_sha", + "description": "tree_sha parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -29452,21 +22310,44 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "recursive", + "description": "recursive parameter", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": ["1"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "If `truncated` is `true` in the response then the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, you can clone the repository and iterate over the Git data locally.", + "examples": [ + { + "data": "{\"sha\":\"9fb037999f264ba9a7fc6274d15fa3ae2ab98312\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/trees/9fb037999f264ba9a7fc6274d15fa3ae2ab98312\",\"tree\":[{\"path\":\"file.rb\",\"mode\":\"100644\",\"type\":\"blob\",\"size\":30,\"sha\":\"44b4fc6d56897b048c772eb4087f854f46256132\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/44b4fc6d56897b048c772eb4087f854f46256132\"},{\"path\":\"subdir\",\"mode\":\"040000\",\"type\":\"tree\",\"sha\":\"f484d249c660418515fb01c2b9662073663c242e\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/f484d249c660418515fb01c2b9662073663c242e\"},{\"path\":\"exec_file\",\"mode\":\"100755\",\"type\":\"blob\",\"size\":75,\"sha\":\"45b983be36b73c0788dc9cbcb76cbb80fc7bb057\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/blobs/45b983be36b73c0788dc9cbcb76cbb80fc7bb057\"}],\"truncated\":false}" + } + ] } ], - "responses": [], "renamed": null }, { - "name": "List all labels for this repository", - "scope": "issues", - "id": "listLabelsForRepo", + "name": "List hooks", + "scope": "repos", + "id": "listHooks", "method": "GET", - "url": "/repos/{owner}/{repo}/labels", + "url": "/repos/{owner}/{repo}/hooks", "isDeprecated": false, "isLegacy": false, "description": "", - "documentationUrl": "https://developer.github.com/v3/issues/labels/#list-all-labels-for-this-repository", + "documentationUrl": "https://developer.github.com/v3/repos/hooks/#list-hooks", "previews": [], "headers": [], "parameters": [ @@ -29529,7 +22410,7 @@ "description": "response", "examples": [ { - "data": "[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true},{\"id\":208045947,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDc=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/enhancement\",\"name\":\"enhancement\",\"description\":\"New feature or request\",\"color\":\"a2eeef\",\"default\":false}]" + "data": "[{\"type\":\"Repository\",\"id\":12345678,\"name\":\"web\",\"active\":true,\"events\":[\"push\",\"pull_request\"],\"config\":{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"url\":\"https://example.com/webhook\"},\"updated_at\":\"2019-06-03T00:57:16Z\",\"created_at\":\"2019-06-03T00:57:16Z\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678\",\"test_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test\",\"ping_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings\",\"last_response\":{\"code\":null,\"status\":\"unused\",\"message\":null}}]" } ] } @@ -29537,15 +22418,15 @@ "renamed": null }, { - "name": "Create a label", - "scope": "issues", - "id": "createLabel", + "name": "Create a hook", + "scope": "repos", + "id": "createHook", "method": "POST", - "url": "/repos/{owner}/{repo}/labels", + "url": "/repos/{owner}/{repo}/hooks", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/issues/labels/#create-a-label", + "description": "Repositories can have multiple webhooks installed. Each webhook should have a unique `config`. Multiple webhooks can share the same `config` as long as those webhooks do not have any `events` that overlap.\n\nHere's how you can create a hook that posts payloads in JSON format:", + "documentationUrl": "https://developer.github.com/v3/repos/hooks/#create-a-hook", "previews": [], "headers": [], "parameters": [ @@ -29577,9 +22458,22 @@ }, { "name": "name", - "description": "The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see [emoji-cheat-sheet.com](http://emoji-cheat-sheet.com/).", + "description": "Use `web` to create a webhook. Default: `web`. This parameter only accepts the value `web`.", "in": "BODY", "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "config", + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/repos/hooks/#create-hook-config-params).", + "in": "BODY", + "type": "object", "required": true, "enum": null, "allowNull": false, @@ -29589,8 +22483,8 @@ "deprecated": null }, { - "name": "color", - "description": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.", + "name": "config.url", + "description": "The URL to which the payloads will be delivered.", "in": "BODY", "type": "string", "required": true, @@ -29602,8 +22496,34 @@ "deprecated": null }, { - "name": "description", - "description": "A short description of the label.", + "name": "config.content_type", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "config.secret", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/webhooks/#delivery-headers) header.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "config.insecure_ssl", + "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", "in": "BODY", "type": "string", "required": false, @@ -29613,6 +22533,32 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "events", + "description": "Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for.", + "in": "BODY", + "type": "string[]", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "active", + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "in": "BODY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -29621,7 +22567,7 @@ "description": "response", "examples": [ { - "data": "{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}" + "data": "{\"type\":\"Repository\",\"id\":12345678,\"name\":\"web\",\"active\":true,\"events\":[\"push\",\"pull_request\"],\"config\":{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"url\":\"https://example.com/webhook\"},\"updated_at\":\"2019-06-03T00:57:16Z\",\"created_at\":\"2019-06-03T00:57:16Z\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678\",\"test_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test\",\"ping_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings\",\"last_response\":{\"code\":null,\"status\":\"unused\",\"message\":null}}" } ] } @@ -29629,15 +22575,15 @@ "renamed": null }, { - "name": "Get a single label", - "scope": "issues", - "id": "getLabel", + "name": "Get single hook", + "scope": "repos", + "id": "getHook", "method": "GET", - "url": "/repos/{owner}/{repo}/labels/{name}", + "url": "/repos/{owner}/{repo}/hooks/{hook_id}", "isDeprecated": false, "isLegacy": false, "description": "", - "documentationUrl": "https://developer.github.com/v3/issues/labels/#get-a-single-label", + "documentationUrl": "https://developer.github.com/v3/repos/hooks/#get-single-hook", "previews": [], "headers": [], "parameters": [ @@ -29668,10 +22614,10 @@ "deprecated": null }, { - "name": "name", - "description": "name parameter", + "name": "hook_id", + "description": "hook_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -29687,7 +22633,7 @@ "description": "response", "examples": [ { - "data": "{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}" + "data": "{\"type\":\"Repository\",\"id\":12345678,\"name\":\"web\",\"active\":true,\"events\":[\"push\",\"pull_request\"],\"config\":{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"url\":\"https://example.com/webhook\"},\"updated_at\":\"2019-06-03T00:57:16Z\",\"created_at\":\"2019-06-03T00:57:16Z\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678\",\"test_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test\",\"ping_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings\",\"last_response\":{\"code\":null,\"status\":\"unused\",\"message\":null}}" } ] } @@ -29695,15 +22641,15 @@ "renamed": null }, { - "name": "Update a label", - "scope": "issues", - "id": "updateLabel", + "name": "Edit a hook", + "scope": "repos", + "id": "updateHook", "method": "PATCH", - "url": "/repos/{owner}/{repo}/labels/{name}", + "url": "/repos/{owner}/{repo}/hooks/{hook_id}", "isDeprecated": false, "isLegacy": false, "description": "", - "documentationUrl": "https://developer.github.com/v3/issues/labels/#update-a-label", + "documentationUrl": "https://developer.github.com/v3/repos/hooks/#edit-a-hook", "previews": [], "headers": [], "parameters": [ @@ -29734,10 +22680,10 @@ "deprecated": null }, { - "name": "name", - "description": "name parameter", + "name": "hook_id", + "description": "hook_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -29747,10 +22693,10 @@ "deprecated": null }, { - "name": "new_name", - "description": "The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see [emoji-cheat-sheet.com](http://emoji-cheat-sheet.com/).", + "name": "config", + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/v3/repos/hooks/#create-hook-config-params).", "in": "BODY", - "type": "string", + "type": "object", "required": false, "enum": null, "allowNull": false, @@ -29760,11 +22706,11 @@ "deprecated": null }, { - "name": "color", - "description": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.", + "name": "config.url", + "description": "The URL to which the payloads will be delivered.", "in": "BODY", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -29773,8 +22719,8 @@ "deprecated": null }, { - "name": "description", - "description": "A short description of the label.", + "name": "config.content_type", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", "in": "BODY", "type": "string", "required": false, @@ -29784,40 +22730,13 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug%20:bug:\",\"name\":\"bug :bug:\",\"description\":\"Small bug fix required\",\"color\":\"b01f26\",\"default\":true}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Delete a label", - "scope": "issues", - "id": "deleteLabel", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/labels/{name}", - "isDeprecated": false, - "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/issues/labels/#delete-a-label", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "owner", - "description": "owner parameter", - "in": "PATH", + "name": "config.secret", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value in the [`X-Hub-Signature`](https://developer.github.com/webhooks/#delivery-headers) header.", + "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -29826,11 +22745,11 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "config.insecure_ssl", + "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -29839,41 +22758,24 @@ "deprecated": null }, { - "name": "name", - "description": "name parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "events", + "description": "Determines what [events](https://developer.github.com/v3/activity/events/types/) the hook is triggered for. This replaces the entire array of events.", + "in": "BODY", + "type": "string[]", + "required": false, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "List languages", - "scope": "repos", - "id": "listLanguages", - "method": "GET", - "url": "/repos/{owner}/{repo}/languages", - "isDeprecated": false, - "isLegacy": false, - "description": "Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.", - "documentationUrl": "https://developer.github.com/v3/repos/#list-languages", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "owner", - "description": "owner parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "add_events", + "description": "Determines a list of events to be added to the list of events that the Hook triggers for.", + "in": "BODY", + "type": "string[]", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -29882,11 +22784,24 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "remove_events", + "description": "Determines a list of events to be removed from the list of events that the Hook triggers for.", + "in": "BODY", + "type": "string[]", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "active", + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "in": "BODY", + "type": "boolean", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -29899,21 +22814,25 @@ { "code": 200, "description": "response", - "examples": [{ "data": "{\"C\":78769,\"Python\":7769}" }] + "examples": [ + { + "data": "{\"type\":\"Repository\",\"id\":12345678,\"name\":\"web\",\"active\":true,\"events\":[\"push\",\"pull_request\"],\"config\":{\"content_type\":\"json\",\"insecure_ssl\":\"0\",\"url\":\"https://example.com/webhook\"},\"updated_at\":\"2019-06-03T00:57:16Z\",\"created_at\":\"2019-06-03T00:57:16Z\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678\",\"test_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test\",\"ping_url\":\"https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings\",\"last_response\":{\"code\":null,\"status\":\"unused\",\"message\":null}}" + } + ] } ], "renamed": null }, { - "name": "Get the contents of a repository's license", - "scope": "licenses", - "id": "getForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/license", + "name": "Delete a hook", + "scope": "repos", + "id": "deleteHook", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/hooks/{hook_id}", "isDeprecated": false, "isLegacy": false, - "description": "This method returns the contents of the repository's license file, if one is detected.\n\nSimilar to [the repository contents API](https://developer.github.com/v3/repos/contents/#get-contents), this method also supports [custom media types](https://developer.github.com/v3/repos/contents/#custom-media-types) for retrieving the raw license content or rendered license HTML.", - "documentationUrl": "https://developer.github.com/v3/licenses/#get-the-contents-of-a-repositorys-license", + "description": "", + "documentationUrl": "https://developer.github.com/v3/repos/hooks/#delete-a-hook", "previews": [], "headers": [], "parameters": [ @@ -29942,31 +22861,34 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ + }, { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"name\":\"LICENSE\",\"path\":\"LICENSE\",\"sha\":\"401c59dcc4570b954dd6d345e76199e1f4e76266\",\"size\":1077,\"url\":\"https://api.github.com/repos/benbalter/gman/contents/LICENSE?ref=master\",\"html_url\":\"https://github.com/benbalter/gman/blob/master/LICENSE\",\"git_url\":\"https://api.github.com/repos/benbalter/gman/git/blobs/401c59dcc4570b954dd6d345e76199e1f4e76266\",\"download_url\":\"https://raw.githubusercontent.com/benbalter/gman/master/LICENSE?lab=true\",\"type\":\"file\",\"content\":\"VGhlIE1JVCBMaWNlbnNlIChNSVQpCgpDb3B5cmlnaHQgKGMpIDIwMTMgQmVu\\nIEJhbHRlcgoKUGVybWlzc2lvbiBpcyBoZXJlYnkgZ3JhbnRlZCwgZnJlZSBv\\nZiBjaGFyZ2UsIHRvIGFueSBwZXJzb24gb2J0YWluaW5nIGEgY29weSBvZgp0\\naGlzIHNvZnR3YXJlIGFuZCBhc3NvY2lhdGVkIGRvY3VtZW50YXRpb24gZmls\\nZXMgKHRoZSAiU29mdHdhcmUiKSwgdG8gZGVhbCBpbgp0aGUgU29mdHdhcmUg\\nd2l0aG91dCByZXN0cmljdGlvbiwgaW5jbHVkaW5nIHdpdGhvdXQgbGltaXRh\\ndGlvbiB0aGUgcmlnaHRzIHRvCnVzZSwgY29weSwgbW9kaWZ5LCBtZXJnZSwg\\ncHVibGlzaCwgZGlzdHJpYnV0ZSwgc3VibGljZW5zZSwgYW5kL29yIHNlbGwg\\nY29waWVzIG9mCnRoZSBTb2Z0d2FyZSwgYW5kIHRvIHBlcm1pdCBwZXJzb25z\\nIHRvIHdob20gdGhlIFNvZnR3YXJlIGlzIGZ1cm5pc2hlZCB0byBkbyBzbywK\\nc3ViamVjdCB0byB0aGUgZm9sbG93aW5nIGNvbmRpdGlvbnM6CgpUaGUgYWJv\\ndmUgY29weXJpZ2h0IG5vdGljZSBhbmQgdGhpcyBwZXJtaXNzaW9uIG5vdGlj\\nZSBzaGFsbCBiZSBpbmNsdWRlZCBpbiBhbGwKY29waWVzIG9yIHN1YnN0YW50\\naWFsIHBvcnRpb25zIG9mIHRoZSBTb2Z0d2FyZS4KClRIRSBTT0ZUV0FSRSBJ\\nUyBQUk9WSURFRCAiQVMgSVMiLCBXSVRIT1VUIFdBUlJBTlRZIE9GIEFOWSBL\\nSU5ELCBFWFBSRVNTIE9SCklNUExJRUQsIElOQ0xVRElORyBCVVQgTk9UIExJ\\nTUlURUQgVE8gVEhFIFdBUlJBTlRJRVMgT0YgTUVSQ0hBTlRBQklMSVRZLCBG\\nSVRORVNTCkZPUiBBIFBBUlRJQ1VMQVIgUFVSUE9TRSBBTkQgTk9OSU5GUklO\\nR0VNRU5ULiBJTiBOTyBFVkVOVCBTSEFMTCBUSEUgQVVUSE9SUyBPUgpDT1BZ\\nUklHSFQgSE9MREVSUyBCRSBMSUFCTEUgRk9SIEFOWSBDTEFJTSwgREFNQUdF\\nUyBPUiBPVEhFUiBMSUFCSUxJVFksIFdIRVRIRVIKSU4gQU4gQUNUSU9OIE9G\\nIENPTlRSQUNULCBUT1JUIE9SIE9USEVSV0lTRSwgQVJJU0lORyBGUk9NLCBP\\nVVQgT0YgT1IgSU4KQ09OTkVDVElPTiBXSVRIIFRIRSBTT0ZUV0FSRSBPUiBU\\nSEUgVVNFIE9SIE9USEVSIERFQUxJTkdTIElOIFRIRSBTT0ZUV0FSRS4K\\n\",\"encoding\":\"base64\",\"_links\":{\"self\":\"https://api.github.com/repos/benbalter/gman/contents/LICENSE?ref=master\",\"git\":\"https://api.github.com/repos/benbalter/gman/git/blobs/401c59dcc4570b954dd6d345e76199e1f4e76266\",\"html\":\"https://github.com/benbalter/gman/blob/master/LICENSE\"},\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"}}" - } - ] + "name": "hook_id", + "description": "hook_id parameter", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], + "responses": [], "renamed": null }, { - "name": "Perform a merge", + "name": "Ping a hook", "scope": "repos", - "id": "merge", + "id": "pingHook", "method": "POST", - "url": "/repos/{owner}/{repo}/merges", + "url": "/repos/{owner}/{repo}/hooks/{hook_id}/pings", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/repos/merging/#perform-a-merge", + "description": "This will trigger a [ping event](https://developer.github.com/webhooks/#ping-event) to be sent to the hook.", + "documentationUrl": "https://developer.github.com/v3/repos/hooks/#ping-a-hook", "previews": [], "headers": [], "parameters": [ @@ -29997,23 +22919,10 @@ "deprecated": null }, { - "name": "base", - "description": "The name of the base branch that the head will be merged into.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "head", - "description": "The head to merge. This can be a branch name or a commit SHA1.", - "in": "BODY", - "type": "string", + "name": "hook_id", + "description": "hook_id parameter", + "in": "PATH", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -30021,57 +22930,21 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "commit_message", - "description": "Commit message to use for the merge commit. If omitted, a default message will be used.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "Successful Response (The resulting merge commit)", - "examples": [ - { - "data": "{\"sha\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"node_id\":\"MDY6Q29tbWl0N2ZkMWE2MGIwMWY5MWIzMTRmNTk5NTVhNGU0ZDRlODBkOGVkZjExZA==\",\"commit\":{\"author\":{\"name\":\"The Octocat\",\"date\":\"2012-03-06T15:06:50-08:00\",\"email\":\"octocat@nowhere.com\"},\"committer\":{\"name\":\"The Octocat\",\"date\":\"2012-03-06T15:06:50-08:00\",\"email\":\"octocat@nowhere.com\"},\"message\":\"Shipped cool_feature!\",\"tree\":{\"sha\":\"b4eecafa9be2f2006ce1b709d6857b07069b4608\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608\"},\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments\",\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"sha\":\"553c2077f0edc3d5dc5d17262f6aa498e69d6f8e\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e\"},{\"sha\":\"762941318ee16e59dabbacb1b4049eec22f0d303\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303\"}]}" - } - ] - }, - { - "code": 404, - "description": "response", - "examples": [ - { "data": "{\"message\":\"Base does not exist\"}" }, - { "data": "{\"message\":\"Head does not exist\"}" } - ] - }, - { - "code": 409, - "description": "Merge conflict response", - "examples": [{ "data": "{\"message\":\"Merge Conflict\"}" }] } ], + "responses": [], "renamed": null }, { - "name": "List milestones for a repository", - "scope": "issues", - "id": "listMilestonesForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/milestones", + "name": "Test a push hook", + "scope": "repos", + "id": "testPushHook", + "method": "POST", + "url": "/repos/{owner}/{repo}/hooks/{hook_id}/tests", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository", + "description": "This will trigger the hook with the latest push to the current repository if the hook is subscribed to `push` events. If the hook is not subscribed to `push` events, the server will respond with 204 but no test POST will be generated.\n\n**Note**: Previously `/repos/:owner/:repo/hooks/:hook_id/test`", + "documentationUrl": "https://developer.github.com/v3/repos/hooks/#test-a-push-hook", "previews": [], "headers": [], "parameters": [ @@ -30102,63 +22975,11 @@ "deprecated": null }, { - "name": "state", - "description": "The state of the milestone. Either `open`, `closed`, or `all`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["open", "closed", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sort", - "description": "What to sort results by. Either `due_on` or `completeness`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["due_on", "completeness"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "The direction of the sort. Either `asc` or `desc`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", + "name": "hook_id", + "description": "hook_id parameter", + "in": "PATH", "type": "integer", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -30167,29 +22988,19 @@ "deprecated": null } ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"}]" - } - ] - } - ], + "responses": [], "renamed": null }, { - "name": "Create a milestone", - "scope": "issues", - "id": "createMilestone", - "method": "POST", - "url": "/repos/{owner}/{repo}/milestones", + "name": "Start an import", + "scope": "migrations", + "id": "startImport", + "method": "PUT", + "url": "/repos/{owner}/{repo}/import", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/issues/milestones/#create-a-milestone", + "description": "Start a source import to a GitHub repository using GitHub Importer.", + "documentationUrl": "https://developer.github.com/v3/migrations/source_imports/#start-an-import", "previews": [], "headers": [], "parameters": [ @@ -30220,8 +23031,8 @@ "deprecated": null }, { - "name": "title", - "description": "The title of the milestone.", + "name": "vcs_url", + "description": "The URL of the originating repository.", "in": "BODY", "type": "string", "required": true, @@ -30233,12 +23044,12 @@ "deprecated": null }, { - "name": "state", - "description": "The state of the milestone. Either `open` or `closed`.", + "name": "vcs", + "description": "The originating VCS type. Can be one of `subversion`, `git`, `mercurial`, or `tfvc`. Please be aware that without this parameter, the import job will take additional time to detect the VCS type before beginning the import. This detection step will be reflected in the response.", "in": "BODY", "type": "string", "required": false, - "enum": ["open", "closed"], + "enum": ["subversion", "git", "mercurial", "tfvc"], "allowNull": false, "mapToData": null, "validation": null, @@ -30246,8 +23057,8 @@ "deprecated": null }, { - "name": "description", - "description": "A description of the milestone.", + "name": "vcs_username", + "description": "If authentication is required, the username to provide to `vcs_url`.", "in": "BODY", "type": "string", "required": false, @@ -30259,8 +23070,21 @@ "deprecated": null }, { - "name": "due_on", - "description": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "name": "vcs_password", + "description": "If authentication is required, the password to provide to `vcs_url`.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "tfvc_project", + "description": "For a tfvc import, the name of the project that is being imported.", "in": "BODY", "type": "string", "required": false, @@ -30278,7 +23102,7 @@ "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"}" + "data": "{\"vcs\":\"subversion\",\"use_lfs\":\"undecided\",\"vcs_url\":\"http://svn.mycompany.com/svn/myproject\",\"status\":\"importing\",\"status_text\":\"Importing...\",\"has_large_files\":false,\"large_files_size\":0,\"large_files_count\":0,\"authors_count\":0,\"percent\":42,\"commit_count\":1042,\"url\":\"https://api.github.com/repos/octocat/socm/import\",\"html_url\":\"https://import.github.com/octocat/socm/import\",\"authors_url\":\"https://api.github.com/repos/octocat/socm/import/authors\",\"repository_url\":\"https://api.github.com/repos/octocat/socm\"}" } ] } @@ -30286,15 +23110,15 @@ "renamed": null }, { - "name": "Get a single milestone", - "scope": "issues", - "id": "getMilestone", + "name": "Get import progress", + "scope": "migrations", + "id": "getImportProgress", "method": "GET", - "url": "/repos/{owner}/{repo}/milestones/{milestone_number}", + "url": "/repos/{owner}/{repo}/import", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/issues/milestones/#get-a-single-milestone", + "description": "View the progress of an import.\n\n**Import status**\n\nThis section includes details about the possible values of the `status` field of the Import Progress response.\n\nAn import that does not have errors will progress through these steps:\n\n* `detecting` - the \"detection\" step of the import is in progress because the request did not include a `vcs` parameter. The import is identifying the type of source control present at the URL.\n* `importing` - the \"raw\" step of the import is in progress. This is where commit data is fetched from the original repository. The import progress response will include `commit_count` (the total number of raw commits that will be imported) and `percent` (0 - 100, the current progress through the import).\n* `mapping` - the \"rewrite\" step of the import is in progress. This is where SVN branches are converted to Git branches, and where author updates are applied. The import progress response does not include progress information.\n* `pushing` - the \"push\" step of the import is in progress. This is where the importer updates the repository on GitHub. The import progress response will include `push_percent`, which is the percent value reported by `git push` when it is \"Writing objects\".\n* `complete` - the import is complete, and the repository is ready on GitHub.\n\nIf there are problems, you will see one of these in the `status` field:\n\n* `auth_failed` - the import requires authentication in order to connect to the original repository. To update authentication for the import, please see the [Update Existing Import](https://developer.github.com/v3/migrations/source_imports/#update-existing-import) section.\n* `error` - the import encountered an error. The import progress response will include the `failed_step` and an error message. Contact [GitHub Support](https://github.com/contact) or [GitHub Premium Support](https://premium.githubsupport.com) for more information.\n* `detection_needs_auth` - the importer requires authentication for the originating repository to continue detection. To update authentication for the import, please see the [Update Existing Import](https://developer.github.com/v3/migrations/source_imports/#update-existing-import) section.\n* `detection_found_nothing` - the importer didn't recognize any source control at the URL. To resolve, [Cancel the import](https://developer.github.com/v3/migrations/source_imports/#cancel-an-import) and [retry](https://developer.github.com/v3/migrations/source_imports/#start-an-import) with the correct URL.\n* `detection_found_multiple` - the importer found several projects or repositories at the provided URL. When this is the case, the Import Progress response will also include a `project_choices` field with the possible project choices as values. To update project choice, please see the [Update Existing Import](https://developer.github.com/v3/migrations/source_imports/#update-existing-import) section.\n\n**The project_choices field**\n\nWhen multiple projects are found at the provided URL, the response hash will include a `project_choices` field, the value of which is an array of hashes each representing a project choice. The exact key/value pairs of the project hashes will differ depending on the version control type.\n\n**Git LFS related fields**\n\nThis section includes details about Git LFS related fields that may be present in the Import Progress response.\n\n* `use_lfs` - describes whether the import has been opted in or out of using Git LFS. The value can be `opt_in`, `opt_out`, or `undecided` if no action has been taken.\n* `has_large_files` - the boolean value describing whether files larger than 100MB were found during the `importing` step.\n* `large_files_size` - the total size in gigabytes of files larger than 100MB found in the originating repository.\n* `large_files_count` - the total number of files larger than 100MB found in the originating repository. To see a list of these files, make a \"Get Large Files\" request.", + "documentationUrl": "https://developer.github.com/v3/migrations/source_imports/#get-import-progress", "previews": [], "headers": [], "parameters": [ @@ -30323,32 +23147,6 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "milestone_number", - "description": "milestone_number parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "number", - "description": null, - "in": null, - "type": null, - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": "milestone_number", - "deprecated": true } ], "responses": [ @@ -30357,7 +23155,7 @@ "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"}" + "data": "{\"vcs\":\"subversion\",\"use_lfs\":\"opt_in\",\"vcs_url\":\"http://svn.mycompany.com/svn/myproject\",\"status\":\"complete\",\"status_text\":\"Done\",\"has_large_files\":true,\"large_files_size\":132331036,\"large_files_count\":1,\"authors_count\":4,\"url\":\"https://api.github.com/repos/octocat/socm/import\",\"html_url\":\"https://import.github.com/octocat/socm/import\",\"authors_url\":\"https://api.github.com/repos/octocat/socm/import/authors\",\"repository_url\":\"https://api.github.com/repos/octocat/socm\"}" } ] } @@ -30365,15 +23163,15 @@ "renamed": null }, { - "name": "Update a milestone", - "scope": "issues", - "id": "updateMilestone", + "name": "Update existing import", + "scope": "migrations", + "id": "updateImport", "method": "PATCH", - "url": "/repos/{owner}/{repo}/milestones/{milestone_number}", + "url": "/repos/{owner}/{repo}/import", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/issues/milestones/#update-a-milestone", + "description": "An import can be updated with credentials or a project choice by passing in the appropriate parameters in this API request. If no parameters are provided, the import will be restarted.\n\nSome servers (e.g. TFS servers) can have several projects at a single URL. In those cases the import progress will have the status `detection_found_multiple` and the Import Progress response will include a `project_choices` array. You can select the project to import by providing one of the objects in the `project_choices` array in the update request.\n\nThe following example demonstrates the workflow for updating an import with \"project1\" as the project choice. Given a `project_choices` array like such:\n\nTo restart an import, no parameters are provided in the update request.", + "documentationUrl": "https://developer.github.com/v3/migrations/source_imports/#update-existing-import", "previews": [], "headers": [], "parameters": [ @@ -30404,47 +23202,8 @@ "deprecated": null }, { - "name": "milestone_number", - "description": "milestone_number parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "title", - "description": "The title of the milestone.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "The state of the milestone. Either `open` or `closed`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["open", "closed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "A description of the milestone.", + "name": "vcs_username", + "description": "The username to provide to the originating repository.", "in": "BODY", "type": "string", "required": false, @@ -30456,8 +23215,8 @@ "deprecated": null }, { - "name": "due_on", - "description": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "name": "vcs_password", + "description": "The password to provide to the originating repository.", "in": "BODY", "type": "string", "required": false, @@ -30467,19 +23226,6 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "number", - "description": null, - "in": null, - "type": null, - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": "milestone_number", - "deprecated": true } ], "responses": [ @@ -30488,23 +23234,29 @@ "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"}" + "data": "{\"vcs\":\"subversion\",\"use_lfs\":\"undecided\",\"vcs_url\":\"http://svn.mycompany.com/svn/myproject\",\"status\":\"detecting\",\"url\":\"https://api.github.com/repos/octocat/socm/import\",\"html_url\":\"https://import.github.com/octocat/socm/import\",\"authors_url\":\"https://api.github.com/repos/octocat/socm/import/authors\",\"repository_url\":\"https://api.github.com/repos/octocat/socm\"}" + }, + { + "data": "{\"vcs\":\"tfvc\",\"use_lfs\":\"undecided\",\"vcs_url\":\"http://tfs.mycompany.com/tfs/myproject\",\"tfvc_project\":\"project1\",\"status\":\"importing\",\"status_text\":\"Importing...\",\"has_large_files\":false,\"large_files_size\":0,\"large_files_count\":0,\"authors_count\":0,\"percent\":42,\"commit_count\":1042,\"url\":\"https://api.github.com/repos/octocat/socm/import\",\"html_url\":\"https://import.github.com/octocat/socm/import\",\"authors_url\":\"https://api.github.com/repos/octocat/socm/import/authors\",\"repository_url\":\"https://api.github.com/repos/octocat/socm\"}" + }, + { + "data": "{\"vcs\":\"subversion\",\"use_lfs\":\"undecided\",\"vcs_url\":\"http://svn.mycompany.com/svn/myproject\",\"status\":\"importing\",\"status_text\":\"Importing...\",\"has_large_files\":false,\"large_files_size\":0,\"large_files_count\":0,\"authors_count\":0,\"percent\":42,\"commit_count\":1042,\"url\":\"https://api.github.com/repos/octocat/socm/import\",\"html_url\":\"https://import.github.com/octocat/socm/import\",\"authors_url\":\"https://api.github.com/repos/octocat/socm/import/authors\",\"repository_url\":\"https://api.github.com/repos/octocat/socm\"}" } ] } ], "renamed": null - }, - { - "name": "Delete a milestone", - "scope": "issues", - "id": "deleteMilestone", + }, + { + "name": "Cancel an import", + "scope": "migrations", + "id": "cancelImport", "method": "DELETE", - "url": "/repos/{owner}/{repo}/milestones/{milestone_number}", + "url": "/repos/{owner}/{repo}/import", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/issues/milestones/#delete-a-milestone", + "description": "Stop an import for a repository.", + "documentationUrl": "https://developer.github.com/v3/migrations/source_imports/#cancel-an-import", "previews": [], "headers": [], "parameters": [ @@ -30533,47 +23285,21 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "milestone_number", - "description": "milestone_number parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "number", - "description": null, - "in": null, - "type": null, - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": "milestone_number", - "deprecated": true } ], "responses": [], "renamed": null }, { - "name": "Get labels for every issue in a milestone", - "scope": "issues", - "id": "listLabelsForMilestone", + "name": "Get commit authors", + "scope": "migrations", + "id": "getCommitAuthors", "method": "GET", - "url": "/repos/{owner}/{repo}/milestones/{milestone_number}/labels", + "url": "/repos/{owner}/{repo}/import/authors", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/issues/labels/#get-labels-for-every-issue-in-a-milestone", + "description": "Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `.\n\nThis API method and the \"Map a commit author\" method allow you to provide correct Git author information.", + "documentationUrl": "https://developer.github.com/v3/migrations/source_imports/#get-commit-authors", "previews": [], "headers": [], "parameters": [ @@ -30604,36 +23330,10 @@ "deprecated": null }, { - "name": "milestone_number", - "description": "milestone_number parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", + "name": "since", + "description": "Only authors found after this id are returned. Provide the highest author ID you've seen so far. New authors may be added to the list at any point while the importer is performing the `raw` step.", "in": "QUERY", - "type": "integer", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -30641,19 +23341,6 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "number", - "description": null, - "in": null, - "type": null, - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": "milestone_number", - "deprecated": true } ], "responses": [ @@ -30662,7 +23349,7 @@ "description": "response", "examples": [ { - "data": "[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true},{\"id\":208045947,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDc=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/enhancement\",\"name\":\"enhancement\",\"description\":\"New feature or request\",\"color\":\"a2eeef\",\"default\":false}]" + "data": "[{\"id\":2268557,\"remote_id\":\"nobody@fc7da526-431c-80fe-3c8c-c148ff18d7ef\",\"remote_name\":\"nobody\",\"email\":\"hubot@github.com\",\"name\":\"Hubot\",\"url\":\"https://api.github.com/repos/octocat/socm/import/authors/2268557\",\"import_url\":\"https://api.github.com/repos/octocat/socm/import\"},{\"id\":2268558,\"remote_id\":\"svner@fc7da526-431c-80fe-3c8c-c148ff18d7ef\",\"remote_name\":\"svner\",\"email\":\"svner@fc7da526-431c-80fe-3c8c-c148ff18d7ef\",\"name\":\"svner\",\"url\":\"https://api.github.com/repos/octocat/socm/import/authors/2268558\",\"import_url\":\"https://api.github.com/repos/octocat/socm/import\"},{\"id\":2268559,\"remote_id\":\"svner@example.com@fc7da526-431c-80fe-3c8c-c148ff18d7ef\",\"remote_name\":\"svner@example.com\",\"email\":\"svner@example.com@fc7da526-431c-80fe-3c8c-c148ff18d7ef\",\"name\":\"svner@example.com\",\"url\":\"https://api.github.com/repos/octocat/socm/import/authors/2268559\",\"import_url\":\"https://api.github.com/repos/octocat/socm/import\"}]" } ] } @@ -30670,15 +23357,15 @@ "renamed": null }, { - "name": "List your notifications in a repository", - "scope": "activity", - "id": "listNotificationsForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/notifications", + "name": "Map a commit author", + "scope": "migrations", + "id": "mapCommitAuthor", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/import/authors/{author_id}", "isDeprecated": false, "isLegacy": false, - "description": "List all notifications for the current user.", - "documentationUrl": "https://developer.github.com/v3/activity/notifications/#list-your-notifications-in-a-repository", + "description": "Update an author's identity for the import. Your application can continue updating authors any time before you push new commits to the repository.", + "documentationUrl": "https://developer.github.com/v3/migrations/source_imports/#map-a-commit-author", "previews": [], "headers": [], "parameters": [ @@ -30709,24 +23396,11 @@ "deprecated": null }, { - "name": "all", - "description": "If `true`, show notifications marked as read.", - "in": "QUERY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "participating", - "description": "If `true`, only shows notifications in which the user is directly participating or mentioned.", - "in": "QUERY", - "type": "boolean", - "required": false, + "name": "author_id", + "description": "author_id parameter", + "in": "PATH", + "type": "integer", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -30735,9 +23409,9 @@ "deprecated": null }, { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", + "name": "email", + "description": "The new Git author email.", + "in": "BODY", "type": "string", "required": false, "enum": null, @@ -30748,9 +23422,9 @@ "deprecated": null }, { - "name": "before", - "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "QUERY", + "name": "name", + "description": "The new Git author name.", + "in": "BODY", "type": "string", "required": false, "enum": null, @@ -30759,32 +23433,6 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null } ], "responses": [ @@ -30793,7 +23441,7 @@ "description": "response", "examples": [ { - "data": "[{\"id\":\"1\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\"},\"subject\":{\"title\":\"Greetings\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/123\",\"latest_comment_url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/comments/123\",\"type\":\"Issue\"},\"reason\":\"subscribed\",\"unread\":true,\"updated_at\":\"2014-11-07T22:01:45Z\",\"last_read_at\":\"2014-11-07T22:01:45Z\",\"url\":\"https://api.github.com/notifications/threads/1\"}]" + "data": "{\"id\":2268557,\"remote_id\":\"nobody@fc7da526-431c-80fe-3c8c-c148ff18d7ef\",\"remote_name\":\"nobody\",\"email\":\"hubot@github.com\",\"name\":\"Hubot\",\"url\":\"https://api.github.com/repos/octocat/socm/import/authors/2268557\",\"import_url\":\"https://api.github.com/repos/octocat/socm/import\"}" } ] } @@ -30801,15 +23449,15 @@ "renamed": null }, { - "name": "Mark notifications as read in a repository", - "scope": "activity", - "id": "markNotificationsAsReadForRepo", - "method": "PUT", - "url": "/repos/{owner}/{repo}/notifications", + "name": "Get large files", + "scope": "migrations", + "id": "getLargeFiles", + "method": "GET", + "url": "/repos/{owner}/{repo}/import/large_files", "isDeprecated": false, "isLegacy": false, - "description": "Marks all notifications in a repository as \"read\" removes them from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List your notifications in a repository](https://developer.github.com/v3/activity/notifications/#list-your-notifications-in-a-repository) endpoint and pass the query parameter `all=false`.", - "documentationUrl": "https://developer.github.com/v3/activity/notifications/#mark-notifications-as-read-in-a-repository", + "description": "List files larger than 100MB found during the import", + "documentationUrl": "https://developer.github.com/v3/migrations/source_imports/#get-large-files", "previews": [], "headers": [], "parameters": [ @@ -30838,34 +23486,31 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "last_read_at", - "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null + "code": 200, + "description": "response", + "examples": [ + { + "data": "[{\"ref_name\":\"refs/heads/master\",\"path\":\"foo/bar/1\",\"oid\":\"d3d9446802a44259755d38e6d163e820\",\"size\":10485760},{\"ref_name\":\"refs/heads/master\",\"path\":\"foo/bar/2\",\"oid\":\"6512bd43d9caa6e02c990b0a82652dca\",\"size\":11534336},{\"ref_name\":\"refs/heads/master\",\"path\":\"foo/bar/3\",\"oid\":\"c20ad4d76fe97759aa27a0c99bff6710\",\"size\":12582912}]" + } + ] } ], - "responses": [], "renamed": null }, { - "name": "Get information about a Pages site", - "scope": "repos", - "id": "getPages", - "method": "GET", - "url": "/repos/{owner}/{repo}/pages", + "name": "Set Git LFS preference", + "scope": "migrations", + "id": "setLfsPreference", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/import/lfs", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/repos/pages/#get-information-about-a-pages-site", + "description": "You can import repositories from Subversion, Mercurial, and TFS that include files larger than 100MB. This ability is powered by [Git LFS](https://git-lfs.github.com). You can learn more about our LFS feature and working with large files [on our help site](https://help.github.com/articles/versioning-large-files/).", + "documentationUrl": "https://developer.github.com/v3/migrations/source_imports/#set-git-lfs-preference", "previews": [], "headers": [], "parameters": [ @@ -30894,6 +23539,19 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "use_lfs", + "description": "Can be one of `opt_in` (large files will be stored using Git LFS) or `opt_out` (large files will be removed during the import).", + "in": "BODY", + "type": "string", + "required": true, + "enum": ["opt_in", "opt_out"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ @@ -30902,7 +23560,7 @@ "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/github/developer.github.com/pages\",\"status\":\"built\",\"cname\":\"developer.github.com\",\"custom_404\":false,\"html_url\":\"https://developer.github.com\",\"source\":{\"branch\":\"master\",\"directory\":\"/\"}}" + "data": "{\"vcs\":\"subversion\",\"use_lfs\":\"opt_in\",\"vcs_url\":\"http://svn.mycompany.com/svn/myproject\",\"status\":\"complete\",\"status_text\":\"Done\",\"has_large_files\":true,\"large_files_size\":132331036,\"large_files_count\":1,\"authors_count\":4,\"url\":\"https://api.github.com/repos/octocat/socm/import\",\"html_url\":\"https://import.github.com/octocat/socm/import\",\"authors_url\":\"https://api.github.com/repos/octocat/socm/import/authors\",\"repository_url\":\"https://api.github.com/repos/octocat/socm\"}" } ] } @@ -30910,20 +23568,21 @@ "renamed": null }, { - "name": "Enable a Pages site", - "scope": "repos", - "id": "enablePagesSite", - "method": "POST", - "url": "/repos/{owner}/{repo}/pages", + "name": "Get a repository installation", + "scope": "apps", + "id": "getRepoInstallation", + "method": "GET", + "url": "/repos/{owner}/{repo}/installation", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/repos/pages/#enable-a-pages-site", - "previews": [{ "name": "switcheroo" }], + "description": "Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to.\n\nYou must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "documentationUrl": "https://developer.github.com/v3/apps/#get-a-repository-installation", + "previews": [{ "name": "machine-man" }], "headers": [ { "name": "accept", - "value": "application/vnd.github.switcheroo-preview+json" + "value": "application/vnd.github.machine-man-preview+json", + "required": true } ], "parameters": [ @@ -30952,54 +23611,15 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "source", - "description": "source parameter", - "in": "BODY", - "type": "object", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "source.branch", - "description": "The repository branch used to publish your [site's source files](https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/). Can be either `master` or `gh-pages`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["master", "gh-pages"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "source.path", - "description": "The repository directory that includes the source files for the Pages site. When `branch` is `master`, you can change `path` to `/docs`. When `branch` is `gh-pages`, you are unable to specify a `path` other than `/`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null } ], "responses": [ { - "code": 201, + "code": 200, "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/github/developer.github.com/pages\",\"status\":\"built\",\"cname\":\"developer.github.com\",\"custom_404\":false,\"html_url\":\"https://developer.github.com\",\"source\":{\"branch\":\"master\",\"directory\":\"/\"}}" + "data": "{\"id\":1,\"account\":{\"login\":\"github\",\"id\":1,\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/orgs/github\",\"html_url\":\"https://github.com/github\",\"followers_url\":\"https://api.github.com/users/github/followers\",\"following_url\":\"https://api.github.com/users/github/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/github/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/github/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/github/subscriptions\",\"organizations_url\":\"https://api.github.com/users/github/orgs\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"received_events_url\":\"https://api.github.com/users/github/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"repository_selection\":\"all\",\"access_tokens_url\":\"https://api.github.com/installations/1/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/1\",\"app_id\":1,\"target_id\":1,\"target_type\":\"Organization\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"push\",\"pull_request\"],\"created_at\":\"2018-02-09T20:51:14Z\",\"updated_at\":\"2018-02-09T20:51:14Z\",\"single_file_name\":null}" } ] } @@ -31007,20 +23627,21 @@ "renamed": null }, { - "name": "Disable a Pages site", - "scope": "repos", - "id": "disablePagesSite", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/pages", + "name": "Get interaction restrictions for a repository", + "scope": "interactions", + "id": "getRestrictionsForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/interaction-limits", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/repos/pages/#disable-a-pages-site", - "previews": [{ "name": "switcheroo" }], + "description": "Shows which group of GitHub users can interact with this repository and when the restriction expires. If there are no restrictions, you will see an empty response.", + "documentationUrl": "https://developer.github.com/v3/interactions/repos/#get-interaction-restrictions-for-a-repository", + "previews": [{ "name": "sombra" }], "headers": [ { "name": "accept", - "value": "application/vnd.github.switcheroo-preview+json" + "value": "application/vnd.github.sombra-preview+json", + "required": true } ], "parameters": [ @@ -31051,21 +23672,37 @@ "deprecated": null } ], - "responses": [], + "responses": [ + { + "code": 200, + "description": "response", + "examples": [ + { + "data": "{\"limit\":\"collaborators_only\",\"origin\":\"repository\",\"expires_at\":\"2018-08-17T04:18:39Z\"}" + } + ] + } + ], "renamed": null }, { - "name": "Update information about a Pages site", - "scope": "repos", - "id": "updateInformationAboutPagesSite", + "name": "Add or update interaction restrictions for a repository", + "scope": "interactions", + "id": "addOrUpdateRestrictionsForRepo", "method": "PUT", - "url": "/repos/{owner}/{repo}/pages", + "url": "/repos/{owner}/{repo}/interaction-limits", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/repos/pages/#update-information-about-a-pages-site", - "previews": [], - "headers": [], + "description": "Temporarily restricts interactions to certain GitHub users within the given repository. You must have owner or admin access to set restrictions.", + "documentationUrl": "https://developer.github.com/v3/interactions/repos/#add-or-update-interaction-restrictions-for-a-repository", + "previews": [{ "name": "sombra" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.sombra-preview+json", + "required": true + } + ], "parameters": [ { "name": "owner", @@ -31094,47 +23731,50 @@ "deprecated": null }, { - "name": "cname", - "description": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://help.github.com/articles/using-a-custom-domain-with-github-pages/).\"", + "name": "limit", + "description": "Specifies the group of GitHub users who can comment, open issues, or create pull requests for the given repository. Must be one of: `existing_users`, `contributors_only`, or `collaborators_only`.", "in": "BODY", "type": "string", - "required": false, - "enum": null, + "required": true, + "enum": ["existing_users", "contributors_only", "collaborators_only"], "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "source", - "description": "Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory `/docs`. Possible values are `\"gh-pages\"`, `\"master\"`, and `\"master /docs\"`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["\"gh-pages\"", "\"master\"", "\"master /docs\""], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null + "code": 200, + "description": "response", + "examples": [ + { + "data": "{\"limit\":\"collaborators_only\",\"origin\":\"repository\",\"expires_at\":\"2018-08-17T04:18:39Z\"}" + } + ] } ], - "responses": [], "renamed": null }, { - "name": "Request a page build", - "scope": "repos", - "id": "requestPageBuild", - "method": "POST", - "url": "/repos/{owner}/{repo}/pages/builds", + "name": "Remove interaction restrictions for a repository", + "scope": "interactions", + "id": "removeRestrictionsForRepo", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/interaction-limits", "isDeprecated": false, "isLegacy": false, - "description": "You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.\n\nBuild requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.", - "documentationUrl": "https://developer.github.com/v3/repos/pages/#request-a-page-build", - "previews": [], - "headers": [], + "description": "Removes all interaction restrictions from the given repository. You must have owner or admin access to remove restrictions.", + "documentationUrl": "https://developer.github.com/v3/interactions/repos/#remove-interaction-restrictions-for-a-repository", + "previews": [{ "name": "sombra" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.sombra-preview+json", + "required": true + } + ], "parameters": [ { "name": "owner", @@ -31163,29 +23803,19 @@ "deprecated": null } ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/github/developer.github.com/pages/builds/latest\",\"status\":\"queued\"}" - } - ] - } - ], + "responses": [], "renamed": null }, { - "name": "List Pages builds", + "name": "List invitations for a repository", "scope": "repos", - "id": "listPagesBuilds", + "id": "listInvitations", "method": "GET", - "url": "/repos/{owner}/{repo}/pages/builds", + "url": "/repos/{owner}/{repo}/invitations", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/repos/pages/#list-pages-builds", + "description": "When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.\n\n", + "documentationUrl": "https://developer.github.com/v3/repos/invitations/#list-invitations-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -31248,60 +23878,7 @@ "description": "response", "examples": [ { - "data": "[{\"url\":\"https://api.github.com/repos/github/developer.github.com/pages/builds/5472601\",\"status\":\"built\",\"error\":{\"message\":null},\"pusher\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"commit\":\"351391cdcb88ffae71ec3028c91f375a8036a26b\",\"duration\":2104,\"created_at\":\"2014-02-10T19:00:49Z\",\"updated_at\":\"2014-02-10T19:00:51Z\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get latest Pages build", - "scope": "repos", - "id": "getLatestPagesBuild", - "method": "GET", - "url": "/repos/{owner}/{repo}/pages/builds/latest", - "isDeprecated": false, - "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/repos/pages/#get-latest-pages-build", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "owner parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "repo parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/github/developer.github.com/pages/builds/5472601\",\"status\":\"built\",\"error\":{\"message\":null},\"pusher\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"commit\":\"351391cdcb88ffae71ec3028c91f375a8036a26b\",\"duration\":2104,\"created_at\":\"2014-02-10T19:00:49Z\",\"updated_at\":\"2014-02-10T19:00:51Z\"}" + "data": "[{\"id\":1,\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\"},\"invitee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"inviter\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"permissions\":\"write\",\"created_at\":\"2016-06-13T14:52:50-05:00\",\"url\":\"https://api.github.com/user/repository_invitations/1296269\",\"html_url\":\"https://github.com/octocat/Hello-World/invitations\"}]" } ] } @@ -31309,15 +23886,15 @@ "renamed": null }, { - "name": "Get a specific Pages build", + "name": "Delete a repository invitation", "scope": "repos", - "id": "getPagesBuild", - "method": "GET", - "url": "/repos/{owner}/{repo}/pages/builds/{build_id}", + "id": "deleteInvitation", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/invitations/{invitation_id}", "isDeprecated": false, "isLegacy": false, "description": "", - "documentationUrl": "https://developer.github.com/v3/repos/pages/#get-a-specific-pages-build", + "documentationUrl": "https://developer.github.com/v3/repos/invitations/#delete-a-repository-invitation", "previews": [], "headers": [], "parameters": [ @@ -31348,8 +23925,8 @@ "deprecated": null }, { - "name": "build_id", - "description": "build_id parameter", + "name": "invitation_id", + "description": "invitation_id parameter", "in": "PATH", "type": "integer", "required": true, @@ -31361,36 +23938,21 @@ "deprecated": null } ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/github/developer.github.com/pages/builds/5472601\",\"status\":\"built\",\"error\":{\"message\":null},\"pusher\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"commit\":\"351391cdcb88ffae71ec3028c91f375a8036a26b\",\"duration\":2104,\"created_at\":\"2014-02-10T19:00:49Z\",\"updated_at\":\"2014-02-10T19:00:51Z\"}" - } - ] - } - ], + "responses": [], "renamed": null }, { - "name": "List repository projects", - "scope": "projects", - "id": "listForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/projects", + "name": "Update a repository invitation", + "scope": "repos", + "id": "updateInvitation", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/invitations/{invitation_id}", "isDeprecated": false, "isLegacy": false, - "description": "Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", - "documentationUrl": "https://developer.github.com/v3/projects/#list-repository-projects", - "previews": [{ "name": "inertia" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.inertia-preview+json" - } - ], + "description": "", + "documentationUrl": "https://developer.github.com/v3/repos/invitations/#update-a-repository-invitation", + "previews": [], + "headers": [], "parameters": [ { "name": "owner", @@ -31419,24 +23981,11 @@ "deprecated": null }, { - "name": "state", - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["open", "closed", "all"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", + "name": "invitation_id", + "description": "invitation_id parameter", + "in": "PATH", "type": "integer", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -31445,12 +23994,12 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", + "name": "permissions", + "description": "The permissions that the associated user will have on the repository. Valid values are `read`, `write`, and `admin`.", + "in": "BODY", + "type": "string", "required": false, - "enum": null, + "enum": ["read", "write", "admin"], "allowNull": false, "mapToData": null, "validation": null, @@ -31464,7 +24013,7 @@ "description": "response", "examples": [ { - "data": "[{\"owner_url\":\"https://api.github.com/repos/api-playground/projects-test\",\"url\":\"https://api.github.com/projects/1002604\",\"html_url\":\"https://github.com/api-playground/projects-test/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002604/columns\",\"id\":1002604,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDQ=\",\"name\":\"Projects Documentation\",\"body\":\"Developer documentation project for the developer site.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\"}]" + "data": "{\"id\":1,\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\"},\"invitee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"inviter\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"permissions\":\"write\",\"created_at\":\"2016-06-13T14:52:50-05:00\",\"url\":\"https://api.github.com/user/repository_invitations/1296269\",\"html_url\":\"https://github.com/octocat/Hello-World/invitations\"}" } ] } @@ -31472,22 +24021,17 @@ "renamed": null }, { - "name": "Create a repository project", - "scope": "projects", - "id": "createForRepo", - "method": "POST", - "url": "/repos/{owner}/{repo}/projects", + "name": "List issues for a repository", + "scope": "issues", + "id": "listForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues", "isDeprecated": false, "isLegacy": false, - "description": "Creates a repository project board. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", - "documentationUrl": "https://developer.github.com/v3/projects/#create-a-repository-project", - "previews": [{ "name": "inertia" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.inertia-preview+json" - } - ], + "description": "**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key.\n\nBe aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests)\" endpoint.\n\n", + "documentationUrl": "https://developer.github.com/v3/issues/#list-issues-for-a-repository", + "previews": [], + "headers": [], "parameters": [ { "name": "owner", @@ -31516,11 +24060,11 @@ "deprecated": null }, { - "name": "name", - "description": "The name of the project.", - "in": "BODY", + "name": "milestone", + "description": "If an `integer` is passed, it should refer to a milestone by its `number` field. If the string `*` is passed, issues with any milestone are accepted. If the string `none` is passed, issues without milestones are returned.", + "in": "QUERY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -31529,51 +24073,24 @@ "deprecated": null }, { - "name": "body", - "description": "The description of the project.", - "in": "BODY", + "name": "state", + "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "in": "QUERY", "type": "string", "required": false, - "enum": null, + "enum": ["open", "closed", "all"], "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "response", - "examples": [ - { - "data": "{\"owner_url\":\"https://api.github.com/repos/api-playground/projects-test\",\"url\":\"https://api.github.com/projects/1002604\",\"html_url\":\"https://github.com/api-playground/projects-test/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002604/columns\",\"id\":1002604,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDQ=\",\"name\":\"Projects Documentation\",\"body\":\"Developer documentation project for the developer site.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\"}" - } - ] - } - ], - "renamed": null - }, - { - "name": "List pull requests", - "scope": "pulls", - "id": "list", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls", - "isDeprecated": false, - "isLegacy": false, - "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Pro, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", - "documentationUrl": "https://developer.github.com/v3/pulls/#list-pull-requests", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "owner", - "description": "owner parameter", - "in": "PATH", + "name": "assignee", + "description": "Can be the name of a user. Pass in `none` for issues with no assigned user, and `*` for issues assigned to any user.", + "in": "QUERY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -31582,11 +24099,11 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "creator", + "description": "The user that created the issue.", + "in": "QUERY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -31595,12 +24112,12 @@ "deprecated": null }, { - "name": "state", - "description": "Either `open`, `closed`, or `all` to filter by state.", + "name": "mentioned", + "description": "A user that's mentioned in the issue.", "in": "QUERY", "type": "string", "required": false, - "enum": ["open", "closed", "all"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -31608,8 +24125,8 @@ "deprecated": null }, { - "name": "head", - "description": "Filter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `octocat:test-branch`.", + "name": "labels", + "description": "A list of comma separated label names. Example: `bug,ui,@high`", "in": "QUERY", "type": "string", "required": false, @@ -31621,12 +24138,12 @@ "deprecated": null }, { - "name": "base", - "description": "Filter pulls by base branch name. Example: `gh-pages`.", + "name": "sort", + "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", "in": "QUERY", "type": "string", "required": false, - "enum": null, + "enum": ["created", "updated", "comments"], "allowNull": false, "mapToData": null, "validation": null, @@ -31634,12 +24151,12 @@ "deprecated": null }, { - "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month).", + "name": "direction", + "description": "The direction of the sort. Can be either `asc` or `desc`.", "in": "QUERY", "type": "string", "required": false, - "enum": ["created", "updated", "popularity", "long-running"], + "enum": ["asc", "desc"], "allowNull": false, "mapToData": null, "validation": null, @@ -31647,12 +24164,12 @@ "deprecated": null }, { - "name": "direction", - "description": "The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.", + "name": "since", + "description": "Only issues updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "QUERY", "type": "string", "required": false, - "enum": ["asc", "desc"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -31692,7 +24209,7 @@ "description": "response", "examples": [ { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"draft\":false}]" + "data": "[{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\"}]" } ] } @@ -31700,15 +24217,15 @@ "renamed": null }, { - "name": "Create a pull request", - "scope": "pulls", + "name": "Create an issue", + "scope": "issues", "id": "create", "method": "POST", - "url": "/repos/{owner}/{repo}/pulls", + "url": "/repos/{owner}/{repo}/issues", "isDeprecated": false, "isLegacy": false, - "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Pro, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nYou can create a new pull request.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.", - "documentationUrl": "https://developer.github.com/v3/pulls/#create-a-pull-request", + "description": "Any user with pull access to a repository can create an issue. If [issues are disabled in the repository](https://help.github.com/articles/disabling-issues/), the API returns a `410 Gone` status.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.", + "documentationUrl": "https://developer.github.com/v3/issues/#create-an-issue", "previews": [], "headers": [], "parameters": [ @@ -31740,7 +24257,7 @@ }, { "name": "title", - "description": "The title of the new pull request.", + "description": "The title of the issue.", "in": "BODY", "type": "string", "required": true, @@ -31752,11 +24269,11 @@ "deprecated": null }, { - "name": "head", - "description": "The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`.", + "name": "body", + "description": "The contents of the issue.", "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -31765,11 +24282,11 @@ "deprecated": null }, { - "name": "base", - "description": "The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.", + "name": "assignee", + "description": "Login for the user that this issue should be assigned to. _NOTE: Only users with push access can set the assignee for new issues. The assignee is silently dropped otherwise. **This field is deprecated.**_", "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -31778,10 +24295,10 @@ "deprecated": null }, { - "name": "body", - "description": "The contents of the pull request.", + "name": "milestone", + "description": "The `number` of the milestone to associate this issue with. _NOTE: Only users with push access can set the milestone for new issues. The milestone is silently dropped otherwise._", "in": "BODY", - "type": "string", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -31791,10 +24308,10 @@ "deprecated": null }, { - "name": "maintainer_can_modify", - "description": "Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", + "name": "labels", + "description": "Labels to associate with this issue. _NOTE: Only users with push access can set labels for new issues. Labels are silently dropped otherwise._", "in": "BODY", - "type": "boolean", + "type": "string[]", "required": false, "enum": null, "allowNull": false, @@ -31804,10 +24321,10 @@ "deprecated": null }, { - "name": "draft", - "description": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://help.github.com/en/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more.", + "name": "assignees", + "description": "Logins for Users to assign to this issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", "in": "BODY", - "type": "boolean", + "type": "string[]", "required": false, "enum": null, "allowNull": false, @@ -31823,7 +24340,7 @@ "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"draft\":false,\"merged\":false,\"mergeable\":true,\"rebaseable\":true,\"mergeable_state\":\"clean\",\"merged_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"comments\":10,\"review_comments\":0,\"maintainer_can_modify\":true,\"commits\":3,\"additions\":100,\"deletions\":3,\"changed_files\":5}" + "data": "{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"closed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" } ] } @@ -31832,14 +24349,14 @@ }, { "name": "List comments in a repository", - "scope": "pulls", + "scope": "issues", "id": "listCommentsForRepo", "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/comments", + "url": "/repos/{owner}/{repo}/issues/comments", "isDeprecated": false, "isLegacy": false, - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://developer.github.com/v3/pulls/comments/#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://developer.github.com/v3/reactions) reactions.\n\n", - "documentationUrl": "https://developer.github.com/v3/pulls/comments/#list-comments-in-a-repository", + "description": "By default, Issue Comments are ordered by ascending ID.\n\n", + "documentationUrl": "https://developer.github.com/v3/issues/comments/#list-comments-in-a-repository", "previews": [], "headers": [], "parameters": [ @@ -31871,7 +24388,7 @@ }, { "name": "sort", - "description": "Can be either `created` or `updated` comments.", + "description": "Either `created` or `updated`.", "in": "QUERY", "type": "string", "required": false, @@ -31884,7 +24401,7 @@ }, { "name": "direction", - "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.", + "description": "Either `asc` or `desc`. Ignored without the `sort` parameter.", "in": "QUERY", "type": "string", "required": false, @@ -31897,7 +24414,7 @@ }, { "name": "since", - "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only returns comments `updated` at or after this time.", + "description": "Only comments updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "QUERY", "type": "string", "required": false, @@ -31907,32 +24424,6 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null } ], "responses": [ @@ -31941,7 +24432,7 @@ "description": "response", "examples": [ { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\"id\":10,\"node_id\":\"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\"pull_request_review_id\":42,\"diff_hunk\":\"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\"path\":\"file1.txt\",\"position\":1,\"original_position\":4,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"original_commit_id\":\"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\"in_reply_to_id\":8,\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Great stuff!\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"author_association\":\"NONE\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\"}},\"start_line\":1,\"original_start_line\":1,\"start_side\":\"RIGHT\",\"line\":2,\"original_line\":2,\"side\":\"RIGHT\"}]" + "data": "[{\"id\":1,\"node_id\":\"MDEyOklzc3VlQ29tbWVudDE=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments/1\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347#issuecomment-1\",\"body\":\"Me too\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}]" } ] } @@ -31950,14 +24441,14 @@ }, { "name": "Get a single comment", - "scope": "pulls", + "scope": "issues", "id": "getComment", "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", + "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}", "isDeprecated": false, "isLegacy": false, - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nProvides details for a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://developer.github.com/v3/pulls/comments/#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://developer.github.com/v3/reactions) reactions.\n\n", - "documentationUrl": "https://developer.github.com/v3/pulls/comments/#get-a-single-comment", + "description": "", + "documentationUrl": "https://developer.github.com/v3/issues/comments/#get-a-single-comment", "previews": [], "headers": [], "parameters": [ @@ -32007,7 +24498,7 @@ "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\"id\":10,\"node_id\":\"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\"pull_request_review_id\":42,\"diff_hunk\":\"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\"path\":\"file1.txt\",\"position\":1,\"original_position\":4,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"original_commit_id\":\"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\"in_reply_to_id\":8,\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Great stuff!\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"author_association\":\"NONE\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\"}},\"start_line\":1,\"original_start_line\":1,\"start_side\":\"RIGHT\",\"line\":2,\"original_line\":2,\"side\":\"RIGHT\"}" + "data": "{\"id\":1,\"node_id\":\"MDEyOklzc3VlQ29tbWVudDE=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments/1\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347#issuecomment-1\",\"body\":\"Me too\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}" } ] } @@ -32016,14 +24507,14 @@ }, { "name": "Edit a comment", - "scope": "pulls", + "scope": "issues", "id": "updateComment", "method": "PATCH", - "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", + "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}", "isDeprecated": false, "isLegacy": false, - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nEnables you to edit a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://developer.github.com/v3/pulls/comments/#parameters-2) table.", - "documentationUrl": "https://developer.github.com/v3/pulls/comments/#edit-a-comment", + "description": "", + "documentationUrl": "https://developer.github.com/v3/issues/comments/#edit-a-comment", "previews": [], "headers": [], "parameters": [ @@ -32068,7 +24559,7 @@ }, { "name": "body", - "description": "The text of the reply to the review comment.", + "description": "The contents of the comment.", "in": "BODY", "type": "string", "required": true, @@ -32086,7 +24577,7 @@ "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\"id\":10,\"node_id\":\"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\"pull_request_review_id\":42,\"diff_hunk\":\"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\"path\":\"file1.txt\",\"position\":1,\"original_position\":4,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"original_commit_id\":\"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\"in_reply_to_id\":8,\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Great stuff!\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"author_association\":\"NONE\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\"}},\"start_line\":1,\"original_start_line\":1,\"start_side\":\"RIGHT\",\"line\":2,\"original_line\":2,\"side\":\"RIGHT\"}" + "data": "{\"id\":1,\"node_id\":\"MDEyOklzc3VlQ29tbWVudDE=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments/1\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347#issuecomment-1\",\"body\":\"Me too\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}" } ] } @@ -32095,14 +24586,14 @@ }, { "name": "Delete a comment", - "scope": "pulls", + "scope": "issues", "id": "deleteComment", "method": "DELETE", - "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", + "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}", "isDeprecated": false, "isLegacy": false, - "description": "Deletes a review comment.", - "documentationUrl": "https://developer.github.com/v3/pulls/comments/#delete-a-comment", + "description": "", + "documentationUrl": "https://developer.github.com/v3/issues/comments/#delete-a-comment", "previews": [], "headers": [], "parameters": [ @@ -32150,20 +24641,21 @@ "renamed": null }, { - "name": "List reactions for a pull request review comment", + "name": "List reactions for an issue comment", "scope": "reactions", - "id": "listForPullRequestReviewComment", + "id": "listForIssueComment", "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", + "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", "isDeprecated": false, "isLegacy": false, - "description": "List the reactions to a [pull request review comment](https://developer.github.com/v3/pulls/comments/).", - "documentationUrl": "https://developer.github.com/v3/reactions/#list-reactions-for-a-pull-request-review-comment", + "description": "List the reactions to an [issue comment](https://developer.github.com/v3/issues/comments/).", + "documentationUrl": "https://developer.github.com/v3/reactions/#list-reactions-for-an-issue-comment", "previews": [{ "name": "squirrel-girl" }], "headers": [ { "name": "accept", - "value": "application/vnd.github.squirrel-girl-preview+json" + "value": "application/vnd.github.squirrel-girl-preview+json", + "required": true } ], "parameters": [ @@ -32208,7 +24700,7 @@ }, { "name": "content", - "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a pull request review comment.", + "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue comment.", "in": "QUERY", "type": "string", "required": false, @@ -32269,20 +24761,21 @@ "renamed": null }, { - "name": "Create reaction for a pull request review comment", + "name": "Create reaction for an issue comment", "scope": "reactions", - "id": "createForPullRequestReviewComment", + "id": "createForIssueComment", "method": "POST", - "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", + "url": "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", "isDeprecated": false, "isLegacy": false, - "description": "Create a reaction to a [pull request review comment](https://developer.github.com/v3/pulls/comments/). A response with a `Status: 200 OK` means that you already added the reaction type to this pull request review comment.", - "documentationUrl": "https://developer.github.com/v3/reactions/#create-reaction-for-a-pull-request-review-comment", + "description": "Create a reaction to an [issue comment](https://developer.github.com/v3/issues/comments/). A response with a `Status: 200 OK` means that you already added the reaction type to this issue comment.", + "documentationUrl": "https://developer.github.com/v3/reactions/#create-reaction-for-an-issue-comment", "previews": [{ "name": "squirrel-girl" }], "headers": [ { "name": "accept", - "value": "application/vnd.github.squirrel-girl-preview+json" + "value": "application/vnd.github.squirrel-girl-preview+json", + "required": true } ], "parameters": [ @@ -32327,7 +24820,7 @@ }, { "name": "content", - "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the pull request review comment.", + "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the issue comment.", "in": "BODY", "type": "string", "required": true, @@ -32362,15 +24855,15 @@ "renamed": null }, { - "name": "Get a single pull request", - "scope": "pulls", - "id": "get", + "name": "List events for a repository", + "scope": "issues", + "id": "listEventsForRepo", "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}", + "url": "/repos/{owner}/{repo}/issues/events", "isDeprecated": false, "isLegacy": false, - "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Pro, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists details of a pull request by providing its number.\n\nWhen you get, [create](https://developer.github.com/v3/pulls/#create-a-pull-request), or [edit](https://developer.github.com/v3/pulls/#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see \"[Checking mergeability of pull requests](https://developer.github.com/v3/git/#checking-mergeability-of-pull-requests)\".\n\nThe value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.\n\nThe value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:\n\n* If merged as a [merge commit](https://help.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.\n* If merged via a [squash](https://help.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.\n* If [rebased](https://help.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.\n\nPass the appropriate [media type](https://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.", - "documentationUrl": "https://developer.github.com/v3/pulls/#get-a-single-pull-request", + "description": "", + "documentationUrl": "https://developer.github.com/v3/issues/events/#list-events-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -32401,11 +24894,11 @@ "deprecated": null }, { - "name": "pull_number", - "description": "pull_number parameter", - "in": "PATH", + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", "type": "integer", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -32414,26 +24907,26 @@ "deprecated": null }, { - "name": "number", - "description": null, - "in": null, - "type": null, - "required": null, + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, - "allowNull": null, + "allowNull": false, "mapToData": null, "validation": null, - "alias": "pull_number", - "deprecated": true + "alias": null, + "deprecated": null } ], "responses": [ { "code": 200, - "description": "Pass the appropriate [media type](https://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.", + "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"draft\":false,\"merged\":false,\"mergeable\":true,\"rebaseable\":true,\"mergeable_state\":\"clean\",\"merged_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"comments\":10,\"review_comments\":0,\"maintainer_can_modify\":true,\"commits\":3,\"additions\":100,\"deletions\":3,\"changed_files\":5}" + "data": "[{\"id\":1,\"node_id\":\"MDEwOklzc3VlRXZlbnQx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events/1\",\"actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"event\":\"closed\",\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"commit_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"created_at\":\"2011-04-14T16:00:49Z\",\"issue\":{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\"}}]" } ] } @@ -32441,15 +24934,15 @@ "renamed": null }, { - "name": "Update a pull request", - "scope": "pulls", - "id": "update", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}", + "name": "Get a single event", + "scope": "issues", + "id": "getEvent", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues/events/{event_id}", "isDeprecated": false, "isLegacy": false, - "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Pro, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.", - "documentationUrl": "https://developer.github.com/v3/pulls/#update-a-pull-request", + "description": "", + "documentationUrl": "https://developer.github.com/v3/issues/events/#get-a-single-event", "previews": [], "headers": [], "parameters": [ @@ -32480,8 +24973,8 @@ "deprecated": null }, { - "name": "pull_number", - "description": "pull_number parameter", + "name": "event_id", + "description": "event_id parameter", "in": "PATH", "type": "integer", "required": true, @@ -32491,84 +24984,6 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "title", - "description": "The title of the pull request.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The contents of the pull request.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "State of this Pull Request. Either `open` or `closed`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["open", "closed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "base", - "description": "The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "maintainer_can_modify", - "description": "Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "number", - "description": null, - "in": null, - "type": null, - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": "pull_number", - "deprecated": true } ], "responses": [ @@ -32577,7 +24992,7 @@ "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"draft\":false,\"merged\":false,\"mergeable\":true,\"rebaseable\":true,\"mergeable_state\":\"clean\",\"merged_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"comments\":10,\"review_comments\":0,\"maintainer_can_modify\":true,\"commits\":3,\"additions\":100,\"deletions\":3,\"changed_files\":5}" + "data": "{\"id\":1,\"node_id\":\"MDEwOklzc3VlRXZlbnQx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events/1\",\"actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"event\":\"closed\",\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"commit_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"created_at\":\"2011-04-14T16:00:49Z\",\"issue\":{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\"}}" } ] } @@ -32585,15 +25000,15 @@ "renamed": null }, { - "name": "List comments on a pull request", - "scope": "pulls", - "id": "listComments", + "name": "Get a single issue", + "scope": "issues", + "id": "get", "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", + "url": "/repos/{owner}/{repo}/issues/{issue_number}", "isDeprecated": false, "isLegacy": false, - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists review comments for a pull request. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://developer.github.com/v3/pulls/comments/#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://developer.github.com/v3/reactions) reactions.\n\n", - "documentationUrl": "https://developer.github.com/v3/pulls/comments/#list-comments-on-a-pull-request", + "description": "The API returns a [`301 Moved Permanently` status](https://developer.github.com/v3/#http-redirects) if the issue was [transferred](https://help.github.com/articles/transferring-an-issue-to-another-repository/) to another repository. If the issue was transferred to or deleted from a repository where the authenticated user lacks read access, the API returns a `404 Not Found` status. If the issue was deleted from a repository where the authenticated user has read access, the API returns a `410 Gone` status. To receive webhook events for transferred and deleted issues, subscribe to the [`issues`](https://developer.github.com/v3/activity/events/types/#issuesevent) webhook.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key.\n\nBe aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests)\" endpoint.\n\n", + "documentationUrl": "https://developer.github.com/v3/issues/#get-a-single-issue", "previews": [], "headers": [], "parameters": [ @@ -32624,8 +25039,8 @@ "deprecated": null }, { - "name": "pull_number", - "description": "pull_number parameter", + "name": "issue_number", + "description": "issue_number parameter", "in": "PATH", "type": "integer", "required": true, @@ -32635,84 +25050,6 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "sort", - "description": "Can be either `created` or `updated` comments.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "direction", - "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "since", - "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only returns comments `updated` at or after this time.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "number", - "description": null, - "in": null, - "type": null, - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": "pull_number", - "deprecated": true } ], "responses": [ @@ -32721,7 +25058,7 @@ "description": "response", "examples": [ { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\"id\":10,\"node_id\":\"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\"pull_request_review_id\":42,\"diff_hunk\":\"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\"path\":\"file1.txt\",\"position\":1,\"original_position\":4,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"original_commit_id\":\"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\"in_reply_to_id\":8,\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Great stuff!\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"author_association\":\"NONE\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\"}},\"start_line\":1,\"original_start_line\":1,\"start_side\":\"RIGHT\",\"line\":2,\"original_line\":2,\"side\":\"RIGHT\"}]" + "data": "{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"closed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" } ] } @@ -32729,15 +25066,15 @@ "renamed": null }, { - "name": "Create a comment", - "scope": "pulls", - "id": "createComment", - "method": "POST", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", + "name": "Edit an issue", + "scope": "issues", + "id": "update", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/issues/{issue_number}", "isDeprecated": false, "isLegacy": false, - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Comments](https://developer.github.com/v3/issues/comments/#create-a-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see [Multi-line comment summary](https://developer.github.com/v3/pulls/comments/#multi-line-comment-summary-3).\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://developer.github.com/v3/pulls/comments/#parameters-2) table.", - "documentationUrl": "https://developer.github.com/v3/pulls/comments/#create-a-comment", + "description": "Issue owners and users with push access can edit an issue.", + "documentationUrl": "https://developer.github.com/v3/issues/#edit-an-issue", "previews": [], "headers": [], "parameters": [ @@ -32768,8 +25105,8 @@ "deprecated": null }, { - "name": "pull_number", - "description": "pull_number parameter", + "name": "issue_number", + "description": "issue_number parameter", "in": "PATH", "type": "integer", "required": true, @@ -32781,11 +25118,11 @@ "deprecated": null }, { - "name": "body", - "description": "The text of the review comment.", + "name": "title", + "description": "The title of the issue.", "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -32794,11 +25131,11 @@ "deprecated": null }, { - "name": "commit_id", - "description": "The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`.", + "name": "body", + "description": "The contents of the issue.", "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -32807,23 +25144,10 @@ "deprecated": null }, { - "name": "path", - "description": "The relative path to the file that necessitates a comment.", + "name": "assignee", + "description": "Login for the user that this issue should be assigned to. **This field is deprecated.**", "in": "BODY", "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "position", - "description": "**Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", - "in": "BODY", - "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -32833,12 +25157,12 @@ "deprecated": null }, { - "name": "side", - "description": "**Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", + "name": "state", + "description": "State of the issue. Either `open` or `closed`.", "in": "BODY", "type": "string", "required": false, - "enum": ["LEFT", "RIGHT"], + "enum": ["open", "closed"], "allowNull": false, "mapToData": null, "validation": null, @@ -32846,23 +25170,23 @@ "deprecated": null }, { - "name": "line", - "description": "**Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.", + "name": "milestone", + "description": "The `number` of the milestone to associate this issue with or `null` to remove current. _NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise._", "in": "BODY", "type": "integer", "required": false, "enum": null, - "allowNull": false, + "allowNull": true, "mapToData": null, "validation": null, "alias": null, "deprecated": null }, { - "name": "start_line", - "description": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", + "name": "labels", + "description": "Labels to associate with this issue. Pass one or more Labels to _replace_ the set of Labels on this Issue. Send an empty array (`[]`) to clear all Labels from the Issue. _NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise._", "in": "BODY", - "type": "integer", + "type": "string[]", "required": false, "enum": null, "allowNull": false, @@ -32872,52 +25196,26 @@ "deprecated": null }, { - "name": "start_side", - "description": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", + "name": "assignees", + "description": "Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._", "in": "BODY", - "type": "string", + "type": "string[]", "required": false, - "enum": ["LEFT", "RIGHT", "side"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - }, - { - "name": "number", - "description": null, - "in": null, - "type": null, - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": "pull_number", - "deprecated": true - }, - { - "name": "in_reply_to", - "description": "The comment ID to reply to. **Note**: This must be the ID of a top-level comment, not a reply to that comment. Replies to replies are not supported.", - "in": "BODY", - "type": "integer", - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": true } ], "responses": [ { - "code": 201, + "code": 200, "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\"id\":10,\"node_id\":\"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\"pull_request_review_id\":42,\"diff_hunk\":\"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\"path\":\"file1.txt\",\"position\":1,\"original_position\":4,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"original_commit_id\":\"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\"in_reply_to_id\":8,\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Great stuff!\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"author_association\":\"NONE\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\"}},\"start_line\":1,\"original_start_line\":1,\"start_side\":\"RIGHT\",\"line\":2,\"original_line\":2,\"side\":\"RIGHT\"}" + "data": "{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\",\"closed_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" } ] } @@ -32925,15 +25223,15 @@ "renamed": null }, { - "name": "Create a comment", - "scope": "pulls", - "id": "createCommentReply", + "name": "Add assignees to an issue", + "scope": "issues", + "id": "addAssignees", "method": "POST", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", "isDeprecated": false, "isLegacy": false, - "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Comments](https://developer.github.com/v3/issues/comments/#create-a-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see [Multi-line comment summary](https://developer.github.com/v3/pulls/comments/#multi-line-comment-summary-3).\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://developer.github.com/v3/pulls/comments/#parameters-2) table.", - "documentationUrl": "https://developer.github.com/v3/pulls/comments/#create-a-comment", + "description": "Adds up to 10 assignees to an issue. Users already assigned to an issue are not replaced.\n\nThis example adds two assignees to the existing `octocat` assignee.", + "documentationUrl": "https://developer.github.com/v3/issues/assignees/#add-assignees-to-an-issue", "previews": [], "headers": [], "parameters": [ @@ -32964,8 +25262,8 @@ "deprecated": null }, { - "name": "pull_number", - "description": "pull_number parameter", + "name": "issue_number", + "description": "issue_number parameter", "in": "PATH", "type": "integer", "required": true, @@ -32977,9 +25275,49 @@ "deprecated": null }, { - "name": "body", - "description": "The text of the review comment.", + "name": "assignees", + "description": "Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._", "in": "BODY", + "type": "string[]", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 201, + "description": "response", + "examples": [ + { + "data": "{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true},{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\"}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Remove assignees from an issue", + "scope": "issues", + "id": "removeAssignees", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/assignees", + "isDeprecated": false, + "isLegacy": false, + "description": "Removes one or more assignees from an issue.\n\nThis example removes two of three assignees, leaving the `octocat` assignee.", + "documentationUrl": "https://developer.github.com/v3/issues/assignees/#remove-assignees-from-an-issue", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "owner parameter", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -32990,9 +25328,9 @@ "deprecated": null }, { - "name": "commit_id", - "description": "The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`.", - "in": "BODY", + "name": "repo", + "description": "repo parameter", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -33003,10 +25341,10 @@ "deprecated": null }, { - "name": "path", - "description": "The relative path to the file that necessitates a comment.", - "in": "BODY", - "type": "string", + "name": "issue_number", + "description": "issue_number parameter", + "in": "PATH", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -33016,10 +25354,10 @@ "deprecated": null }, { - "name": "position", - "description": "**Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", + "name": "assignees", + "description": "Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._", "in": "BODY", - "type": "integer", + "type": "string[]", "required": false, "enum": null, "allowNull": false, @@ -33027,14 +25365,41 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "side", - "description": "**Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", - "in": "BODY", + "code": 200, + "description": "response", + "examples": [ + { + "data": "{\"id\":1,\"node_id\":\"MDU6SXNzdWUx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"repository_url\":\"https://api.github.com/repos/octocat/Hello-World\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"events_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347\",\"number\":1347,\"state\":\"open\",\"title\":\"Found a bug\",\"body\":\"I'm having a problem with this.\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"locked\":true,\"active_lock_reason\":\"too heated\",\"comments\":0,\"pull_request\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\"},\"closed_at\":null,\"created_at\":\"2011-04-22T13:33:48Z\",\"updated_at\":\"2011-04-22T13:33:48Z\"}" + } + ] + } + ], + "renamed": null + }, + { + "name": "List comments on an issue", + "scope": "issues", + "id": "listComments", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/comments", + "isDeprecated": false, + "isLegacy": false, + "description": "Issue Comments are ordered by ascending ID.\n\n", + "documentationUrl": "https://developer.github.com/v3/issues/comments/#list-comments-on-an-issue", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "owner parameter", + "in": "PATH", "type": "string", - "required": false, - "enum": ["LEFT", "RIGHT"], + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -33042,11 +25407,11 @@ "deprecated": null }, { - "name": "line", - "description": "**Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.", - "in": "BODY", - "type": "integer", - "required": false, + "name": "repo", + "description": "repo parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -33055,11 +25420,11 @@ "deprecated": null }, { - "name": "start_line", - "description": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", - "in": "BODY", + "name": "issue_number", + "description": "issue_number parameter", + "in": "PATH", "type": "integer", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -33068,12 +25433,12 @@ "deprecated": null }, { - "name": "start_side", - "description": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", - "in": "BODY", + "name": "since", + "description": "Only comments updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "QUERY", "type": "string", "required": false, - "enum": ["LEFT", "RIGHT", "side"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -33081,79 +25446,61 @@ "deprecated": null }, { - "name": "number", - "description": null, - "in": null, - "type": null, - "required": null, + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, - "allowNull": null, + "allowNull": false, "mapToData": null, "validation": null, - "alias": "pull_number", - "deprecated": true + "alias": null, + "deprecated": null }, { - "name": "in_reply_to", - "description": "The comment ID to reply to. **Note**: This must be the ID of a top-level comment, not a reply to that comment. Replies to replies are not supported.", - "in": "BODY", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", "type": "integer", - "required": null, + "required": false, "enum": null, - "allowNull": null, + "allowNull": false, "mapToData": null, "validation": null, "alias": null, - "deprecated": true + "deprecated": null } ], "responses": [ { - "code": 201, + "code": 200, "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\"id\":10,\"node_id\":\"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\"pull_request_review_id\":42,\"diff_hunk\":\"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\"path\":\"file1.txt\",\"position\":1,\"original_position\":4,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"original_commit_id\":\"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\"in_reply_to_id\":8,\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Great stuff!\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"author_association\":\"NONE\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\"}},\"start_line\":1,\"original_start_line\":1,\"start_side\":\"RIGHT\",\"line\":2,\"original_line\":2,\"side\":\"RIGHT\"}" + "data": "[{\"id\":1,\"node_id\":\"MDEyOklzc3VlQ29tbWVudDE=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments/1\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347#issuecomment-1\",\"body\":\"Me too\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}]" } ] } ], - "renamed": { - "before": { "scope": "pulls", "id": "createCommentReply" }, - "after": { "scope": "pulls", "id": "createComment" }, - "date": "2019-09-09", - "note": "\"Create a comment reply\" is now \"Create a comment\". To create a pull request review comment reply, use the new \"Create a review comment reply\" endpoint" - } + "renamed": null }, { - "name": "Create a review comment reply", - "scope": "pulls", - "id": "createReviewCommentReply", + "name": "Create a comment", + "scope": "issues", + "id": "createComment", "method": "POST", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/comments", "isDeprecated": false, "isLegacy": false, - "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.", - "documentationUrl": "https://developer.github.com/v3/pulls/comments/#create-a-review-comment-reply", + "description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.", + "documentationUrl": "https://developer.github.com/v3/issues/comments/#create-a-comment", "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "owner parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, + "headers": [], + "parameters": [ { - "name": "repo", - "description": "repo parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", "type": "string", "required": true, @@ -33165,10 +25512,10 @@ "deprecated": null }, { - "name": "pull_number", - "description": "pull_number parameter", + "name": "repo", + "description": "repo parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -33178,8 +25525,8 @@ "deprecated": null }, { - "name": "comment_id", - "description": "comment_id parameter", + "name": "issue_number", + "description": "issue_number parameter", "in": "PATH", "type": "integer", "required": true, @@ -33192,7 +25539,7 @@ }, { "name": "body", - "description": "The text of the review comment.", + "description": "The contents of the comment.", "in": "BODY", "type": "string", "required": true, @@ -33210,7 +25557,7 @@ "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/comments/1\",\"pull_request_review_id\":1,\"id\":2,\"node_id\":\"MDEzOkNvbW1pdENvbW1lbnQx\",\"diff_hunk\":\"@@ -18,3 +18,5 @@ This is my amazing work.\",\"path\":\"file1.txt\",\"position\":4,\"original_position\":4,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"original_commit_id\":\"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"I like this too!\",\"created_at\":\"2019-08-11T16:00:49Z\",\"updated_at\":\"2019-08-11T16:00:49Z\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"author_association\":\"NONE\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\"}}}" + "data": "{\"id\":1,\"node_id\":\"MDEyOklzc3VlQ29tbWVudDE=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/comments/1\",\"html_url\":\"https://github.com/octocat/Hello-World/issues/1347#issuecomment-1\",\"body\":\"Me too\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\"}" } ] } @@ -33218,15 +25565,15 @@ "renamed": null }, { - "name": "List commits on a pull request", - "scope": "pulls", - "id": "listCommits", + "name": "List events for an issue", + "scope": "issues", + "id": "listEvents", "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/commits", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/events", "isDeprecated": false, "isLegacy": false, - "description": "Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [Commit List API](https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository).", - "documentationUrl": "https://developer.github.com/v3/pulls/#list-commits-on-a-pull-request", + "description": "", + "documentationUrl": "https://developer.github.com/v3/issues/events/#list-events-for-an-issue", "previews": [], "headers": [], "parameters": [ @@ -33257,8 +25604,8 @@ "deprecated": null }, { - "name": "pull_number", - "description": "pull_number parameter", + "name": "issue_number", + "description": "issue_number parameter", "in": "PATH", "type": "integer", "required": true, @@ -33294,19 +25641,6 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "number", - "description": null, - "in": null, - "type": null, - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": "pull_number", - "deprecated": true } ], "responses": [ @@ -33315,7 +25649,7 @@ "description": "response", "examples": [ { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}]}]" + "data": "[{\"id\":1,\"node_id\":\"MDEwOklzc3VlRXZlbnQx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events/1\",\"actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"event\":\"closed\",\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"commit_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"created_at\":\"2011-04-14T16:00:49Z\"}]" } ] } @@ -33323,15 +25657,15 @@ "renamed": null }, { - "name": "List pull requests files", - "scope": "pulls", - "id": "listFiles", + "name": "List labels on an issue", + "scope": "issues", + "id": "listLabelsOnIssue", "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/files", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", "isDeprecated": false, "isLegacy": false, - "description": "**Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.", - "documentationUrl": "https://developer.github.com/v3/pulls/#list-pull-requests-files", + "description": "", + "documentationUrl": "https://developer.github.com/v3/issues/labels/#list-labels-on-an-issue", "previews": [], "headers": [], "parameters": [ @@ -33362,8 +25696,8 @@ "deprecated": null }, { - "name": "pull_number", - "description": "pull_number parameter", + "name": "issue_number", + "description": "issue_number parameter", "in": "PATH", "type": "integer", "required": true, @@ -33399,19 +25733,6 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "number", - "description": null, - "in": null, - "type": null, - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": "pull_number", - "deprecated": true } ], "responses": [ @@ -33420,7 +25741,7 @@ "description": "response", "examples": [ { - "data": "[{\"sha\":\"bbcd538c8e72b8c175046e27cc8f907076331401\",\"filename\":\"file1.txt\",\"status\":\"added\",\"additions\":103,\"deletions\":21,\"changes\":124,\"blob_url\":\"https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt\",\"raw_url\":\"https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"patch\":\"@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test\"}]" + "data": "[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true},{\"id\":208045947,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDc=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/enhancement\",\"name\":\"enhancement\",\"description\":\"New feature or request\",\"color\":\"a2eeef\",\"default\":false}]" } ] } @@ -33428,15 +25749,15 @@ "renamed": null }, { - "name": "Get if a pull request has been merged", - "scope": "pulls", - "id": "checkIfMerged", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", + "name": "Add labels to an issue", + "scope": "issues", + "id": "addLabels", + "method": "POST", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", "isDeprecated": false, "isLegacy": false, "description": "", - "documentationUrl": "https://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged", + "documentationUrl": "https://developer.github.com/v3/issues/labels/#add-labels-to-an-issue", "previews": [], "headers": [], "parameters": [ @@ -33467,8 +25788,8 @@ "deprecated": null }, { - "name": "pull_number", - "description": "pull_number parameter", + "name": "issue_number", + "description": "issue_number parameter", "in": "PATH", "type": "integer", "required": true, @@ -33480,32 +25801,42 @@ "deprecated": null }, { - "name": "number", - "description": null, - "in": null, - "type": null, - "required": null, + "name": "labels", + "description": "The name of the label to add to the issue. Must contain at least one label. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", + "in": "BODY", + "type": "string[]", + "required": true, "enum": null, - "allowNull": null, + "allowNull": false, "mapToData": null, "validation": null, - "alias": "pull_number", - "deprecated": true + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "response", + "examples": [ + { + "data": "[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true},{\"id\":208045947,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDc=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/enhancement\",\"name\":\"enhancement\",\"description\":\"New feature or request\",\"color\":\"a2eeef\",\"default\":false}]" + } + ] } ], - "responses": [], "renamed": null }, { - "name": "Merge a pull request (Merge Button)", - "scope": "pulls", - "id": "merge", + "name": "Replace all labels for an issue", + "scope": "issues", + "id": "replaceLabels", "method": "PUT", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", "isDeprecated": false, "isLegacy": false, - "description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.", - "documentationUrl": "https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-button", + "description": "", + "documentationUrl": "https://developer.github.com/v3/issues/labels/#replace-all-labels-for-an-issue", "previews": [], "headers": [], "parameters": [ @@ -33536,8 +25867,8 @@ "deprecated": null }, { - "name": "pull_number", - "description": "pull_number parameter", + "name": "issue_number", + "description": "issue_number parameter", "in": "PATH", "type": "integer", "required": true, @@ -33549,36 +25880,10 @@ "deprecated": null }, { - "name": "commit_title", - "description": "Title for the automatic commit message.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "commit_message", - "description": "Extra detail to append to automatic commit message.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "sha", - "description": "SHA that pull request head must match to allow merge.", + "name": "labels", + "description": "The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key.", "in": "BODY", - "type": "string", + "type": "string[]", "required": false, "enum": null, "allowNull": false, @@ -33586,59 +25891,15 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "merge_method", - "description": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["merge", "squash", "rebase"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "number", - "description": null, - "in": null, - "type": null, - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": "pull_number", - "deprecated": true } ], "responses": [ { "code": 200, - "description": "Response if merge was successful", - "examples": [ - { - "data": "{\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"merged\":true,\"message\":\"Pull Request successfully merged\"}" - } - ] - }, - { - "code": 405, - "description": "Response if merge cannot be performed", - "examples": [ - { - "data": "{\"message\":\"Pull Request is not mergeable\",\"documentation_url\":\"https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-button\"}" - } - ] - }, - { - "code": 409, - "description": "Response if sha was provided and pull request head did not match", + "description": "response", "examples": [ { - "data": "{\"message\":\"Head branch was modified. Review and try the merge again.\",\"documentation_url\":\"https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-button\"}" + "data": "[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true},{\"id\":208045947,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDc=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/enhancement\",\"name\":\"enhancement\",\"description\":\"New feature or request\",\"color\":\"a2eeef\",\"default\":false}]" } ] } @@ -33646,15 +25907,15 @@ "renamed": null }, { - "name": "List review requests", - "scope": "pulls", - "id": "listReviewRequests", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", + "name": "Remove all labels from an issue", + "scope": "issues", + "id": "removeLabels", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels", "isDeprecated": false, "isLegacy": false, "description": "", - "documentationUrl": "https://developer.github.com/v3/pulls/review_requests/#list-review-requests", + "documentationUrl": "https://developer.github.com/v3/issues/labels/#remove-all-labels-from-an-issue", "previews": [], "headers": [], "parameters": [ @@ -33685,8 +25946,8 @@ "deprecated": null }, { - "name": "pull_number", - "description": "pull_number parameter", + "name": "issue_number", + "description": "issue_number parameter", "in": "PATH", "type": "integer", "required": true, @@ -33696,13 +25957,43 @@ "validation": null, "alias": null, "deprecated": null + } + ], + "responses": [], + "renamed": null + }, + { + "name": "Remove a label from an issue", + "scope": "issues", + "id": "removeLabel", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}", + "isDeprecated": false, + "isLegacy": false, + "description": "Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist.", + "documentationUrl": "https://developer.github.com/v3/issues/labels/#remove-a-label-from-an-issue", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "owner parameter", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "repo", + "description": "repo parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -33711,11 +26002,11 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", + "name": "issue_number", + "description": "issue_number parameter", + "in": "PATH", "type": "integer", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -33724,17 +26015,17 @@ "deprecated": null }, { - "name": "number", - "description": null, - "in": null, - "type": null, - "required": null, + "name": "name", + "description": "name parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, - "allowNull": null, + "allowNull": false, "mapToData": null, "validation": null, - "alias": "pull_number", - "deprecated": true + "alias": null, + "deprecated": null } ], "responses": [ @@ -33743,7 +26034,7 @@ "description": "response", "examples": [ { - "data": "{\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]}" + "data": "[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}]" } ] } @@ -33751,15 +26042,15 @@ "renamed": null }, { - "name": "Create a review request", - "scope": "pulls", - "id": "createReviewRequest", - "method": "POST", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", + "name": "Lock an issue", + "scope": "issues", + "id": "lock", + "method": "PUT", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/lock", "isDeprecated": false, "isLegacy": false, - "description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.", - "documentationUrl": "https://developer.github.com/v3/pulls/review_requests/#create-a-review-request", + "description": "Users with push access can lock an issue or pull request's conversation.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\"", + "documentationUrl": "https://developer.github.com/v3/issues/#lock-an-issue", "previews": [], "headers": [], "parameters": [ @@ -33790,8 +26081,8 @@ "deprecated": null }, { - "name": "pull_number", - "description": "pull_number parameter", + "name": "issue_number", + "description": "issue_number parameter", "in": "PATH", "type": "integer", "required": true, @@ -33803,68 +26094,32 @@ "deprecated": null }, { - "name": "reviewers", - "description": "An array of user `login`s that will be requested.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_reviewers", - "description": "An array of team `slug`s that will be requested.", + "name": "lock_reason", + "description": "The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: \n\\* `off-topic` \n\\* `too heated` \n\\* `resolved` \n\\* `spam`", "in": "BODY", - "type": "string[]", + "type": "string", "required": false, - "enum": null, + "enum": ["off-topic", "too heated", "resolved", "spam"], "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - }, - { - "name": "number", - "description": null, - "in": null, - "type": null, - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": "pull_number", - "deprecated": true - } - ], - "responses": [ - { - "code": 201, - "description": "response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true},{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"draft\":false}" - } - ] } ], + "responses": [], "renamed": null }, { - "name": "Delete a review request", - "scope": "pulls", - "id": "deleteReviewRequest", + "name": "Unlock an issue", + "scope": "issues", + "id": "unlock", "method": "DELETE", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/lock", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/pulls/review_requests/#delete-a-review-request", + "description": "Users with push access can unlock an issue's conversation.", + "documentationUrl": "https://developer.github.com/v3/issues/#unlock-an-issue", "previews": [], "headers": [], "parameters": [ @@ -33895,8 +26150,8 @@ "deprecated": null }, { - "name": "pull_number", - "description": "pull_number parameter", + "name": "issue_number", + "description": "issue_number parameter", "in": "PATH", "type": "integer", "required": true, @@ -33906,62 +26161,29 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "reviewers", - "description": "An array of user `login`s that will be removed.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_reviewers", - "description": "An array of team `slug`s that will be removed.", - "in": "BODY", - "type": "string[]", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "number", - "description": null, - "in": null, - "type": null, - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": "pull_number", - "deprecated": true } ], "responses": [], "renamed": null }, { - "name": "List reviews on a pull request", - "scope": "pulls", - "id": "listReviews", + "name": "List reactions for an issue", + "scope": "reactions", + "id": "listForIssue", "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", "isDeprecated": false, "isLegacy": false, - "description": "The list of reviews returns in chronological order.", - "documentationUrl": "https://developer.github.com/v3/pulls/reviews/#list-reviews-on-a-pull-request", - "previews": [], - "headers": [], + "description": "List the reactions to an [issue](https://developer.github.com/v3/issues/).", + "documentationUrl": "https://developer.github.com/v3/reactions/#list-reactions-for-an-issue", + "previews": [{ "name": "squirrel-girl" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.squirrel-girl-preview+json", + "required": true + } + ], "parameters": [ { "name": "owner", @@ -33990,8 +26212,8 @@ "deprecated": null }, { - "name": "pull_number", - "description": "pull_number parameter", + "name": "issue_number", + "description": "issue_number parameter", "in": "PATH", "type": "integer", "required": true, @@ -34002,6 +26224,28 @@ "alias": null, "deprecated": null }, + { + "name": "content", + "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "per_page", "description": "Results per page (max 100)", @@ -34027,28 +26271,15 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "number", - "description": null, - "in": null, - "type": null, - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": "pull_number", - "deprecated": true } ], "responses": [ { "code": 200, - "description": "The list of reviews returns in chronological order.", + "description": "response", "examples": [ { - "data": "[{\"id\":80,\"node_id\":\"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Here is the body for the review.\",\"submitted_at\":\"2019-11-17T17:43:43Z\",\"commit_id\":\"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\"state\":\"APPROVED\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\"_links\":{\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\"}}}]" + "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" } ] } @@ -34056,17 +26287,23 @@ "renamed": null }, { - "name": "Create a pull request review", - "scope": "pulls", - "id": "createReview", + "name": "Create reaction for an issue", + "scope": "reactions", + "id": "createForIssue", "method": "POST", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/reactions", "isDeprecated": false, "isLegacy": false, - "description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://developer.github.com/v3/pulls/#get-a-single-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.", - "documentationUrl": "https://developer.github.com/v3/pulls/reviews/#create-a-pull-request-review", - "previews": [], - "headers": [], + "description": "Create a reaction to an [issue](https://developer.github.com/v3/issues/). A response with a `Status: 200 OK` means that you already added the reaction type to this issue.", + "documentationUrl": "https://developer.github.com/v3/reactions/#create-reaction-for-an-issue", + "previews": [{ "name": "squirrel-girl" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.squirrel-girl-preview+json", + "required": true + } + ], "parameters": [ { "name": "owner", @@ -34095,8 +26332,8 @@ "deprecated": null }, { - "name": "pull_number", - "description": "pull_number parameter", + "name": "issue_number", + "description": "issue_number parameter", "in": "PATH", "type": "integer", "required": true, @@ -34108,24 +26345,66 @@ "deprecated": null }, { - "name": "commit_id", - "description": "The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value.", + "name": "content", + "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the issue.", "in": "BODY", "type": "string", - "required": false, - "enum": null, + "required": true, + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ + { + "code": 201, + "description": "response", + "examples": [ + { + "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" + } + ] + } + ], + "renamed": null + }, + { + "name": "List events for an issue", + "scope": "issues", + "id": "listEventsForTimeline", + "method": "GET", + "url": "/repos/{owner}/{repo}/issues/{issue_number}/timeline", + "isDeprecated": false, + "isLegacy": false, + "description": "", + "documentationUrl": "https://developer.github.com/v3/issues/timeline/#list-events-for-an-issue", + "previews": [{ "name": "mockingbird" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.mockingbird-preview+json", + "required": true + } + ], + "parameters": [ { - "name": "body", - "description": "**Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review.", - "in": "BODY", + "name": "owner", + "description": "owner parameter", + "in": "PATH", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -34134,24 +26413,11 @@ "deprecated": null }, { - "name": "event", - "description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://developer.github.com/v3/pulls/reviews/#submit-a-pull-request-review) when you are ready.", - "in": "BODY", + "name": "repo", + "description": "repo parameter", + "in": "PATH", "type": "string", - "required": false, - "enum": ["APPROVE", "REQUEST_CHANGES", "COMMENT"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "comments", - "description": "Use the following table to specify the location, destination, and contents of the draft review comment.", - "in": "BODY", - "type": "object[]", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -34160,10 +26426,10 @@ "deprecated": null }, { - "name": "comments[].path", - "description": "The relative path to the file that necessitates a review comment.", - "in": "BODY", - "type": "string", + "name": "issue_number", + "description": "issue_number parameter", + "in": "PATH", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -34173,11 +26439,11 @@ "deprecated": null }, { - "name": "comments[].position", - "description": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.", - "in": "BODY", + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", "type": "integer", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -34186,30 +26452,17 @@ "deprecated": null }, { - "name": "comments[].body", - "description": "Text of the review comment.", - "in": "BODY", - "type": "string", - "required": true, + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - }, - { - "name": "number", - "description": null, - "in": null, - "type": null, - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": "pull_number", - "deprecated": true } ], "responses": [ @@ -34218,7 +26471,7 @@ "description": "response", "examples": [ { - "data": "{\"id\":80,\"node_id\":\"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"This is close to perfect! Please address the suggested inline change.\",\"commit_id\":\"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\"state\":\"CHANGES_REQUESTED\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\"_links\":{\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\"}}}" + "data": "[{\"id\":1,\"node_id\":\"MDEwOklzc3VlRXZlbnQx\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/issues/events/1\",\"actor\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"event\":\"closed\",\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"commit_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"created_at\":\"2011-04-14T16:00:49Z\"}]" } ] } @@ -34226,15 +26479,15 @@ "renamed": null }, { - "name": "Get a single review", - "scope": "pulls", - "id": "getReview", + "name": "List deploy keys", + "scope": "repos", + "id": "listDeployKeys", "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", + "url": "/repos/{owner}/{repo}/keys", "isDeprecated": false, "isLegacy": false, "description": "", - "documentationUrl": "https://developer.github.com/v3/pulls/reviews/#get-a-single-review", + "documentationUrl": "https://developer.github.com/v3/repos/keys/#list-deploy-keys", "previews": [], "headers": [], "parameters": [ @@ -34265,11 +26518,11 @@ "deprecated": null }, { - "name": "pull_number", - "description": "pull_number parameter", - "in": "PATH", + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", "type": "integer", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -34278,30 +26531,17 @@ "deprecated": null }, { - "name": "review_id", - "description": "review_id parameter", - "in": "PATH", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", "type": "integer", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - }, - { - "name": "number", - "description": null, - "in": null, - "type": null, - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": "pull_number", - "deprecated": true } ], "responses": [ @@ -34310,7 +26550,7 @@ "description": "response", "examples": [ { - "data": "{\"id\":80,\"node_id\":\"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Here is the body for the review.\",\"submitted_at\":\"2019-11-17T17:43:43Z\",\"commit_id\":\"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\"state\":\"APPROVED\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\"_links\":{\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\"}}}" + "data": "[{\"id\":1,\"key\":\"ssh-rsa AAA...\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/keys/1\",\"title\":\"octocat@octomac\",\"verified\":true,\"created_at\":\"2014-12-10T15:53:42Z\",\"read_only\":true}]" } ] } @@ -34318,15 +26558,15 @@ "renamed": null }, { - "name": "Delete a pending review", - "scope": "pulls", - "id": "deletePendingReview", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", + "name": "Add a new deploy key", + "scope": "repos", + "id": "addDeployKey", + "method": "POST", + "url": "/repos/{owner}/{repo}/keys", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/pulls/reviews/#delete-a-pending-review", + "description": "Here's how you can create a read-only deploy key:\n\n", + "documentationUrl": "https://developer.github.com/v3/repos/keys/#add-a-new-deploy-key", "previews": [], "headers": [], "parameters": [ @@ -34357,11 +26597,11 @@ "deprecated": null }, { - "name": "pull_number", - "description": "pull_number parameter", - "in": "PATH", - "type": "integer", - "required": true, + "name": "title", + "description": "A name for the key.", + "in": "BODY", + "type": "string", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -34370,10 +26610,10 @@ "deprecated": null }, { - "name": "review_id", - "description": "review_id parameter", - "in": "PATH", - "type": "integer", + "name": "key", + "description": "The contents of the key.", + "in": "BODY", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -34383,26 +26623,26 @@ "deprecated": null }, { - "name": "number", - "description": null, - "in": null, - "type": null, - "required": null, + "name": "read_only", + "description": "If `true`, the key will only be able to read repository contents. Otherwise, the key will be able to read and write. \n \nDeploy keys with write access can perform the same actions as an organization member with admin access, or a collaborator on a personal repository. For more information, see \"[Repository permission levels for an organization](https://help.github.com/articles/repository-permission-levels-for-an-organization/)\" and \"[Permission levels for a user account repository](https://help.github.com/articles/permission-levels-for-a-user-account-repository/).\"", + "in": "BODY", + "type": "boolean", + "required": false, "enum": null, - "allowNull": null, + "allowNull": false, "mapToData": null, "validation": null, - "alias": "pull_number", - "deprecated": true + "alias": null, + "deprecated": null } ], "responses": [ { - "code": 200, + "code": 201, "description": "response", "examples": [ { - "data": "{\"id\":80,\"node_id\":\"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Here is the body for the review.\",\"commit_id\":\"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\"state\":\"PENDING\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\"_links\":{\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\"}}}" + "data": "{\"id\":1,\"key\":\"ssh-rsa AAA...\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/keys/1\",\"title\":\"octocat@octomac\",\"verified\":true,\"created_at\":\"2014-12-10T15:53:42Z\",\"read_only\":true}" } ] } @@ -34410,15 +26650,15 @@ "renamed": null }, { - "name": "Update a pull request review", - "scope": "pulls", - "id": "updateReview", - "method": "PUT", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", + "name": "Get a deploy key", + "scope": "repos", + "id": "getDeployKey", + "method": "GET", + "url": "/repos/{owner}/{repo}/keys/{key_id}", "isDeprecated": false, "isLegacy": false, - "description": "Update the review summary comment with new text.", - "documentationUrl": "https://developer.github.com/v3/pulls/reviews/#update-a-pull-request-review", + "description": "", + "documentationUrl": "https://developer.github.com/v3/repos/keys/#get-a-deploy-key", "previews": [], "headers": [], "parameters": [ @@ -34449,21 +26689,8 @@ "deprecated": null }, { - "name": "pull_number", - "description": "pull_number parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "review_id", - "description": "review_id parameter", + "name": "key_id", + "description": "key_id parameter", "in": "PATH", "type": "integer", "required": true, @@ -34473,32 +26700,6 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "body", - "description": "The body text of the pull request review.", - "in": "BODY", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "number", - "description": null, - "in": null, - "type": null, - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": "pull_number", - "deprecated": true } ], "responses": [ @@ -34507,7 +26708,7 @@ "description": "response", "examples": [ { - "data": "{\"id\":80,\"node_id\":\"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"This is close to perfect! Please address the suggested inline change. And add more about this.\",\"commit_id\":\"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\"state\":\"CHANGES_REQUESTED\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\"_links\":{\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\"}}}" + "data": "{\"id\":1,\"key\":\"ssh-rsa AAA...\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/keys/1\",\"title\":\"octocat@octomac\",\"verified\":true,\"created_at\":\"2014-12-10T15:53:42Z\",\"read_only\":true}" } ] } @@ -34515,15 +26716,15 @@ "renamed": null }, { - "name": "Get comments for a single review", - "scope": "pulls", - "id": "getCommentsForReview", - "method": "GET", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments", + "name": "Remove a deploy key", + "scope": "repos", + "id": "removeDeployKey", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/keys/{key_id}", "isDeprecated": false, "isLegacy": false, "description": "", - "documentationUrl": "https://developer.github.com/v3/pulls/reviews/#get-comments-for-a-single-review", + "documentationUrl": "https://developer.github.com/v3/repos/keys/#remove-a-deploy-key", "previews": [], "headers": [], "parameters": [ @@ -34554,8 +26755,8 @@ "deprecated": null }, { - "name": "pull_number", - "description": "pull_number parameter", + "name": "key_id", + "description": "key_id parameter", "in": "PATH", "type": "integer", "required": true, @@ -34565,12 +26766,42 @@ "validation": null, "alias": null, "deprecated": null + } + ], + "responses": [], + "renamed": null + }, + { + "name": "List all labels for this repository", + "scope": "issues", + "id": "listLabelsForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/labels", + "isDeprecated": false, + "isLegacy": false, + "description": "", + "documentationUrl": "https://developer.github.com/v3/issues/labels/#list-all-labels-for-this-repository", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "owner parameter", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null }, { - "name": "review_id", - "description": "review_id parameter", + "name": "repo", + "description": "repo parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -34604,19 +26835,6 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "number", - "description": null, - "in": null, - "type": null, - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": "pull_number", - "deprecated": true } ], "responses": [ @@ -34625,7 +26843,7 @@ "description": "response", "examples": [ { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\"id\":10,\"node_id\":\"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\"pull_request_review_id\":42,\"diff_hunk\":\"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\"path\":\"file1.txt\",\"position\":1,\"original_position\":4,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"original_commit_id\":\"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\"in_reply_to_id\":8,\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Great stuff!\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"author_association\":\"NONE\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\"}}}]" + "data": "[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true},{\"id\":208045947,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDc=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/enhancement\",\"name\":\"enhancement\",\"description\":\"New feature or request\",\"color\":\"a2eeef\",\"default\":false}]" } ] } @@ -34633,15 +26851,15 @@ "renamed": null }, { - "name": "Dismiss a pull request review", - "scope": "pulls", - "id": "dismissReview", - "method": "PUT", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals", + "name": "Create a label", + "scope": "issues", + "id": "createLabel", + "method": "POST", + "url": "/repos/{owner}/{repo}/labels", "isDeprecated": false, "isLegacy": false, - "description": "**Note:** To dismiss a pull request review on a [protected branch](https://developer.github.com/v3/repos/branches/), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.", - "documentationUrl": "https://developer.github.com/v3/pulls/reviews/#dismiss-a-pull-request-review", + "description": "", + "documentationUrl": "https://developer.github.com/v3/issues/labels/#create-a-label", "previews": [], "headers": [], "parameters": [ @@ -34672,10 +26890,10 @@ "deprecated": null }, { - "name": "pull_number", - "description": "pull_number parameter", - "in": "PATH", - "type": "integer", + "name": "name", + "description": "The name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see [emoji-cheat-sheet.com](http://emoji-cheat-sheet.com/).", + "in": "BODY", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -34685,10 +26903,10 @@ "deprecated": null }, { - "name": "review_id", - "description": "review_id parameter", - "in": "PATH", - "type": "integer", + "name": "color", + "description": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.", + "in": "BODY", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -34698,39 +26916,26 @@ "deprecated": null }, { - "name": "message", - "description": "The message for the pull request review dismissal", + "name": "description", + "description": "A short description of the label.", "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - }, - { - "name": "number", - "description": null, - "in": null, - "type": null, - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": "pull_number", - "deprecated": true } ], "responses": [ { - "code": 200, + "code": 201, "description": "response", "examples": [ { - "data": "{\"id\":80,\"node_id\":\"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Here is the body for the review.\",\"commit_id\":\"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\"state\":\"DISMISSED\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\"_links\":{\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\"}}}" + "data": "{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}" } ] } @@ -34738,15 +26943,15 @@ "renamed": null }, { - "name": "Submit a pull request review", - "scope": "pulls", - "id": "submitReview", - "method": "POST", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events", + "name": "Get a single label", + "scope": "issues", + "id": "getLabel", + "method": "GET", + "url": "/repos/{owner}/{repo}/labels/{name}", "isDeprecated": false, "isLegacy": false, "description": "", - "documentationUrl": "https://developer.github.com/v3/pulls/reviews/#submit-a-pull-request-review", + "documentationUrl": "https://developer.github.com/v3/issues/labels/#get-a-single-label", "previews": [], "headers": [], "parameters": [ @@ -34777,69 +26982,17 @@ "deprecated": null }, { - "name": "pull_number", - "description": "pull_number parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "review_id", - "description": "review_id parameter", + "name": "name", + "description": "name parameter", "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "body", - "description": "The body text of the pull request review", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "event", - "description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action.", - "in": "BODY", "type": "string", "required": true, - "enum": ["APPROVE", "REQUEST_CHANGES", "COMMENT"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - }, - { - "name": "number", - "description": null, - "in": null, - "type": null, - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": "pull_number", - "deprecated": true } ], "responses": [ @@ -34848,7 +27001,7 @@ "description": "response", "examples": [ { - "data": "{\"id\":80,\"node_id\":\"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Here is the body for the review.\",\"submitted_at\":\"2019-11-17T17:43:43Z\",\"commit_id\":\"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\"state\":\"APPROVED\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\"_links\":{\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\"}}}" + "data": "{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}" } ] } @@ -34856,22 +27009,17 @@ "renamed": null }, { - "name": "Update a pull request branch", - "scope": "pulls", - "id": "updateBranch", - "method": "PUT", - "url": "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch", + "name": "Update a label", + "scope": "issues", + "id": "updateLabel", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/labels/{name}", "isDeprecated": false, "isLegacy": false, - "description": "Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.", - "documentationUrl": "https://developer.github.com/v3/pulls/#update-a-pull-request-branch", - "previews": [{ "name": "lydian" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.lydian-preview+json" - } - ], + "description": "", + "documentationUrl": "https://developer.github.com/v3/issues/labels/#update-a-label", + "previews": [], + "headers": [], "parameters": [ { "name": "owner", @@ -34900,10 +27048,10 @@ "deprecated": null }, { - "name": "pull_number", - "description": "pull_number parameter", + "name": "name", + "description": "name parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -34913,8 +27061,34 @@ "deprecated": null }, { - "name": "expected_head_sha", - "description": "The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the \"[List commits on a repository](https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository)\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.", + "name": "new_name", + "description": "The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png \":strawberry:\"). For a full list of available emoji and codes, see [emoji-cheat-sheet.com](http://emoji-cheat-sheet.com/).", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "color", + "description": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "description", + "description": "A short description of the label.", "in": "BODY", "type": "string", "required": false, @@ -34928,11 +27102,11 @@ ], "responses": [ { - "code": 202, + "code": 200, "description": "response", "examples": [ { - "data": "{\"message\":\"Updating pull request branch.\",\"url\":\"https://github.com/repos/octocat/Hello-World/pulls/53\"}" + "data": "{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug%20:bug:\",\"name\":\"bug :bug:\",\"description\":\"Small bug fix required\",\"color\":\"b01f26\",\"default\":true}" } ] } @@ -34940,15 +27114,15 @@ "renamed": null }, { - "name": "Get the README", - "scope": "repos", - "id": "getReadme", - "method": "GET", - "url": "/repos/{owner}/{repo}/readme", + "name": "Delete a label", + "scope": "issues", + "id": "deleteLabel", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/labels/{name}", "isDeprecated": false, "isLegacy": false, - "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://developer.github.com/v3/repos/contents/#custom-media-types) for retrieving the raw content or rendered HTML.", - "documentationUrl": "https://developer.github.com/v3/repos/contents/#get-the-readme", + "description": "", + "documentationUrl": "https://developer.github.com/v3/issues/labels/#delete-a-label", "previews": [], "headers": [], "parameters": [ @@ -34979,11 +27153,11 @@ "deprecated": null }, { - "name": "ref", - "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", - "in": "QUERY", + "name": "name", + "description": "name parameter", + "in": "PATH", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -34992,29 +27166,19 @@ "deprecated": null } ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"type\":\"file\",\"encoding\":\"base64\",\"size\":5362,\"name\":\"README.md\",\"path\":\"README.md\",\"content\":\"encoded content ...\",\"sha\":\"3d21ec53a331a6f037a91c368710b99387d012c1\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md\",\"_links\":{\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\"}}" - } - ] - } - ], + "responses": [], "renamed": null }, { - "name": "List releases for a repository", + "name": "List languages", "scope": "repos", - "id": "listReleases", + "id": "listLanguages", "method": "GET", - "url": "/repos/{owner}/{repo}/releases", + "url": "/repos/{owner}/{repo}/languages", "isDeprecated": false, "isLegacy": false, - "description": "This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://developer.github.com/v3/repos/#list-tags).\n\nInformation about published releases are available to everyone. Only users with push access will receive listings for draft releases.", - "documentationUrl": "https://developer.github.com/v3/repos/releases/#list-releases-for-a-repository", + "description": "Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.", + "documentationUrl": "https://developer.github.com/v3/repos/#list-languages", "previews": [], "headers": [], "parameters": [ @@ -35043,13 +27207,36 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, + "code": 200, + "description": "response", + "examples": [{ "data": "{\"C\":78769,\"Python\":7769}" }] + } + ], + "renamed": null + }, + { + "name": "Get the contents of a repository's license", + "scope": "licenses", + "id": "getForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/license", + "isDeprecated": false, + "isLegacy": false, + "description": "This method returns the contents of the repository's license file, if one is detected.\n\nSimilar to [the repository contents API](https://developer.github.com/v3/repos/contents/#get-contents), this method also supports [custom media types](https://developer.github.com/v3/repos/contents/#custom-media-types) for retrieving the raw license content or rendered license HTML.", + "documentationUrl": "https://developer.github.com/v3/licenses/#get-the-contents-of-a-repositorys-license", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "owner parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -35058,11 +27245,11 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "repo", + "description": "repo parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -35077,7 +27264,7 @@ "description": "response", "examples": [ { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1\",\"html_url\":\"https://github.com/octocat/Hello-World/releases/v1.0.0\",\"assets_url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\"upload_url\":\"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\"tarball_url\":\"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\"zipball_url\":\"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\"id\":1,\"node_id\":\"MDc6UmVsZWFzZTE=\",\"tag_name\":\"v1.0.0\",\"target_commitish\":\"master\",\"name\":\"v1.0.0\",\"body\":\"Description of the release\",\"draft\":false,\"prerelease\":false,\"created_at\":\"2013-02-27T19:35:32Z\",\"published_at\":\"2013-02-27T19:35:32Z\",\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assets\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]}]" + "data": "{\"name\":\"LICENSE\",\"path\":\"LICENSE\",\"sha\":\"401c59dcc4570b954dd6d345e76199e1f4e76266\",\"size\":1077,\"url\":\"https://api.github.com/repos/benbalter/gman/contents/LICENSE?ref=master\",\"html_url\":\"https://github.com/benbalter/gman/blob/master/LICENSE\",\"git_url\":\"https://api.github.com/repos/benbalter/gman/git/blobs/401c59dcc4570b954dd6d345e76199e1f4e76266\",\"download_url\":\"https://raw.githubusercontent.com/benbalter/gman/master/LICENSE?lab=true\",\"type\":\"file\",\"content\":\"VGhlIE1JVCBMaWNlbnNlIChNSVQpCgpDb3B5cmlnaHQgKGMpIDIwMTMgQmVu\\nIEJhbHRlcgoKUGVybWlzc2lvbiBpcyBoZXJlYnkgZ3JhbnRlZCwgZnJlZSBv\\nZiBjaGFyZ2UsIHRvIGFueSBwZXJzb24gb2J0YWluaW5nIGEgY29weSBvZgp0\\naGlzIHNvZnR3YXJlIGFuZCBhc3NvY2lhdGVkIGRvY3VtZW50YXRpb24gZmls\\nZXMgKHRoZSAiU29mdHdhcmUiKSwgdG8gZGVhbCBpbgp0aGUgU29mdHdhcmUg\\nd2l0aG91dCByZXN0cmljdGlvbiwgaW5jbHVkaW5nIHdpdGhvdXQgbGltaXRh\\ndGlvbiB0aGUgcmlnaHRzIHRvCnVzZSwgY29weSwgbW9kaWZ5LCBtZXJnZSwg\\ncHVibGlzaCwgZGlzdHJpYnV0ZSwgc3VibGljZW5zZSwgYW5kL29yIHNlbGwg\\nY29waWVzIG9mCnRoZSBTb2Z0d2FyZSwgYW5kIHRvIHBlcm1pdCBwZXJzb25z\\nIHRvIHdob20gdGhlIFNvZnR3YXJlIGlzIGZ1cm5pc2hlZCB0byBkbyBzbywK\\nc3ViamVjdCB0byB0aGUgZm9sbG93aW5nIGNvbmRpdGlvbnM6CgpUaGUgYWJv\\ndmUgY29weXJpZ2h0IG5vdGljZSBhbmQgdGhpcyBwZXJtaXNzaW9uIG5vdGlj\\nZSBzaGFsbCBiZSBpbmNsdWRlZCBpbiBhbGwKY29waWVzIG9yIHN1YnN0YW50\\naWFsIHBvcnRpb25zIG9mIHRoZSBTb2Z0d2FyZS4KClRIRSBTT0ZUV0FSRSBJ\\nUyBQUk9WSURFRCAiQVMgSVMiLCBXSVRIT1VUIFdBUlJBTlRZIE9GIEFOWSBL\\nSU5ELCBFWFBSRVNTIE9SCklNUExJRUQsIElOQ0xVRElORyBCVVQgTk9UIExJ\\nTUlURUQgVE8gVEhFIFdBUlJBTlRJRVMgT0YgTUVSQ0hBTlRBQklMSVRZLCBG\\nSVRORVNTCkZPUiBBIFBBUlRJQ1VMQVIgUFVSUE9TRSBBTkQgTk9OSU5GUklO\\nR0VNRU5ULiBJTiBOTyBFVkVOVCBTSEFMTCBUSEUgQVVUSE9SUyBPUgpDT1BZ\\nUklHSFQgSE9MREVSUyBCRSBMSUFCTEUgRk9SIEFOWSBDTEFJTSwgREFNQUdF\\nUyBPUiBPVEhFUiBMSUFCSUxJVFksIFdIRVRIRVIKSU4gQU4gQUNUSU9OIE9G\\nIENPTlRSQUNULCBUT1JUIE9SIE9USEVSV0lTRSwgQVJJU0lORyBGUk9NLCBP\\nVVQgT0YgT1IgSU4KQ09OTkVDVElPTiBXSVRIIFRIRSBTT0ZUV0FSRSBPUiBU\\nSEUgVVNFIE9SIE9USEVSIERFQUxJTkdTIElOIFRIRSBTT0ZUV0FSRS4K\\n\",\"encoding\":\"base64\",\"_links\":{\"self\":\"https://api.github.com/repos/benbalter/gman/contents/LICENSE?ref=master\",\"git\":\"https://api.github.com/repos/benbalter/gman/git/blobs/401c59dcc4570b954dd6d345e76199e1f4e76266\",\"html\":\"https://github.com/benbalter/gman/blob/master/LICENSE\"},\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"}}" } ] } @@ -35085,15 +27272,15 @@ "renamed": null }, { - "name": "Create a release", + "name": "Perform a merge", "scope": "repos", - "id": "createRelease", + "id": "merge", "method": "POST", - "url": "/repos/{owner}/{repo}/releases", + "url": "/repos/{owner}/{repo}/merges", "isDeprecated": false, "isLegacy": false, - "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.", - "documentationUrl": "https://developer.github.com/v3/repos/releases/#create-a-release", + "description": "", + "documentationUrl": "https://developer.github.com/v3/repos/merging/#perform-a-merge", "previews": [], "headers": [], "parameters": [ @@ -35124,8 +27311,8 @@ "deprecated": null }, { - "name": "tag_name", - "description": "The name of the tag.", + "name": "base", + "description": "The name of the base branch that the head will be merged into.", "in": "BODY", "type": "string", "required": true, @@ -35137,24 +27324,11 @@ "deprecated": null }, { - "name": "target_commitish", - "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`).", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The name of the release.", + "name": "head", + "description": "The head to merge. This can be a branch name or a commit SHA1.", "in": "BODY", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -35163,8 +27337,8 @@ "deprecated": null }, { - "name": "body", - "description": "Text describing the contents of the tag.", + "name": "commit_message", + "description": "Commit message to use for the merge commit. If omitted, a default message will be used.", "in": "BODY", "type": "string", "required": false, @@ -35174,57 +27348,44 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "draft", - "description": "`true` to create a draft (unpublished) release, `false` to create a published one.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "prerelease", - "description": "`true` to identify the release as a prerelease. `false` to identify the release as a full release.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null } ], "responses": [ { "code": 201, - "description": "response", + "description": "Successful Response (The resulting merge commit)", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1\",\"html_url\":\"https://github.com/octocat/Hello-World/releases/v1.0.0\",\"assets_url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\"upload_url\":\"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\"tarball_url\":\"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\"zipball_url\":\"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\"id\":1,\"node_id\":\"MDc6UmVsZWFzZTE=\",\"tag_name\":\"v1.0.0\",\"target_commitish\":\"master\",\"name\":\"v1.0.0\",\"body\":\"Description of the release\",\"draft\":false,\"prerelease\":false,\"created_at\":\"2013-02-27T19:35:32Z\",\"published_at\":\"2013-02-27T19:35:32Z\",\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assets\":[]}" + "data": "{\"sha\":\"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"node_id\":\"MDY6Q29tbWl0N2ZkMWE2MGIwMWY5MWIzMTRmNTk5NTVhNGU0ZDRlODBkOGVkZjExZA==\",\"commit\":{\"author\":{\"name\":\"The Octocat\",\"date\":\"2012-03-06T15:06:50-08:00\",\"email\":\"octocat@nowhere.com\"},\"committer\":{\"name\":\"The Octocat\",\"date\":\"2012-03-06T15:06:50-08:00\",\"email\":\"octocat@nowhere.com\"},\"message\":\"Shipped cool_feature!\",\"tree\":{\"sha\":\"b4eecafa9be2f2006ce1b709d6857b07069b4608\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/trees/b4eecafa9be2f2006ce1b709d6857b07069b4608\"},\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/7fd1a60b01f91b314f59955a4e4d4e80d8edf11d/comments\",\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"sha\":\"553c2077f0edc3d5dc5d17262f6aa498e69d6f8e\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/553c2077f0edc3d5dc5d17262f6aa498e69d6f8e\"},{\"sha\":\"762941318ee16e59dabbacb1b4049eec22f0d303\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/762941318ee16e59dabbacb1b4049eec22f0d303\"}]}" } ] + }, + { + "code": 404, + "description": "response", + "examples": [ + { "data": "{\"message\":\"Base does not exist\"}" }, + { "data": "{\"message\":\"Head does not exist\"}" } + ] + }, + { + "code": 409, + "description": "Merge conflict response", + "examples": [{ "data": "{\"message\":\"Merge Conflict\"}" }] } ], "renamed": null }, { - "name": "Get a single release asset", - "scope": "repos", - "id": "getReleaseAsset", + "name": "List milestones for a repository", + "scope": "issues", + "id": "listMilestonesForRepo", "method": "GET", - "url": "/repos/{owner}/{repo}/releases/assets/{asset_id}", + "url": "/repos/{owner}/{repo}/milestones", "isDeprecated": false, "isLegacy": false, - "description": "To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://developer.github.com/v3/media/#media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.", - "documentationUrl": "https://developer.github.com/v3/repos/releases/#get-a-single-release-asset", + "description": "", + "documentationUrl": "https://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository", "previews": [], "headers": [], "parameters": [ @@ -35255,52 +27416,12 @@ "deprecated": null }, { - "name": "asset_id", - "description": "asset_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://developer.github.com/v3/media/#media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Edit a release asset", - "scope": "repos", - "id": "updateReleaseAsset", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/releases/assets/{asset_id}", - "isDeprecated": false, - "isLegacy": false, - "description": "Users with push access to the repository can edit a release asset.", - "documentationUrl": "https://developer.github.com/v3/repos/releases/#edit-a-release-asset", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "owner parameter", - "in": "PATH", + "name": "state", + "description": "The state of the milestone. Either `open`, `closed`, or `all`.", + "in": "QUERY", "type": "string", - "required": true, - "enum": null, + "required": false, + "enum": ["open", "closed", "all"], "allowNull": false, "mapToData": null, "validation": null, @@ -35308,12 +27429,12 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "sort", + "description": "What to sort results by. Either `due_on` or `completeness`.", + "in": "QUERY", "type": "string", - "required": true, - "enum": null, + "required": false, + "enum": ["due_on", "completeness"], "allowNull": false, "mapToData": null, "validation": null, @@ -35321,12 +27442,12 @@ "deprecated": null }, { - "name": "asset_id", - "description": "asset_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, + "name": "direction", + "description": "The direction of the sort. Either `asc` or `desc`.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["asc", "desc"], "allowNull": false, "mapToData": null, "validation": null, @@ -35334,10 +27455,10 @@ "deprecated": null }, { - "name": "name", - "description": "The file name of the asset.", - "in": "BODY", - "type": "string", + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -35347,10 +27468,10 @@ "deprecated": null }, { - "name": "label", - "description": "An alternate short description of the asset. Used in place of the filename.", - "in": "BODY", - "type": "string", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -35366,7 +27487,7 @@ "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" + "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"}]" } ] } @@ -35374,15 +27495,15 @@ "renamed": null }, { - "name": "Delete a release asset", - "scope": "repos", - "id": "deleteReleaseAsset", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/releases/assets/{asset_id}", + "name": "Create a milestone", + "scope": "issues", + "id": "createMilestone", + "method": "POST", + "url": "/repos/{owner}/{repo}/milestones", "isDeprecated": false, "isLegacy": false, "description": "", - "documentationUrl": "https://developer.github.com/v3/repos/releases/#delete-a-release-asset", + "documentationUrl": "https://developer.github.com/v3/issues/milestones/#create-a-milestone", "previews": [], "headers": [], "parameters": [ @@ -35413,10 +27534,10 @@ "deprecated": null }, { - "name": "asset_id", - "description": "asset_id parameter", - "in": "PATH", - "type": "integer", + "name": "title", + "description": "The title of the milestone.", + "in": "BODY", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -35424,30 +27545,26 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "Get the latest release", - "scope": "repos", - "id": "getLatestRelease", - "method": "GET", - "url": "/repos/{owner}/{repo}/releases/latest", - "isDeprecated": false, - "isLegacy": false, - "description": "View the latest published full release for the repository.\n\nThe latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published.", - "documentationUrl": "https://developer.github.com/v3/repos/releases/#get-the-latest-release", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "owner", - "description": "owner parameter", - "in": "PATH", + "name": "state", + "description": "The state of the milestone. Either `open` or `closed`.", + "in": "BODY", "type": "string", - "required": true, + "required": false, + "enum": ["open", "closed"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "description", + "description": "A description of the milestone.", + "in": "BODY", + "type": "string", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -35456,11 +27573,11 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "due_on", + "description": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -35471,11 +27588,11 @@ ], "responses": [ { - "code": 200, + "code": 201, "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1\",\"html_url\":\"https://github.com/octocat/Hello-World/releases/v1.0.0\",\"assets_url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\"upload_url\":\"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\"tarball_url\":\"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\"zipball_url\":\"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\"id\":1,\"node_id\":\"MDc6UmVsZWFzZTE=\",\"tag_name\":\"v1.0.0\",\"target_commitish\":\"master\",\"name\":\"v1.0.0\",\"body\":\"Description of the release\",\"draft\":false,\"prerelease\":false,\"created_at\":\"2013-02-27T19:35:32Z\",\"published_at\":\"2013-02-27T19:35:32Z\",\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assets\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]}" + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"}" } ] } @@ -35483,15 +27600,15 @@ "renamed": null }, { - "name": "Get a release by tag name", - "scope": "repos", - "id": "getReleaseByTag", + "name": "Get a single milestone", + "scope": "issues", + "id": "getMilestone", "method": "GET", - "url": "/repos/{owner}/{repo}/releases/tags/{tag}", + "url": "/repos/{owner}/{repo}/milestones/{milestone_number}", "isDeprecated": false, "isLegacy": false, - "description": "Get a published release with the specified tag.", - "documentationUrl": "https://developer.github.com/v3/repos/releases/#get-a-release-by-tag-name", + "description": "", + "documentationUrl": "https://developer.github.com/v3/issues/milestones/#get-a-single-milestone", "previews": [], "headers": [], "parameters": [ @@ -35522,10 +27639,10 @@ "deprecated": null }, { - "name": "tag", - "description": "tag parameter", + "name": "milestone_number", + "description": "milestone_number parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -35541,7 +27658,7 @@ "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1\",\"html_url\":\"https://github.com/octocat/Hello-World/releases/v1.0.0\",\"assets_url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\"upload_url\":\"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\"tarball_url\":\"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\"zipball_url\":\"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\"id\":1,\"node_id\":\"MDc6UmVsZWFzZTE=\",\"tag_name\":\"v1.0.0\",\"target_commitish\":\"master\",\"name\":\"v1.0.0\",\"body\":\"Description of the release\",\"draft\":false,\"prerelease\":false,\"created_at\":\"2013-02-27T19:35:32Z\",\"published_at\":\"2013-02-27T19:35:32Z\",\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assets\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]}" + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"}" } ] } @@ -35549,15 +27666,15 @@ "renamed": null }, { - "name": "Get a single release", - "scope": "repos", - "id": "getRelease", - "method": "GET", - "url": "/repos/{owner}/{repo}/releases/{release_id}", + "name": "Update a milestone", + "scope": "issues", + "id": "updateMilestone", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/milestones/{milestone_number}", "isDeprecated": false, "isLegacy": false, - "description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://developer.github.com/v3/#hypermedia).", - "documentationUrl": "https://developer.github.com/v3/repos/releases/#get-a-single-release", + "description": "", + "documentationUrl": "https://developer.github.com/v3/issues/milestones/#update-a-milestone", "previews": [], "headers": [], "parameters": [ @@ -35588,8 +27705,8 @@ "deprecated": null }, { - "name": "release_id", - "description": "release_id parameter", + "name": "milestone_number", + "description": "milestone_number parameter", "in": "PATH", "type": "integer", "required": true, @@ -35599,15 +27716,67 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "title", + "description": "The title of the milestone.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "state", + "description": "The state of the milestone. Either `open` or `closed`.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["open", "closed"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "description", + "description": "A description of the milestone.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "due_on", + "description": "The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ { "code": 200, - "description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://developer.github.com/v3/#hypermedia).", + "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1\",\"html_url\":\"https://github.com/octocat/Hello-World/releases/v1.0.0\",\"assets_url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\"upload_url\":\"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\"tarball_url\":\"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\"zipball_url\":\"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\"id\":1,\"node_id\":\"MDc6UmVsZWFzZTE=\",\"tag_name\":\"v1.0.0\",\"target_commitish\":\"master\",\"name\":\"v1.0.0\",\"body\":\"Description of the release\",\"draft\":false,\"prerelease\":false,\"created_at\":\"2013-02-27T19:35:32Z\",\"published_at\":\"2013-02-27T19:35:32Z\",\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assets\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]}" + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"}" } ] } @@ -35615,15 +27784,15 @@ "renamed": null }, { - "name": "Edit a release", - "scope": "repos", - "id": "updateRelease", - "method": "PATCH", - "url": "/repos/{owner}/{repo}/releases/{release_id}", + "name": "Delete a milestone", + "scope": "issues", + "id": "deleteMilestone", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/milestones/{milestone_number}", "isDeprecated": false, "isLegacy": false, - "description": "Users with push access to the repository can edit a release.", - "documentationUrl": "https://developer.github.com/v3/repos/releases/#edit-a-release", + "description": "", + "documentationUrl": "https://developer.github.com/v3/issues/milestones/#delete-a-milestone", "previews": [], "headers": [], "parameters": [ @@ -35654,8 +27823,8 @@ "deprecated": null }, { - "name": "release_id", - "description": "release_id parameter", + "name": "milestone_number", + "description": "milestone_number parameter", "in": "PATH", "type": "integer", "required": true, @@ -35665,26 +27834,30 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "tag_name", - "description": "The name of the tag.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, + } + ], + "responses": [], + "renamed": null + }, + { + "name": "Get labels for every issue in a milestone", + "scope": "issues", + "id": "listLabelsForMilestone", + "method": "GET", + "url": "/repos/{owner}/{repo}/milestones/{milestone_number}/labels", + "isDeprecated": false, + "isLegacy": false, + "description": "", + "documentationUrl": "https://developer.github.com/v3/issues/labels/#get-labels-for-every-issue-in-a-milestone", + "previews": [], + "headers": [], + "parameters": [ { - "name": "target_commitish", - "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`).", - "in": "BODY", + "name": "owner", + "description": "owner parameter", + "in": "PATH", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -35693,11 +27866,11 @@ "deprecated": null }, { - "name": "name", - "description": "The name of the release.", - "in": "BODY", + "name": "repo", + "description": "repo parameter", + "in": "PATH", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -35706,11 +27879,11 @@ "deprecated": null }, { - "name": "body", - "description": "Text describing the contents of the tag.", - "in": "BODY", - "type": "string", - "required": false, + "name": "milestone_number", + "description": "milestone_number parameter", + "in": "PATH", + "type": "integer", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -35719,10 +27892,10 @@ "deprecated": null }, { - "name": "draft", - "description": "`true` makes the release a draft, and `false` publishes the release.", - "in": "BODY", - "type": "boolean", + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -35732,10 +27905,10 @@ "deprecated": null }, { - "name": "prerelease", - "description": "`true` to identify the release as a prerelease, `false` to identify the release as a full release.", - "in": "BODY", - "type": "boolean", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", "required": false, "enum": null, "allowNull": false, @@ -35751,7 +27924,7 @@ "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1\",\"html_url\":\"https://github.com/octocat/Hello-World/releases/v1.0.0\",\"assets_url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\"upload_url\":\"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\"tarball_url\":\"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\"zipball_url\":\"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\"id\":1,\"node_id\":\"MDc6UmVsZWFzZTE=\",\"tag_name\":\"v1.0.0\",\"target_commitish\":\"master\",\"name\":\"v1.0.0\",\"body\":\"Description of the release\",\"draft\":false,\"prerelease\":false,\"created_at\":\"2013-02-27T19:35:32Z\",\"published_at\":\"2013-02-27T19:35:32Z\",\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assets\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]}" + "data": "[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true},{\"id\":208045947,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDc=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/enhancement\",\"name\":\"enhancement\",\"description\":\"New feature or request\",\"color\":\"a2eeef\",\"default\":false}]" } ] } @@ -35759,15 +27932,15 @@ "renamed": null }, { - "name": "Delete a release", - "scope": "repos", - "id": "deleteRelease", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/releases/{release_id}", + "name": "List your notifications in a repository", + "scope": "activity", + "id": "listNotificationsForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/notifications", "isDeprecated": false, "isLegacy": false, - "description": "Users with push access to the repository can delete a release.", - "documentationUrl": "https://developer.github.com/v3/repos/releases/#delete-a-release", + "description": "List all notifications for the current user.", + "documentationUrl": "https://developer.github.com/v3/activity/notifications/#list-your-notifications-in-a-repository", "previews": [], "headers": [], "parameters": [ @@ -35798,41 +27971,24 @@ "deprecated": null }, { - "name": "release_id", - "description": "release_id parameter", - "in": "PATH", - "type": "integer", - "required": true, + "name": "all", + "description": "If `true`, show notifications marked as read.", + "in": "QUERY", + "type": "boolean", + "required": false, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "List assets for a release", - "scope": "repos", - "id": "listAssetsForRelease", - "method": "GET", - "url": "/repos/{owner}/{repo}/releases/{release_id}/assets", - "isDeprecated": false, - "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/repos/releases/#list-assets-for-a-release", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "owner", - "description": "owner parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "participating", + "description": "If `true`, only shows notifications in which the user is directly participating or mentioned.", + "in": "QUERY", + "type": "boolean", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -35840,12 +27996,12 @@ "alias": null, "deprecated": null }, - { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + { + "name": "since", + "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "QUERY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -35854,11 +28010,11 @@ "deprecated": null }, { - "name": "release_id", - "description": "release_id parameter", - "in": "PATH", - "type": "integer", - "required": true, + "name": "before", + "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "QUERY", + "type": "string", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -35899,7 +28055,7 @@ "description": "response", "examples": [ { - "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]" + "data": "[{\"id\":\"1\",\"repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\"},\"subject\":{\"title\":\"Greetings\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/123\",\"latest_comment_url\":\"https://api.github.com/repos/octokit/octokit.rb/issues/comments/123\",\"type\":\"Issue\"},\"reason\":\"subscribed\",\"unread\":true,\"updated_at\":\"2014-11-07T22:01:45Z\",\"last_read_at\":\"2014-11-07T22:01:45Z\",\"url\":\"https://api.github.com/notifications/threads/1\"}]" } ] } @@ -35907,20 +28063,17 @@ "renamed": null }, { - "name": "Upload a release asset", - "scope": "repos", - "id": "uploadReleaseAsset", - "method": "POST", - "url": "{origin}/repos/{owner}/{repo}/releases/{release_id}/assets{?name,label}", + "name": "Mark notifications as read in a repository", + "scope": "activity", + "id": "markNotificationsAsReadForRepo", + "method": "PUT", + "url": "/repos/{owner}/{repo}/notifications", "isDeprecated": false, "isLegacy": false, - "description": "This endpoint makes use of [a Hypermedia relation](https://developer.github.com/v3/#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in the response of the [Create a release endpoint](https://developer.github.com/v3/repos/releases/#create-a-release) to upload a release asset.\n\nYou need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint.\n\nMost libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example:\n\n`application/zip`\n\nGitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example, you'll still need to pass your authentication to be able to upload an asset.\n\n**Notes:**\n\n* GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"[List assets for a release](https://developer.github.com/v3/repos/releases/#list-assets-for-a-release)\" endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://github.com/contact).\n* If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.\n\nThis may leave an empty asset with a state of `starter`. It can be safely deleted.", - "documentationUrl": "https://developer.github.com/v3/repos/releases/#upload-a-release-asset", + "description": "Marks all notifications in a repository as \"read\" removes them from the [default view on GitHub](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List your notifications in a repository](https://developer.github.com/v3/activity/notifications/#list-your-notifications-in-a-repository) endpoint and pass the query parameter `all=false`.", + "documentationUrl": "https://developer.github.com/v3/activity/notifications/#mark-notifications-as-read-in-a-repository", "previews": [], - "headers": [ - { "name": "content-length", "value": null }, - { "name": "content-type", "value": null } - ], + "headers": [], "parameters": [ { "name": "owner", @@ -35949,22 +28102,9 @@ "deprecated": null }, { - "name": "release_id", - "description": "release_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "name parameter", - "in": "QUERY", + "name": "last_read_at", + "description": "Describes the last point that notifications were checked. Anything updated since this time will not be updated. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Default: The current timestamp.", + "in": "BODY", "type": "string", "required": false, "enum": null, @@ -35973,13 +28113,30 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [], + "renamed": null + }, + { + "name": "Get information about a Pages site", + "scope": "repos", + "id": "getPages", + "method": "GET", + "url": "/repos/{owner}/{repo}/pages", + "isDeprecated": false, + "isLegacy": false, + "description": "", + "documentationUrl": "https://developer.github.com/v3/repos/pages/#get-information-about-a-pages-site", + "previews": [], + "headers": [], + "parameters": [ { - "name": "label", - "description": "label parameter", - "in": "QUERY", + "name": "owner", + "description": "owner parameter", + "in": "PATH", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -35988,52 +28145,26 @@ "deprecated": null }, { - "name": "data", - "description": "The raw file data", - "in": "BODY", + "name": "repo", + "description": "repo parameter", + "in": "PATH", "type": "string", "required": true, "enum": null, "allowNull": false, - "mapToData": true, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "origin", - "description": "The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the \"Create a release\" endpoint", - "in": "PATH", - "type": "string", - "required": null, - "enum": null, - "allowNull": null, "mapToData": null, "validation": null, "alias": null, "deprecated": null - }, - { - "name": "file", - "description": null, - "in": null, - "type": null, - "required": null, - "enum": null, - "allowNull": null, - "mapToData": null, - "validation": null, - "alias": "data", - "deprecated": true } ], "responses": [ { - "code": 201, - "description": "Response for successful upload", + "code": 200, + "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" + "data": "{\"url\":\"https://api.github.com/repos/github/developer.github.com/pages\",\"status\":\"built\",\"cname\":\"developer.github.com\",\"custom_404\":false,\"html_url\":\"https://developer.github.com\",\"source\":{\"branch\":\"master\",\"directory\":\"/\"}}" } ] } @@ -36041,17 +28172,23 @@ "renamed": null }, { - "name": "List Stargazers", - "scope": "activity", - "id": "listStargazersForRepo", - "method": "GET", - "url": "/repos/{owner}/{repo}/stargazers", + "name": "Enable a Pages site", + "scope": "repos", + "id": "enablePagesSite", + "method": "POST", + "url": "/repos/{owner}/{repo}/pages", "isDeprecated": false, "isLegacy": false, - "description": "You can also find out _when_ stars were created by passing the following custom [media type](https://developer.github.com/v3/media/) via the `Accept` header:", - "documentationUrl": "https://developer.github.com/v3/activity/starring/#list-stargazers", - "previews": [], - "headers": [], + "description": "", + "documentationUrl": "https://developer.github.com/v3/repos/pages/#enable-a-pages-site", + "previews": [{ "name": "switcheroo" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.switcheroo-preview+json", + "required": true + } + ], "parameters": [ { "name": "owner", @@ -36080,10 +28217,10 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", + "name": "source", + "description": "source parameter", + "in": "BODY", + "type": "object", "required": false, "enum": null, "allowNull": false, @@ -36093,10 +28230,23 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", + "name": "source.branch", + "description": "The repository branch used to publish your [site's source files](https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/). Can be either `master` or `gh-pages`.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["master", "gh-pages"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "source.path", + "description": "The repository directory that includes the source files for the Pages site. When `branch` is `master`, you can change `path` to `/docs`. When `branch` is `gh-pages`, you are unable to specify a `path` other than `/`.", + "in": "BODY", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -36108,20 +28258,11 @@ ], "responses": [ { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" - } - ] - }, - { - "code": 200, + "code": 201, "description": "response", "examples": [ { - "data": "[{\"starred_at\":\"2011-01-16T19:06:43Z\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]" + "data": "{\"url\":\"https://api.github.com/repos/github/developer.github.com/pages\",\"status\":\"built\",\"cname\":\"developer.github.com\",\"custom_404\":false,\"html_url\":\"https://developer.github.com\",\"source\":{\"branch\":\"master\",\"directory\":\"/\"}}" } ] } @@ -36129,17 +28270,23 @@ "renamed": null }, { - "name": "Get the number of additions and deletions per week", + "name": "Disable a Pages site", "scope": "repos", - "id": "getCodeFrequencyStats", - "method": "GET", - "url": "/repos/{owner}/{repo}/stats/code_frequency", + "id": "disablePagesSite", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/pages", "isDeprecated": false, "isLegacy": false, - "description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.\n\n", - "documentationUrl": "https://developer.github.com/v3/repos/statistics/#get-the-number-of-additions-and-deletions-per-week", - "previews": [], - "headers": [], + "description": "", + "documentationUrl": "https://developer.github.com/v3/repos/pages/#disable-a-pages-site", + "previews": [{ "name": "switcheroo" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.switcheroo-preview+json", + "required": true + } + ], "parameters": [ { "name": "owner", @@ -36168,25 +28315,19 @@ "deprecated": null } ], - "responses": [ - { - "code": 200, - "description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.", - "examples": [{ "data": "[[1302998400,1124,-435]]" }] - } - ], + "responses": [], "renamed": null }, { - "name": "Get the last year of commit activity data", + "name": "Update information about a Pages site", "scope": "repos", - "id": "getCommitActivityStats", - "method": "GET", - "url": "/repos/{owner}/{repo}/stats/commit_activity", + "id": "updateInformationAboutPagesSite", + "method": "PUT", + "url": "/repos/{owner}/{repo}/pages", "isDeprecated": false, "isLegacy": false, - "description": "Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`.\n\n", - "documentationUrl": "https://developer.github.com/v3/repos/statistics/#get-the-last-year-of-commit-activity-data", + "description": "", + "documentationUrl": "https://developer.github.com/v3/repos/pages/#update-information-about-a-pages-site", "previews": [], "headers": [], "parameters": [ @@ -36215,31 +28356,47 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ + }, { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"days\":[0,3,26,20,39,1,0],\"total\":89,\"week\":1336280400}]" - } - ] + "name": "cname", + "description": "Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see \"[Using a custom domain with GitHub Pages](https://help.github.com/articles/using-a-custom-domain-with-github-pages/).\"", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "source", + "description": "Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory `/docs`. Possible values are `\"gh-pages\"`, `\"master\"`, and `\"master /docs\"`.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["\"gh-pages\"", "\"master\"", "\"master /docs\""], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], + "responses": [], "renamed": null }, { - "name": "Get contributors list with additions, deletions, and commit counts", + "name": "Request a page build", "scope": "repos", - "id": "getContributorsStats", - "method": "GET", - "url": "/repos/{owner}/{repo}/stats/contributors", + "id": "requestPageBuild", + "method": "POST", + "url": "/repos/{owner}/{repo}/pages/builds", "isDeprecated": false, "isLegacy": false, - "description": "* `total` - The Total number of commits authored by the contributor.\n\nWeekly Hash (`weeks` array):\n\n* `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time).\n* `a` - Number of additions\n* `d` - Number of deletions\n* `c` - Number of commits\n\n", - "documentationUrl": "https://developer.github.com/v3/repos/statistics/#get-contributors-list-with-additions-deletions-and-commit-counts", + "description": "You can request that your site be built from the latest revision on the default branch. This has the same effect as pushing a commit to your default branch, but does not require an additional commit. Manually triggering page builds can be helpful when diagnosing build warnings and failures.\n\nBuild requests are limited to one concurrent build per repository and one concurrent build per requester. If you request a build while another is still in progress, the second request will be queued until the first completes.", + "documentationUrl": "https://developer.github.com/v3/repos/pages/#request-a-page-build", "previews": [], "headers": [], "parameters": [ @@ -36273,10 +28430,10 @@ "responses": [ { "code": 200, - "description": "* `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time).\n* `a` - Number of additions\n* `d` - Number of deletions\n* `c` - Number of commits", + "description": "response", "examples": [ { - "data": "[{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"total\":135,\"weeks\":[{\"w\":\"1367712000\",\"a\":6898,\"d\":77,\"c\":10}]}]" + "data": "{\"url\":\"https://api.github.com/repos/github/developer.github.com/pages/builds/latest\",\"status\":\"queued\"}" } ] } @@ -36284,15 +28441,15 @@ "renamed": null }, { - "name": "Get the weekly commit count for the repository owner and everyone else", + "name": "List Pages builds", "scope": "repos", - "id": "getParticipationStats", + "id": "listPagesBuilds", "method": "GET", - "url": "/repos/{owner}/{repo}/stats/participation", + "url": "/repos/{owner}/{repo}/pages/builds", "isDeprecated": false, "isLegacy": false, - "description": "Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`.\n\nThe array order is oldest week (index 0) to most recent week.\n\n", - "documentationUrl": "https://developer.github.com/v3/repos/statistics/#get-the-weekly-commit-count-for-the-repository-owner-and-everyone-else", + "description": "", + "documentationUrl": "https://developer.github.com/v3/repos/pages/#list-pages-builds", "previews": [], "headers": [], "parameters": [ @@ -36321,15 +28478,41 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ { "code": 200, - "description": "The array order is oldest week (index 0) to most recent week.", + "description": "response", "examples": [ { - "data": "{\"all\":[11,21,15,2,8,1,8,23,17,21,11,10,33,91,38,34,22,23,32,3,43,87,71,18,13,5,13,16,66,27,12,45,110,117,13,8,18,9,19,26,39,12,20,31,46,91,45,10,24,9,29,7],\"owner\":[3,2,3,0,2,0,5,14,7,9,1,5,0,48,19,2,0,1,10,2,23,40,35,8,8,2,10,6,30,0,2,9,53,104,3,3,10,4,7,11,21,4,4,22,26,63,11,2,14,1,10,3]}" + "data": "[{\"url\":\"https://api.github.com/repos/github/developer.github.com/pages/builds/5472601\",\"status\":\"built\",\"error\":{\"message\":null},\"pusher\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"commit\":\"351391cdcb88ffae71ec3028c91f375a8036a26b\",\"duration\":2104,\"created_at\":\"2014-02-10T19:00:49Z\",\"updated_at\":\"2014-02-10T19:00:51Z\"}]" } ] } @@ -36337,15 +28520,15 @@ "renamed": null }, { - "name": "Get the number of commits per hour in each day", + "name": "Get latest Pages build", "scope": "repos", - "id": "getPunchCardStats", + "id": "getLatestPagesBuild", "method": "GET", - "url": "/repos/{owner}/{repo}/stats/punch_card", + "url": "/repos/{owner}/{repo}/pages/builds/latest", "isDeprecated": false, "isLegacy": false, - "description": "Each array contains the day number, hour number, and number of commits:\n\n* `0-6`: Sunday - Saturday\n* `0-23`: Hour of day\n* Number of commits\n\nFor example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.", - "documentationUrl": "https://developer.github.com/v3/repos/statistics/#get-the-number-of-commits-per-hour-in-each-day", + "description": "", + "documentationUrl": "https://developer.github.com/v3/repos/pages/#get-latest-pages-build", "previews": [], "headers": [], "parameters": [ @@ -36379,22 +28562,26 @@ "responses": [ { "code": 200, - "description": "For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.", - "examples": [{ "data": "[[0,0,5],[0,1,43],[0,2,21]]" }] + "description": "response", + "examples": [ + { + "data": "{\"url\":\"https://api.github.com/repos/github/developer.github.com/pages/builds/5472601\",\"status\":\"built\",\"error\":{\"message\":null},\"pusher\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"commit\":\"351391cdcb88ffae71ec3028c91f375a8036a26b\",\"duration\":2104,\"created_at\":\"2014-02-10T19:00:49Z\",\"updated_at\":\"2014-02-10T19:00:51Z\"}" + } + ] } ], "renamed": null }, { - "name": "Create a status", + "name": "Get a specific Pages build", "scope": "repos", - "id": "createStatus", - "method": "POST", - "url": "/repos/{owner}/{repo}/statuses/{sha}", + "id": "getPagesBuild", + "method": "GET", + "url": "/repos/{owner}/{repo}/pages/builds/{build_id}", "isDeprecated": false, "isLegacy": false, - "description": "Users with push access in a repository can create commit statuses for a given SHA.\n\nNote: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error.", - "documentationUrl": "https://developer.github.com/v3/repos/statuses/#create-a-status", + "description": "", + "documentationUrl": "https://developer.github.com/v3/repos/pages/#get-a-specific-pages-build", "previews": [], "headers": [], "parameters": [ @@ -36425,63 +28612,11 @@ "deprecated": null }, { - "name": "sha", - "description": "sha parameter", + "name": "build_id", + "description": "build_id parameter", "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "state", - "description": "The state of the status. Can be one of `error`, `failure`, `pending`, or `success`.", - "in": "BODY", - "type": "string", + "type": "integer", "required": true, - "enum": ["error", "failure", "pending", "success"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "target_url", - "description": "The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. \nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: \n`http://ci.example.com/user/repo/build/sha`", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "description", - "description": "A short description of the status.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "context", - "description": "A string label to differentiate this status from the status of other systems.", - "in": "BODY", - "type": "string", - "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -36492,11 +28627,11 @@ ], "responses": [ { - "code": 201, + "code": 200, "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"id\":1,\"node_id\":\"MDY6U3RhdHVzMQ==\",\"state\":\"success\",\"description\":\"Build has completed successfully\",\"target_url\":\"https://ci.example.com/1000/output\",\"context\":\"continuous-integration/jenkins\",\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" + "data": "{\"url\":\"https://api.github.com/repos/github/developer.github.com/pages/builds/5472601\",\"status\":\"built\",\"error\":{\"message\":null},\"pusher\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"commit\":\"351391cdcb88ffae71ec3028c91f375a8036a26b\",\"duration\":2104,\"created_at\":\"2014-02-10T19:00:49Z\",\"updated_at\":\"2014-02-10T19:00:51Z\"}" } ] } @@ -36504,17 +28639,23 @@ "renamed": null }, { - "name": "List watchers", - "scope": "activity", - "id": "listWatchersForRepo", + "name": "List repository projects", + "scope": "projects", + "id": "listForRepo", "method": "GET", - "url": "/repos/{owner}/{repo}/subscribers", + "url": "/repos/{owner}/{repo}/projects", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/activity/watching/#list-watchers", - "previews": [], - "headers": [], + "description": "Lists the projects in a repository. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", + "documentationUrl": "https://developer.github.com/v3/projects/#list-repository-projects", + "previews": [{ "name": "inertia" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.inertia-preview+json", + "required": true + } + ], "parameters": [ { "name": "owner", @@ -36542,6 +28683,19 @@ "alias": null, "deprecated": null }, + { + "name": "state", + "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["open", "closed", "all"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "per_page", "description": "Results per page (max 100)", @@ -36575,7 +28729,7 @@ "description": "response", "examples": [ { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" + "data": "[{\"owner_url\":\"https://api.github.com/repos/api-playground/projects-test\",\"url\":\"https://api.github.com/projects/1002604\",\"html_url\":\"https://github.com/api-playground/projects-test/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002604/columns\",\"id\":1002604,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDQ=\",\"name\":\"Projects Documentation\",\"body\":\"Developer documentation project for the developer site.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\"}]" } ] } @@ -36583,70 +28737,23 @@ "renamed": null }, { - "name": "Get a Repository Subscription", - "scope": "activity", - "id": "getRepoSubscription", - "method": "GET", - "url": "/repos/{owner}/{repo}/subscription", + "name": "Create a repository project", + "scope": "projects", + "id": "createForRepo", + "method": "POST", + "url": "/repos/{owner}/{repo}/projects", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/activity/watching/#get-a-repository-subscription", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "owner parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "repo", - "description": "repo parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ + "description": "Creates a repository project board. Returns a `404 Not Found` status if projects are disabled in the repository. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", + "documentationUrl": "https://developer.github.com/v3/projects/#create-a-repository-project", + "previews": [{ "name": "inertia" }], + "headers": [ { - "code": 200, - "description": "Response if you are subscribed to the repository", - "examples": [ - { - "data": "{\"subscribed\":true,\"ignored\":false,\"reason\":null,\"created_at\":\"2012-10-06T21:34:12Z\",\"url\":\"https://api.github.com/repos/octocat/example/subscription\",\"repository_url\":\"https://api.github.com/repos/octocat/example\"}" - } - ] + "name": "accept", + "value": "application/vnd.github.inertia-preview+json", + "required": true } ], - "renamed": null - }, - { - "name": "Set a Repository Subscription", - "scope": "activity", - "id": "setRepoSubscription", - "method": "PUT", - "url": "/repos/{owner}/{repo}/subscription", - "isDeprecated": false, - "isLegacy": false, - "description": "If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://developer.github.com/v3/activity/watching/#delete-a-repository-subscription) completely.", - "documentationUrl": "https://developer.github.com/v3/activity/watching/#set-a-repository-subscription", - "previews": [], - "headers": [], "parameters": [ { "name": "owner", @@ -36675,11 +28782,11 @@ "deprecated": null }, { - "name": "subscribed", - "description": "Determines if notifications should be received from this repository.", + "name": "name", + "description": "The name of the project.", "in": "BODY", - "type": "boolean", - "required": false, + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -36688,10 +28795,10 @@ "deprecated": null }, { - "name": "ignored", - "description": "Determines if all notifications should be blocked from this repository.", + "name": "body", + "description": "The description of the project.", "in": "BODY", - "type": "boolean", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -36703,11 +28810,11 @@ ], "responses": [ { - "code": 200, + "code": 201, "description": "response", "examples": [ { - "data": "{\"subscribed\":true,\"ignored\":false,\"reason\":null,\"created_at\":\"2012-10-06T21:34:12Z\",\"url\":\"https://api.github.com/repos/octocat/example/subscription\",\"repository_url\":\"https://api.github.com/repos/octocat/example\"}" + "data": "{\"owner_url\":\"https://api.github.com/repos/api-playground/projects-test\",\"url\":\"https://api.github.com/projects/1002604\",\"html_url\":\"https://github.com/api-playground/projects-test/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002604/columns\",\"id\":1002604,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDQ=\",\"name\":\"Projects Documentation\",\"body\":\"Developer documentation project for the developer site.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\"}" } ] } @@ -36715,15 +28822,15 @@ "renamed": null }, { - "name": "Delete a Repository Subscription", - "scope": "activity", - "id": "deleteRepoSubscription", - "method": "DELETE", - "url": "/repos/{owner}/{repo}/subscription", + "name": "List pull requests", + "scope": "pulls", + "id": "list", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls", "isDeprecated": false, "isLegacy": false, - "description": "This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://developer.github.com/v3/activity/watching/#set-a-repository-subscription).", - "documentationUrl": "https://developer.github.com/v3/activity/watching/#delete-a-repository-subscription", + "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Pro, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.", + "documentationUrl": "https://developer.github.com/v3/pulls/#list-pull-requests", "previews": [], "headers": [], "parameters": [ @@ -36752,44 +28859,14 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "List tags", - "scope": "repos", - "id": "listTags", - "method": "GET", - "url": "/repos/{owner}/{repo}/tags", - "isDeprecated": false, - "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/repos/#list-tags", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "owner", - "description": "owner parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "state", + "description": "Either `open`, `closed`, or `all` to filter by state.", + "in": "QUERY", "type": "string", - "required": true, - "enum": null, + "required": false, + "enum": ["open", "closed", "all"], "allowNull": false, "mapToData": null, "validation": null, @@ -36797,10 +28874,10 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", + "name": "head", + "description": "Filter pulls by head user or head organization and branch name in the format of `user:ref-name` or `organization:ref-name`. For example: `github:new-script-format` or `octocat:test-branch`.", "in": "QUERY", - "type": "integer", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -36810,10 +28887,10 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", + "name": "base", + "description": "Filter pulls by base branch name. Example: `gh-pages`.", "in": "QUERY", - "type": "integer", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -36821,41 +28898,14 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"name\":\"v0.1\",\"commit\":{\"sha\":\"c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\"},\"zipball_url\":\"https://github.com/octocat/Hello-World/zipball/v0.1\",\"tarball_url\":\"https://github.com/octocat/Hello-World/tarball/v0.1\"}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List teams", - "scope": "repos", - "id": "listTeams", - "method": "GET", - "url": "/repos/{owner}/{repo}/teams", - "isDeprecated": false, - "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/repos/#list-teams", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "owner", - "description": "owner parameter", - "in": "PATH", + "name": "sort", + "description": "What to sort results by. Can be either `created`, `updated`, `popularity` (comment count) or `long-running` (age, filtering by pulls updated in the last month).", + "in": "QUERY", "type": "string", - "required": true, - "enum": null, + "required": false, + "enum": ["created", "updated", "popularity", "long-running"], "allowNull": false, "mapToData": null, "validation": null, @@ -36863,12 +28913,12 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "direction", + "description": "The direction of the sort. Can be either `asc` or `desc`. Default: `desc` when sort is `created` or sort is not specified, otherwise `asc`.", + "in": "QUERY", "type": "string", - "required": true, - "enum": null, + "required": false, + "enum": ["asc", "desc"], "allowNull": false, "mapToData": null, "validation": null, @@ -36908,7 +28958,7 @@ "description": "response", "examples": [ { - "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]" + "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"draft\":false}]" } ] } @@ -36916,19 +28966,17 @@ "renamed": null }, { - "name": "List all topics for a repository", - "scope": "repos", - "id": "listTopics", - "method": "GET", - "url": "/repos/{owner}/{repo}/topics", + "name": "Create a pull request", + "scope": "pulls", + "id": "create", + "method": "POST", + "url": "/repos/{owner}/{repo}/pulls", "isDeprecated": false, "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/repos/#list-all-topics-for-a-repository", - "previews": [{ "name": "mercy" }], - "headers": [ - { "name": "accept", "value": "application/vnd.github.mercy-preview+json" } - ], + "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Pro, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.\n\nYou can create a new pull request.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.", + "documentationUrl": "https://developer.github.com/v3/pulls/#create-a-pull-request", + "previews": [], + "headers": [], "parameters": [ { "name": "owner", @@ -36955,38 +29003,11 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { "data": "{\"names\":[\"octocat\",\"atom\",\"electron\",\"api\"]}" } - ] - } - ], - "renamed": null - }, - { - "name": "Replace all topics for a repository", - "scope": "repos", - "id": "replaceTopics", - "method": "PUT", - "url": "/repos/{owner}/{repo}/topics", - "isDeprecated": false, - "isLegacy": false, - "description": "", - "documentationUrl": "https://developer.github.com/v3/repos/#replace-all-topics-for-a-repository", - "previews": [{ "name": "mercy" }], - "headers": [ - { "name": "accept", "value": "application/vnd.github.mercy-preview+json" } - ], - "parameters": [ + }, { - "name": "owner", - "description": "owner parameter", - "in": "PATH", + "name": "title", + "description": "The title of the new pull request.", + "in": "BODY", "type": "string", "required": true, "enum": null, @@ -36997,9 +29018,9 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "head", + "description": "The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`.", + "in": "BODY", "type": "string", "required": true, "enum": null, @@ -37010,10 +29031,10 @@ "deprecated": null }, { - "name": "names", - "description": "An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters.", + "name": "base", + "description": "The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository.", "in": "BODY", - "type": "string[]", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -37021,38 +29042,13 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { "data": "{\"names\":[\"octocat\",\"atom\",\"electron\",\"api\"]}" } - ] - } - ], - "renamed": null - }, - { - "name": "Clones", - "scope": "repos", - "id": "getClones", - "method": "GET", - "url": "/repos/{owner}/{repo}/traffic/clones", - "isDeprecated": false, - "isLegacy": false, - "description": "Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.", - "documentationUrl": "https://developer.github.com/v3/repos/traffic/#clones", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "owner", - "description": "owner parameter", - "in": "PATH", + "name": "body", + "description": "The contents of the pull request.", + "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -37061,11 +29057,11 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "maintainer_can_modify", + "description": "Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", + "in": "BODY", + "type": "boolean", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -37074,12 +29070,12 @@ "deprecated": null }, { - "name": "per", - "description": "Must be one of: `day`, `week`.", - "in": "QUERY", - "type": "string", + "name": "draft", + "description": "Indicates whether the pull request is a draft. See \"[Draft Pull Requests](https://help.github.com/en/articles/about-pull-requests#draft-pull-requests)\" in the GitHub Help documentation to learn more.", + "in": "BODY", + "type": "boolean", "required": false, - "enum": ["day", "week"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -37089,11 +29085,11 @@ ], "responses": [ { - "code": 200, + "code": 201, "description": "response", "examples": [ { - "data": "{\"count\":173,\"uniques\":128,\"clones\":[{\"timestamp\":\"2016-10-10T00:00:00Z\",\"count\":2,\"uniques\":1},{\"timestamp\":\"2016-10-11T00:00:00Z\",\"count\":17,\"uniques\":16},{\"timestamp\":\"2016-10-12T00:00:00Z\",\"count\":21,\"uniques\":15},{\"timestamp\":\"2016-10-13T00:00:00Z\",\"count\":8,\"uniques\":7},{\"timestamp\":\"2016-10-14T00:00:00Z\",\"count\":5,\"uniques\":5},{\"timestamp\":\"2016-10-15T00:00:00Z\",\"count\":2,\"uniques\":2},{\"timestamp\":\"2016-10-16T00:00:00Z\",\"count\":8,\"uniques\":7},{\"timestamp\":\"2016-10-17T00:00:00Z\",\"count\":26,\"uniques\":15},{\"timestamp\":\"2016-10-18T00:00:00Z\",\"count\":19,\"uniques\":17},{\"timestamp\":\"2016-10-19T00:00:00Z\",\"count\":19,\"uniques\":14},{\"timestamp\":\"2016-10-20T00:00:00Z\",\"count\":19,\"uniques\":15},{\"timestamp\":\"2016-10-21T00:00:00Z\",\"count\":9,\"uniques\":7},{\"timestamp\":\"2016-10-22T00:00:00Z\",\"count\":5,\"uniques\":5},{\"timestamp\":\"2016-10-23T00:00:00Z\",\"count\":6,\"uniques\":5},{\"timestamp\":\"2016-10-24T00:00:00Z\",\"count\":7,\"uniques\":5}]}" + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"draft\":false,\"merged\":false,\"mergeable\":true,\"rebaseable\":true,\"mergeable_state\":\"clean\",\"merged_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"comments\":10,\"review_comments\":0,\"maintainer_can_modify\":true,\"commits\":3,\"additions\":100,\"deletions\":3,\"changed_files\":5}" } ] } @@ -37101,15 +29097,15 @@ "renamed": null }, { - "name": "List paths", - "scope": "repos", - "id": "getTopPaths", + "name": "List comments in a repository", + "scope": "pulls", + "id": "listCommentsForRepo", "method": "GET", - "url": "/repos/{owner}/{repo}/traffic/popular/paths", + "url": "/repos/{owner}/{repo}/pulls/comments", "isDeprecated": false, "isLegacy": false, - "description": "Get the top 10 popular contents over the last 14 days.", - "documentationUrl": "https://developer.github.com/v3/repos/traffic/#list-paths", + "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists review comments for all pull requests in a repository. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://developer.github.com/v3/pulls/comments/#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://developer.github.com/v3/reactions) reactions.\n\n", + "documentationUrl": "https://developer.github.com/v3/pulls/comments/#list-comments-in-a-repository", "previews": [], "headers": [], "parameters": [ @@ -37138,41 +29134,14 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"path\":\"/github/hubot\",\"title\":\"github/hubot: A customizable life embetterment robot.\",\"count\":3542,\"uniques\":2225},{\"path\":\"/github/hubot/blob/master/docs/scripting.md\",\"title\":\"hubot/scripting.md at master · github/hubot · GitHub\",\"count\":1707,\"uniques\":804},{\"path\":\"/github/hubot/tree/master/docs\",\"title\":\"hubot/docs at master · github/hubot · GitHub\",\"count\":685,\"uniques\":435},{\"path\":\"/github/hubot/tree/master/src\",\"title\":\"hubot/src at master · github/hubot · GitHub\",\"count\":577,\"uniques\":347},{\"path\":\"/github/hubot/blob/master/docs/index.md\",\"title\":\"hubot/index.md at master · github/hubot · GitHub\",\"count\":379,\"uniques\":259},{\"path\":\"/github/hubot/blob/master/docs/adapters.md\",\"title\":\"hubot/adapters.md at master · github/hubot · GitHub\",\"count\":354,\"uniques\":201},{\"path\":\"/github/hubot/tree/master/examples\",\"title\":\"hubot/examples at master · github/hubot · GitHub\",\"count\":340,\"uniques\":260},{\"path\":\"/github/hubot/blob/master/docs/deploying/heroku.md\",\"title\":\"hubot/heroku.md at master · github/hubot · GitHub\",\"count\":324,\"uniques\":217},{\"path\":\"/github/hubot/blob/master/src/robot.coffee\",\"title\":\"hubot/robot.coffee at master · github/hubot · GitHub\",\"count\":293,\"uniques\":191},{\"path\":\"/github/hubot/blob/master/LICENSE.md\",\"title\":\"hubot/LICENSE.md at master · github/hubot · GitHub\",\"count\":281,\"uniques\":222}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "List referrers", - "scope": "repos", - "id": "getTopReferrers", - "method": "GET", - "url": "/repos/{owner}/{repo}/traffic/popular/referrers", - "isDeprecated": false, - "isLegacy": false, - "description": "Get the top 10 referrers over the last 14 days.", - "documentationUrl": "https://developer.github.com/v3/repos/traffic/#list-referrers", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "owner", - "description": "owner parameter", - "in": "PATH", + "name": "sort", + "description": "Can be either `created` or `updated` comments.", + "in": "QUERY", "type": "string", - "required": true, - "enum": null, + "required": false, + "enum": ["created", "updated"], "allowNull": false, "mapToData": null, "validation": null, @@ -37180,51 +29149,24 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "direction", + "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.", + "in": "QUERY", "type": "string", - "required": true, - "enum": null, + "required": false, + "enum": ["asc", "desc"], "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"referrer\":\"Google\",\"count\":4,\"uniques\":3},{\"referrer\":\"stackoverflow.com\",\"count\":2,\"uniques\":2},{\"referrer\":\"eggsonbread.com\",\"count\":1,\"uniques\":1},{\"referrer\":\"yandex.ru\",\"count\":1,\"uniques\":1}]" - } - ] - } - ], - "renamed": null - }, - { - "name": "Views", - "scope": "repos", - "id": "getViews", - "method": "GET", - "url": "/repos/{owner}/{repo}/traffic/views", - "isDeprecated": false, - "isLegacy": false, - "description": "Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.", - "documentationUrl": "https://developer.github.com/v3/repos/traffic/#views", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "owner", - "description": "owner parameter", - "in": "PATH", + "name": "since", + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only returns comments `updated` at or after this time.", + "in": "QUERY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -37233,11 +29175,11 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -37246,12 +29188,12 @@ "deprecated": null }, { - "name": "per", - "description": "Must be one of: `day`, `week`.", + "name": "page", + "description": "Page number of the results to fetch.", "in": "QUERY", - "type": "string", + "type": "integer", "required": false, - "enum": ["day", "week"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -37265,7 +29207,7 @@ "description": "response", "examples": [ { - "data": "{\"count\":14850,\"uniques\":3782,\"views\":[{\"timestamp\":\"2016-10-10T00:00:00Z\",\"count\":440,\"uniques\":143},{\"timestamp\":\"2016-10-11T00:00:00Z\",\"count\":1308,\"uniques\":414},{\"timestamp\":\"2016-10-12T00:00:00Z\",\"count\":1486,\"uniques\":452},{\"timestamp\":\"2016-10-13T00:00:00Z\",\"count\":1170,\"uniques\":401},{\"timestamp\":\"2016-10-14T00:00:00Z\",\"count\":868,\"uniques\":266},{\"timestamp\":\"2016-10-15T00:00:00Z\",\"count\":495,\"uniques\":157},{\"timestamp\":\"2016-10-16T00:00:00Z\",\"count\":524,\"uniques\":175},{\"timestamp\":\"2016-10-17T00:00:00Z\",\"count\":1263,\"uniques\":412},{\"timestamp\":\"2016-10-18T00:00:00Z\",\"count\":1402,\"uniques\":417},{\"timestamp\":\"2016-10-19T00:00:00Z\",\"count\":1394,\"uniques\":424},{\"timestamp\":\"2016-10-20T00:00:00Z\",\"count\":1492,\"uniques\":448},{\"timestamp\":\"2016-10-21T00:00:00Z\",\"count\":1153,\"uniques\":332},{\"timestamp\":\"2016-10-22T00:00:00Z\",\"count\":566,\"uniques\":168},{\"timestamp\":\"2016-10-23T00:00:00Z\",\"count\":675,\"uniques\":184},{\"timestamp\":\"2016-10-24T00:00:00Z\",\"count\":614,\"uniques\":237}]}" + "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\"id\":10,\"node_id\":\"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\"pull_request_review_id\":42,\"diff_hunk\":\"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\"path\":\"file1.txt\",\"position\":1,\"original_position\":4,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"original_commit_id\":\"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\"in_reply_to_id\":8,\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Great stuff!\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"author_association\":\"NONE\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\"}},\"start_line\":1,\"original_start_line\":1,\"start_side\":\"RIGHT\",\"line\":2,\"original_line\":2,\"side\":\"RIGHT\"}]" } ] } @@ -37273,15 +29215,15 @@ "renamed": null }, { - "name": "Transfer a repository", - "scope": "repos", - "id": "transfer", - "method": "POST", - "url": "/repos/{owner}/{repo}/transfer", + "name": "Get a single comment", + "scope": "pulls", + "id": "getComment", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", "isDeprecated": false, "isLegacy": false, - "description": "A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://help.github.com/articles/about-repository-transfers/).", - "documentationUrl": "https://developer.github.com/v3/repos/#transfer-a-repository", + "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nProvides details for a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://developer.github.com/v3/pulls/comments/#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://developer.github.com/v3/reactions) reactions.\n\n", + "documentationUrl": "https://developer.github.com/v3/pulls/comments/#get-a-single-comment", "previews": [], "headers": [], "parameters": [ @@ -37312,24 +29254,11 @@ "deprecated": null }, { - "name": "new_owner", - "description": "**Required:** The username or organization name the repository will be transferred to.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "team_ids", - "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.", - "in": "BODY", - "type": "integer[]", - "required": false, + "name": "comment_id", + "description": "comment_id parameter", + "in": "PATH", + "type": "integer", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -37340,11 +29269,11 @@ ], "responses": [ { - "code": 202, + "code": 200, "description": "response", "examples": [ { - "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}" + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\"id\":10,\"node_id\":\"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\"pull_request_review_id\":42,\"diff_hunk\":\"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\"path\":\"file1.txt\",\"position\":1,\"original_position\":4,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"original_commit_id\":\"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\"in_reply_to_id\":8,\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Great stuff!\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"author_association\":\"NONE\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\"}},\"start_line\":1,\"original_start_line\":1,\"start_side\":\"RIGHT\",\"line\":2,\"original_line\":2,\"side\":\"RIGHT\"}" } ] } @@ -37352,22 +29281,17 @@ "renamed": null }, { - "name": "Check if vulnerability alerts are enabled for a repository", - "scope": "repos", - "id": "checkVulnerabilityAlerts", - "method": "GET", - "url": "/repos/{owner}/{repo}/vulnerability-alerts", + "name": "Edit a comment", + "scope": "pulls", + "id": "updateComment", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", "isDeprecated": false, "isLegacy": false, - "description": "Shows whether vulnerability alerts are enabled or disabled for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)\" in the GitHub Help documentation.", - "documentationUrl": "https://developer.github.com/v3/repos/#check-if-vulnerability-alerts-are-enabled-for-a-repository", - "previews": [{ "name": "dorian" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.dorian-preview+json" - } - ], + "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nEnables you to edit a review comment.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://developer.github.com/v3/pulls/comments/#parameters-2) table.", + "documentationUrl": "https://developer.github.com/v3/pulls/comments/#edit-a-comment", + "previews": [], + "headers": [], "parameters": [ { "name": "owner", @@ -37394,34 +29318,12 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "Enable vulnerability alerts", - "scope": "repos", - "id": "enableVulnerabilityAlerts", - "method": "PUT", - "url": "/repos/{owner}/{repo}/vulnerability-alerts", - "isDeprecated": false, - "isLegacy": false, - "description": "Enables vulnerability alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)\" in the GitHub Help documentation.", - "documentationUrl": "https://developer.github.com/v3/repos/#enable-vulnerability-alerts", - "previews": [{ "name": "dorian" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.dorian-preview+json" - } - ], - "parameters": [ + }, { - "name": "owner", - "description": "owner parameter", + "name": "comment_id", + "description": "comment_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -37431,9 +29333,9 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "body", + "description": "The text of the reply to the review comment.", + "in": "BODY", "type": "string", "required": true, "enum": null, @@ -37444,26 +29346,31 @@ "deprecated": null } ], - "responses": [], + "responses": [ + { + "code": 200, + "description": "response", + "examples": [ + { + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\"id\":10,\"node_id\":\"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\"pull_request_review_id\":42,\"diff_hunk\":\"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\"path\":\"file1.txt\",\"position\":1,\"original_position\":4,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"original_commit_id\":\"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\"in_reply_to_id\":8,\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Great stuff!\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"author_association\":\"NONE\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\"}},\"start_line\":1,\"original_start_line\":1,\"start_side\":\"RIGHT\",\"line\":2,\"original_line\":2,\"side\":\"RIGHT\"}" + } + ] + } + ], "renamed": null }, { - "name": "Disable vulnerability alerts", - "scope": "repos", - "id": "disableVulnerabilityAlerts", + "name": "Delete a comment", + "scope": "pulls", + "id": "deleteComment", "method": "DELETE", - "url": "/repos/{owner}/{repo}/vulnerability-alerts", + "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}", "isDeprecated": false, "isLegacy": false, - "description": "Disables vulnerability alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)\" in the GitHub Help documentation.", - "documentationUrl": "https://developer.github.com/v3/repos/#disable-vulnerability-alerts", - "previews": [{ "name": "dorian" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.dorian-preview+json" - } - ], + "description": "Deletes a review comment.", + "documentationUrl": "https://developer.github.com/v3/pulls/comments/#delete-a-comment", + "previews": [], + "headers": [], "parameters": [ { "name": "owner", @@ -37479,10 +29386,23 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", + "name": "repo", + "description": "repo parameter", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "comment_id", + "description": "comment_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -37496,17 +29416,23 @@ "renamed": null }, { - "name": "Get archive link", - "scope": "repos", - "id": "getArchiveLink", + "name": "List reactions for a pull request review comment", + "scope": "reactions", + "id": "listForPullRequestReviewComment", "method": "GET", - "url": "/repos/{owner}/{repo}/{archive_format}/{ref}", + "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", "isDeprecated": false, "isLegacy": false, - "description": "Gets a redirect URL to download an archive for a repository. The `:archive_format` can be either `tarball` or `zipball`. The `:ref` must be a valid Git reference. If you omit `:ref`, the repository’s default branch (usually `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use the `Location` header to make a second `GET` request.\n\n_Note_: For private repositories, these links are temporary and expire after five minutes.\n\nTo follow redirects with curl, use the `-L` switch:\n\n", - "documentationUrl": "https://developer.github.com/v3/repos/contents/#get-archive-link", - "previews": [], - "headers": [], + "description": "List the reactions to a [pull request review comment](https://developer.github.com/v3/pulls/comments/).", + "documentationUrl": "https://developer.github.com/v3/reactions/#list-reactions-for-a-pull-request-review-comment", + "previews": [{ "name": "squirrel-girl" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.squirrel-girl-preview+json", + "required": true + } + ], "parameters": [ { "name": "owner", @@ -37535,10 +29461,10 @@ "deprecated": null }, { - "name": "archive_format", - "description": "archive_format parameter", + "name": "comment_id", + "description": "comment_id parameter", "in": "PATH", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -37548,11 +29474,46 @@ "deprecated": null }, { - "name": "ref", - "description": "ref parameter", - "in": "PATH", + "name": "content", + "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a pull request review comment.", + "in": "QUERY", "type": "string", - "required": true, + "required": false, + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -37561,30 +29522,41 @@ "deprecated": null } ], - "responses": [], + "responses": [ + { + "code": 200, + "description": "response", + "examples": [ + { + "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" + } + ] + } + ], "renamed": null }, { - "name": "Create repository using a repository template", - "scope": "repos", - "id": "createUsingTemplate", + "name": "Create reaction for a pull request review comment", + "scope": "reactions", + "id": "createForPullRequestReviewComment", "method": "POST", - "url": "/repos/{template_owner}/{template_repo}/generate", + "url": "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", "isDeprecated": false, "isLegacy": false, - "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [`GET /repos/:owner/:repo`](https://developer.github.com/v3/repos/#get) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository\n\n\\`", - "documentationUrl": "https://developer.github.com/v3/repos/#create-repository-using-a-repository-template", - "previews": [{ "name": "baptiste" }], + "description": "Create a reaction to a [pull request review comment](https://developer.github.com/v3/pulls/comments/). A response with a `Status: 200 OK` means that you already added the reaction type to this pull request review comment.", + "documentationUrl": "https://developer.github.com/v3/reactions/#create-reaction-for-a-pull-request-review-comment", + "previews": [{ "name": "squirrel-girl" }], "headers": [ { "name": "accept", - "value": "application/vnd.github.baptiste-preview+json" + "value": "application/vnd.github.squirrel-girl-preview+json", + "required": true } ], "parameters": [ { - "name": "template_owner", - "description": "template_owner parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", "type": "string", "required": true, @@ -37596,8 +29568,8 @@ "deprecated": null }, { - "name": "template_repo", - "description": "template_repo parameter", + "name": "repo", + "description": "repo parameter", "in": "PATH", "type": "string", "required": true, @@ -37609,23 +29581,10 @@ "deprecated": null }, { - "name": "owner", - "description": "The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.", - "in": "BODY", - "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "name", - "description": "The name of the new repository.", - "in": "BODY", - "type": "string", + "name": "comment_id", + "description": "comment_id parameter", + "in": "PATH", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -37635,25 +29594,21 @@ "deprecated": null }, { - "name": "description", - "description": "A short description of the new repository.", + "name": "content", + "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the pull request review comment.", "in": "BODY", "type": "string", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "private", - "description": "Either `true` to create a new private repository or `false` to create a new public one.", - "in": "BODY", - "type": "boolean", - "required": false, - "enum": null, + "required": true, + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], "allowNull": false, "mapToData": null, "validation": null, @@ -37667,7 +29622,7 @@ "description": "response", "examples": [ { - "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}" + "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" } ] } @@ -37675,24 +29630,24 @@ "renamed": null }, { - "name": "List all public repositories", - "scope": "repos", - "id": "listPublic", + "name": "Get a single pull request", + "scope": "pulls", + "id": "get", "method": "GET", - "url": "/repositories", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}", "isDeprecated": false, "isLegacy": false, - "description": "Lists all public repositories in the order that they were created.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://developer.github.com/v3/#link-header) to get the URL for the next page of repositories.", - "documentationUrl": "https://developer.github.com/v3/repos/#list-all-public-repositories", + "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Pro, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nLists details of a pull request by providing its number.\n\nWhen you get, [create](https://developer.github.com/v3/pulls/#create-a-pull-request), or [edit](https://developer.github.com/v3/pulls/#update-a-pull-request) a pull request, GitHub creates a merge commit to test whether the pull request can be automatically merged into the base branch. This test commit is not added to the base branch or the head branch. You can review the status of the test commit using the `mergeable` key. For more information, see \"[Checking mergeability of pull requests](https://developer.github.com/v3/git/#checking-mergeability-of-pull-requests)\".\n\nThe value of the `mergeable` attribute can be `true`, `false`, or `null`. If the value is `null`, then GitHub has started a background job to compute the mergeability. After giving the job time to complete, resubmit the request. When the job finishes, you will see a non-`null` value for the `mergeable` attribute in the response. If `mergeable` is `true`, then `merge_commit_sha` will be the SHA of the _test_ merge commit.\n\nThe value of the `merge_commit_sha` attribute changes depending on the state of the pull request. Before merging a pull request, the `merge_commit_sha` attribute holds the SHA of the _test_ merge commit. After merging a pull request, the `merge_commit_sha` attribute changes depending on how you merged the pull request:\n\n* If merged as a [merge commit](https://help.github.com/articles/about-merge-methods-on-github/), `merge_commit_sha` represents the SHA of the merge commit.\n* If merged via a [squash](https://help.github.com/articles/about-merge-methods-on-github/#squashing-your-merge-commits), `merge_commit_sha` represents the SHA of the squashed commit on the base branch.\n* If [rebased](https://help.github.com/articles/about-merge-methods-on-github/#rebasing-and-merging-your-commits), `merge_commit_sha` represents the commit that the base branch was updated to.\n\nPass the appropriate [media type](https://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.", + "documentationUrl": "https://developer.github.com/v3/pulls/#get-a-single-pull-request", "previews": [], "headers": [], "parameters": [ { - "name": "since", - "description": "The integer ID of the last repository that you've seen.", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "owner", + "description": "owner parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -37701,11 +29656,11 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "repo", + "description": "repo parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -37714,11 +29669,11 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", + "name": "pull_number", + "description": "pull_number parameter", + "in": "PATH", "type": "integer", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -37730,10 +29685,10 @@ "responses": [ { "code": 200, - "description": "response", + "description": "Pass the appropriate [media type](https://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.", "examples": [ { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\"}]" + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"draft\":false,\"merged\":false,\"mergeable\":true,\"rebaseable\":true,\"mergeable_state\":\"clean\",\"merged_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"comments\":10,\"review_comments\":0,\"maintainer_can_modify\":true,\"commits\":3,\"additions\":100,\"deletions\":3,\"changed_files\":5}" } ] } @@ -37741,22 +29696,22 @@ "renamed": null }, { - "name": "Search code", - "scope": "search", - "id": "code", - "method": "GET", - "url": "/search/code", + "name": "Update a pull request", + "scope": "pulls", + "id": "update", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}", "isDeprecated": false, "isLegacy": false, - "description": "Find file contents via various criteria. This method returns up to 100 results [per page](https://developer.github.com/v3/#pagination).\n\nWhen searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://developer.github.com/v3/search/#text-match-metadata).\n\n**Note:** You must [authenticate](https://developer.github.com/v3/#authentication) to search for code across all public repositories.\n\n**Considerations for code search**\n\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:\n\n* Only the _default branch_ is considered. In most cases, this will be the `master` branch.\n* Only files smaller than 384 KB are searchable.\n* You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.\n\nSuppose you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery). Your query would look something like this:\n\nHere, we're searching for the keyword `addClass` within a file's contents. We're making sure that we're only looking in files where the language is JavaScript. And we're scoping the search to the `repo:jquery/jquery` repository.", - "documentationUrl": "https://developer.github.com/v3/search/#search-code", + "description": "Draft pull requests are available in public repositories with GitHub Free and GitHub Pro, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.", + "documentationUrl": "https://developer.github.com/v3/pulls/#update-a-pull-request", "previews": [], "headers": [], "parameters": [ { - "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See \"[Searching code](https://help.github.com/articles/searching-code/)\" for a detailed list of qualifiers.", - "in": "QUERY", + "name": "owner", + "description": "owner parameter", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -37767,12 +29722,38 @@ "deprecated": null }, { - "name": "sort", - "description": "Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", - "in": "QUERY", + "name": "repo", + "description": "repo parameter", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "pull_number", + "description": "pull_number parameter", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "title", + "description": "The title of the pull request.", + "in": "BODY", "type": "string", "required": false, - "enum": ["indexed"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -37780,12 +29761,12 @@ "deprecated": null }, { - "name": "order", - "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", - "in": "QUERY", + "name": "body", + "description": "The contents of the pull request.", + "in": "BODY", "type": "string", "required": false, - "enum": ["desc", "asc"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -37793,10 +29774,23 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", + "name": "state", + "description": "State of this Pull Request. Either `open` or `closed`.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["open", "closed"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "base", + "description": "The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.", + "in": "BODY", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -37806,10 +29800,10 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", + "name": "maintainer_can_modify", + "description": "Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.", + "in": "BODY", + "type": "boolean", "required": false, "enum": null, "allowNull": false, @@ -37825,7 +29819,7 @@ "description": "response", "examples": [ { - "data": "{\"total_count\":7,\"incomplete_results\":false,\"items\":[{\"name\":\"classes.js\",\"path\":\"src/attributes/classes.js\",\"sha\":\"d7212f9dee2dcc18f084d7df8f417b80846ded5a\",\"url\":\"https://api.github.com/repositories/167174/contents/src/attributes/classes.js?ref=825ac3773694e0cd23ee74895fd5aeb535b27da4\",\"git_url\":\"https://api.github.com/repositories/167174/git/blobs/d7212f9dee2dcc18f084d7df8f417b80846ded5a\",\"html_url\":\"https://github.com/jquery/jquery/blob/825ac3773694e0cd23ee74895fd5aeb535b27da4/src/attributes/classes.js\",\"repository\":{\"id\":167174,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxNjcxNzQ=\",\"name\":\"jquery\",\"full_name\":\"jquery/jquery\",\"owner\":{\"login\":\"jquery\",\"id\":70142,\"node_id\":\"MDQ6VXNlcjcwMTQy\",\"avatar_url\":\"https://0.gravatar.com/avatar/6906f317a4733f4379b06c32229ef02f?d=https%3A%2F%2Fidenticons.github.com%2Ff426f04f2f9813718fb806b30e0093de.png\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/jquery\",\"html_url\":\"https://github.com/jquery\",\"followers_url\":\"https://api.github.com/users/jquery/followers\",\"following_url\":\"https://api.github.com/users/jquery/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/jquery/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/jquery/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/jquery/subscriptions\",\"organizations_url\":\"https://api.github.com/users/jquery/orgs\",\"repos_url\":\"https://api.github.com/users/jquery/repos\",\"events_url\":\"https://api.github.com/users/jquery/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/jquery/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/jquery/jquery\",\"description\":\"jQuery JavaScript Library\",\"fork\":false,\"url\":\"https://api.github.com/repos/jquery/jquery\",\"forks_url\":\"https://api.github.com/repos/jquery/jquery/forks\",\"keys_url\":\"https://api.github.com/repos/jquery/jquery/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/jquery/jquery/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/jquery/jquery/teams\",\"hooks_url\":\"https://api.github.com/repos/jquery/jquery/hooks\",\"issue_events_url\":\"https://api.github.com/repos/jquery/jquery/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/jquery/jquery/events\",\"assignees_url\":\"https://api.github.com/repos/jquery/jquery/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/jquery/jquery/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/jquery/jquery/tags\",\"blobs_url\":\"https://api.github.com/repos/jquery/jquery/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/jquery/jquery/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/jquery/jquery/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/jquery/jquery/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/jquery/jquery/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/jquery/jquery/languages\",\"stargazers_url\":\"https://api.github.com/repos/jquery/jquery/stargazers\",\"contributors_url\":\"https://api.github.com/repos/jquery/jquery/contributors\",\"subscribers_url\":\"https://api.github.com/repos/jquery/jquery/subscribers\",\"subscription_url\":\"https://api.github.com/repos/jquery/jquery/subscription\",\"commits_url\":\"https://api.github.com/repos/jquery/jquery/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/jquery/jquery/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/jquery/jquery/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/jquery/jquery/issues/comments/{number}\",\"contents_url\":\"https://api.github.com/repos/jquery/jquery/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/jquery/jquery/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/jquery/jquery/merges\",\"archive_url\":\"https://api.github.com/repos/jquery/jquery/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/jquery/jquery/downloads\",\"issues_url\":\"https://api.github.com/repos/jquery/jquery/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/jquery/jquery/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/jquery/jquery/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/jquery/jquery/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/jquery/jquery/labels{/name}\"},\"score\":0.5269679}]}" + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"draft\":false,\"merged\":false,\"mergeable\":true,\"rebaseable\":true,\"mergeable_state\":\"clean\",\"merged_by\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"comments\":10,\"review_comments\":0,\"maintainer_can_modify\":true,\"commits\":3,\"additions\":100,\"deletions\":3,\"changed_files\":5}" } ] } @@ -37833,24 +29827,35 @@ "renamed": null }, { - "name": "Search commits", - "scope": "search", - "id": "commits", + "name": "List comments on a pull request", + "scope": "pulls", + "id": "listComments", "method": "GET", - "url": "/search/commits", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", "isDeprecated": false, "isLegacy": false, - "description": "Find commits via various criteria. This method returns up to 100 results [per page](https://developer.github.com/v3/#pagination).\n\nWhen searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://developer.github.com/v3/search/#text-match-metadata).\n\n**Considerations for commit search**\n\nOnly the _default branch_ is considered. In most cases, this will be the `master` branch.\n\nSuppose you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this:", - "documentationUrl": "https://developer.github.com/v3/search/#search-commits", - "previews": [{ "name": "cloak" }], - "headers": [ - { "name": "accept", "value": "application/vnd.github.cloak-preview+json" } - ], + "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nLists review comments for a pull request. By default, review comments are in ascending order by ID.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://developer.github.com/v3/pulls/comments/#parameters-2) table.\n\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://developer.github.com/v3/reactions) reactions.\n\n", + "documentationUrl": "https://developer.github.com/v3/pulls/comments/#list-comments-on-a-pull-request", + "previews": [], + "headers": [], "parameters": [ { - "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See \"[Searching commits](https://help.github.com/articles/searching-commits/)\" for a detailed list of qualifiers.", - "in": "QUERY", + "name": "owner", + "description": "owner parameter", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "repo parameter", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -37860,13 +29865,26 @@ "alias": null, "deprecated": null }, + { + "name": "pull_number", + "description": "pull_number parameter", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "sort", - "description": "Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", + "description": "Can be either `created` or `updated` comments.", "in": "QUERY", "type": "string", "required": false, - "enum": ["author-date", "committer-date"], + "enum": ["created", "updated"], "allowNull": false, "mapToData": null, "validation": null, @@ -37874,12 +29892,25 @@ "deprecated": null }, { - "name": "order", - "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", + "name": "direction", + "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter.", "in": "QUERY", "type": "string", "required": false, - "enum": ["desc", "asc"], + "enum": ["asc", "desc"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "since", + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only returns comments `updated` at or after this time.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -37919,7 +29950,7 @@ "description": "response", "examples": [ { - "data": "{\"total_count\":1,\"incomplete_results\":false,\"items\":[{\"url\":\"https://api.github.com/repos/octocat/Spoon-Knife/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f\",\"sha\":\"bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f\",\"html_url\":\"https://github.com/octocat/Spoon-Knife/commit/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f\",\"comments_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f\",\"author\":{\"date\":\"2014-02-04T14:38:36-08:00\",\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"},\"committer\":{\"date\":\"2014-02-12T15:18:55-08:00\",\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"},\"message\":\"Create styles.css and updated README\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/trees/a639e96f9038797fba6e0469f94a4b0cc459fa68\",\"sha\":\"a639e96f9038797fba6e0469f94a4b0cc459fa68\"},\"comment_count\":8},\"author\":{\"login\":\"octocat\",\"id\":583231,\"node_id\":\"MDQ6VXNlcjU4MzIzMQ==\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=3\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"committer\":{\"login\":\"octocat\",\"id\":583231,\"node_id\":\"MDQ6VXNlcjU4MzIzMQ==\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=3\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Spoon-Knife/commits/a30c19e3f13765a3b48829788bc1cb8b4e95cee4\",\"html_url\":\"https://github.com/octocat/Spoon-Knife/commit/a30c19e3f13765a3b48829788bc1cb8b4e95cee4\",\"sha\":\"a30c19e3f13765a3b48829788bc1cb8b4e95cee4\"}],\"repository\":{\"id\":1300192,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMzAwMTky\",\"name\":\"Spoon-Knife\",\"full_name\":\"octocat/Spoon-Knife\",\"owner\":{\"login\":\"octocat\",\"id\":583231,\"node_id\":\"MDQ6VXNlcjU4MzIzMQ==\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=3\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Spoon-Knife\",\"description\":\"This repo is for demonstration purposes only.\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Spoon-Knife\",\"forks_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/forks\",\"keys_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/teams\",\"hooks_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/events\",\"assignees_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/tags\",\"blobs_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/languages\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/subscription\",\"commits_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/merges\",\"archive_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/downloads\",\"issues_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/deployments\"},\"score\":4.9971514}]}" + "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\"id\":10,\"node_id\":\"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\"pull_request_review_id\":42,\"diff_hunk\":\"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\"path\":\"file1.txt\",\"position\":1,\"original_position\":4,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"original_commit_id\":\"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\"in_reply_to_id\":8,\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Great stuff!\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"author_association\":\"NONE\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\"}},\"start_line\":1,\"original_start_line\":1,\"start_side\":\"RIGHT\",\"line\":2,\"original_line\":2,\"side\":\"RIGHT\"}]" } ] } @@ -37927,22 +29958,22 @@ "renamed": null }, { - "name": "Search issues and pull requests", - "scope": "search", - "id": "issuesAndPullRequests", - "method": "GET", - "url": "/search/issues", + "name": "Create a comment", + "scope": "pulls", + "id": "createComment", + "method": "POST", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments", "isDeprecated": false, "isLegacy": false, - "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://developer.github.com/v3/#pagination).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://developer.github.com/v3/search/#text-match-metadata).\n\nLet's say you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\nIn this query, we're searching for the keyword `windows`, within any open issue that's labeled as `bug`. The search runs across repositories whose primary language is Python. We’re sorting by creation date in ascending order, so that the oldest issues appear first in the search results.", - "documentationUrl": "https://developer.github.com/v3/search/#search-issues-and-pull-requests", + "description": "**Note:** Multi-line comments on pull requests are currently in public beta and subject to change.\n\nCreates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see \"[Comments](https://developer.github.com/v3/issues/comments/#create-a-comment).\" We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff.\n\nYou can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see [Multi-line comment summary](https://developer.github.com/v3/pulls/comments/#multi-line-comment-summary-3).\n\n**Note:** The position value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.\n\n**Multi-line comment summary**\n\n**Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details.\n\nUse the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response.\n\nIf you use the `comfort-fade` preview header, your response will show:\n\n* For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`.\n* For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`.\n\nIf you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show:\n\n* For multi-line comments, the last line of the comment range for the `position` attribute.\n* For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://developer.github.com/v3/pulls/comments/#parameters-2) table.", + "documentationUrl": "https://developer.github.com/v3/pulls/comments/#create-a-comment", "previews": [], "headers": [], "parameters": [ { - "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See \"[Searching issues and pull requests](https://help.github.com/articles/searching-issues-and-pull-requests/)\" for a detailed list of qualifiers.", - "in": "QUERY", + "name": "owner", + "description": "owner parameter", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -37953,24 +29984,12 @@ "deprecated": null }, { - "name": "sort", - "description": "Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", - "in": "QUERY", + "name": "repo", + "description": "repo parameter", + "in": "PATH", "type": "string", - "required": false, - "enum": [ - "comments", - "reactions", - "reactions-+1", - "reactions--1", - "reactions-smile", - "reactions-thinking_face", - "reactions-heart", - "reactions-tada", - "interactions", - "created", - "updated" - ], + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -37978,12 +29997,12 @@ "deprecated": null }, { - "name": "order", - "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["desc", "asc"], + "name": "pull_number", + "description": "pull_number parameter", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -37991,11 +30010,11 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "body", + "description": "The text of the review comment.", + "in": "BODY", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -38004,49 +30023,22 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "commit_id", + "description": "The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`.", + "in": "BODY", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"total_count\":280,\"incomplete_results\":false,\"items\":[{\"url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132\",\"repository_url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit\",\"labels_url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/comments\",\"events_url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/events\",\"html_url\":\"https://github.com/batterseapower/pinyin-toolkit/issues/132\",\"id\":35802,\"node_id\":\"MDU6SXNzdWUzNTgwMg==\",\"number\":132,\"title\":\"Line Number Indexes Beyond 20 Not Displayed\",\"user\":{\"login\":\"Nick3C\",\"id\":90254,\"node_id\":\"MDQ6VXNlcjkwMjU0\",\"avatar_url\":\"https://secure.gravatar.com/avatar/934442aadfe3b2f4630510de416c5718?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/Nick3C\",\"html_url\":\"https://github.com/Nick3C\",\"followers_url\":\"https://api.github.com/users/Nick3C/followers\",\"following_url\":\"https://api.github.com/users/Nick3C/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/Nick3C/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/Nick3C/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/Nick3C/subscriptions\",\"organizations_url\":\"https://api.github.com/users/Nick3C/orgs\",\"repos_url\":\"https://api.github.com/users/Nick3C/repos\",\"events_url\":\"https://api.github.com/users/Nick3C/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/Nick3C/received_events\",\"type\":\"User\"},\"labels\":[{\"id\":4,\"node_id\":\"MDU6TGFiZWw0\",\"url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/labels/bug\",\"name\":\"bug\",\"color\":\"ff0000\"}],\"state\":\"open\",\"assignee\":null,\"milestone\":null,\"comments\":15,\"created_at\":\"2009-07-12T20:10:41Z\",\"updated_at\":\"2009-07-19T09:23:43Z\",\"closed_at\":null,\"pull_request\":{\"html_url\":null,\"diff_url\":null,\"patch_url\":null},\"body\":\"...\",\"score\":1.3859273}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Search issues and pull requests", - "scope": "search", - "id": "issues", - "method": "GET", - "url": "/search/issues", - "isDeprecated": false, - "isLegacy": false, - "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://developer.github.com/v3/#pagination).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://developer.github.com/v3/search/#text-match-metadata).\n\nLet's say you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\nIn this query, we're searching for the keyword `windows`, within any open issue that's labeled as `bug`. The search runs across repositories whose primary language is Python. We’re sorting by creation date in ascending order, so that the oldest issues appear first in the search results.", - "documentationUrl": "https://developer.github.com/v3/search/#search-issues-and-pull-requests", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See \"[Searching issues and pull requests](https://help.github.com/articles/searching-issues-and-pull-requests/)\" for a detailed list of qualifiers.", - "in": "QUERY", + "name": "path", + "description": "The relative path to the file that necessitates a comment.", + "in": "BODY", "type": "string", "required": true, "enum": null, @@ -38057,24 +30049,25 @@ "deprecated": null }, { - "name": "sort", - "description": "Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", - "in": "QUERY", - "type": "string", + "name": "position", + "description": "**Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above.", + "in": "BODY", + "type": "integer", "required": false, - "enum": [ - "comments", - "reactions", - "reactions-+1", - "reactions--1", - "reactions-smile", - "reactions-thinking_face", - "reactions-heart", - "reactions-tada", - "interactions", - "created", - "updated" - ], + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "side", + "description": "**Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see \"[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)\" in the GitHub Help documentation.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["LEFT", "RIGHT"], "allowNull": false, "mapToData": null, "validation": null, @@ -38082,12 +30075,12 @@ "deprecated": null }, { - "name": "order", - "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", - "in": "QUERY", - "type": "string", + "name": "line", + "description": "**Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to.", + "in": "BODY", + "type": "integer", "required": false, - "enum": ["desc", "asc"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -38095,9 +30088,9 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", + "name": "start_line", + "description": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation.", + "in": "BODY", "type": "integer", "required": false, "enum": null, @@ -38108,12 +30101,12 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", + "name": "start_side", + "description": "**Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see \"[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)\" in the GitHub Help documentation. See `side` in this table for additional context.", + "in": "BODY", + "type": "string", "required": false, - "enum": null, + "enum": ["LEFT", "RIGHT", "side"], "allowNull": false, "mapToData": null, "validation": null, @@ -38123,40 +30116,35 @@ ], "responses": [ { - "code": 200, + "code": 201, "description": "response", "examples": [ { - "data": "{\"total_count\":280,\"incomplete_results\":false,\"items\":[{\"url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132\",\"repository_url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit\",\"labels_url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/comments\",\"events_url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/events\",\"html_url\":\"https://github.com/batterseapower/pinyin-toolkit/issues/132\",\"id\":35802,\"node_id\":\"MDU6SXNzdWUzNTgwMg==\",\"number\":132,\"title\":\"Line Number Indexes Beyond 20 Not Displayed\",\"user\":{\"login\":\"Nick3C\",\"id\":90254,\"node_id\":\"MDQ6VXNlcjkwMjU0\",\"avatar_url\":\"https://secure.gravatar.com/avatar/934442aadfe3b2f4630510de416c5718?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/Nick3C\",\"html_url\":\"https://github.com/Nick3C\",\"followers_url\":\"https://api.github.com/users/Nick3C/followers\",\"following_url\":\"https://api.github.com/users/Nick3C/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/Nick3C/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/Nick3C/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/Nick3C/subscriptions\",\"organizations_url\":\"https://api.github.com/users/Nick3C/orgs\",\"repos_url\":\"https://api.github.com/users/Nick3C/repos\",\"events_url\":\"https://api.github.com/users/Nick3C/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/Nick3C/received_events\",\"type\":\"User\"},\"labels\":[{\"id\":4,\"node_id\":\"MDU6TGFiZWw0\",\"url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/labels/bug\",\"name\":\"bug\",\"color\":\"ff0000\"}],\"state\":\"open\",\"assignee\":null,\"milestone\":null,\"comments\":15,\"created_at\":\"2009-07-12T20:10:41Z\",\"updated_at\":\"2009-07-19T09:23:43Z\",\"closed_at\":null,\"pull_request\":{\"html_url\":null,\"diff_url\":null,\"patch_url\":null},\"body\":\"...\",\"score\":1.3859273}]}" + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\"id\":10,\"node_id\":\"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\"pull_request_review_id\":42,\"diff_hunk\":\"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\"path\":\"file1.txt\",\"position\":1,\"original_position\":4,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"original_commit_id\":\"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\"in_reply_to_id\":8,\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Great stuff!\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"author_association\":\"NONE\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\"}},\"start_line\":1,\"original_start_line\":1,\"start_side\":\"RIGHT\",\"line\":2,\"original_line\":2,\"side\":\"RIGHT\"}" } ] } ], - "renamed": { - "before": { "scope": "search", "id": "issues" }, - "after": { "scope": "search", "id": "issuesAndPullRequests" }, - "date": "2018-12-27", - "note": "\"Search issues\" has been renamed to \"Search issues and pull requests\"" - } + "renamed": null }, { - "name": "Search labels", - "scope": "search", - "id": "labels", - "method": "GET", - "url": "/search/labels", + "name": "Create a review comment reply", + "scope": "pulls", + "id": "createReviewCommentReply", + "method": "POST", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies", "isDeprecated": false, "isLegacy": false, - "description": "Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://developer.github.com/v3/#pagination).\n\nWhen searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://developer.github.com/v3/search/#text-match-metadata).\n\nSuppose you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:\n\nThe labels that best match for the query appear first in the search results.", - "documentationUrl": "https://developer.github.com/v3/search/#search-labels", + "description": "Creates a reply to a review comment for a pull request. For the `comment_id`, provide the ID of the review comment you are replying to. This must be the ID of a _top-level review comment_, not a reply to that comment. Replies to replies are not supported.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.", + "documentationUrl": "https://developer.github.com/v3/pulls/comments/#create-a-review-comment-reply", "previews": [], "headers": [], "parameters": [ { - "name": "repository_id", - "description": "The id of the repository.", - "in": "QUERY", - "type": "integer", + "name": "owner", + "description": "owner parameter", + "in": "PATH", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -38166,9 +30154,9 @@ "deprecated": null }, { - "name": "q", - "description": "The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query).", - "in": "QUERY", + "name": "repo", + "description": "repo parameter", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -38179,12 +30167,12 @@ "deprecated": null }, { - "name": "sort", - "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["created", "updated"], + "name": "pull_number", + "description": "pull_number parameter", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -38192,12 +30180,25 @@ "deprecated": null }, { - "name": "order", - "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", - "in": "QUERY", + "name": "comment_id", + "description": "comment_id parameter", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "body", + "description": "The text of the review comment.", + "in": "BODY", "type": "string", - "required": false, - "enum": ["desc", "asc"], + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -38207,11 +30208,11 @@ ], "responses": [ { - "code": 200, + "code": 201, "description": "response", "examples": [ { - "data": "{\"total_count\":2,\"incomplete_results\":false,\"items\":[{\"id\":418327088,\"node_id\":\"MDU6TGFiZWw0MTgzMjcwODg=\",\"url\":\"https://api.github.com/repos/octocat/linguist/labels/enhancement\",\"name\":\"enhancement\",\"color\":\"84b6eb\",\"default\":true,\"description\":\"New feature or request.\",\"score\":0.1193385},{\"id\":418327086,\"node_id\":\"MDU6TGFiZWw0MTgzMjcwODY=\",\"url\":\"https://api.github.com/repos/octocat/linguist/labels/bug\",\"name\":\"bug\",\"color\":\"ee0701\",\"default\":true,\"description\":\"Something isn't working.\",\"score\":0.11928606}]}" + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/comments/1\",\"pull_request_review_id\":1,\"id\":2,\"node_id\":\"MDEzOkNvbW1pdENvbW1lbnQx\",\"diff_hunk\":\"@@ -18,3 +18,5 @@ This is my amazing work.\",\"path\":\"file1.txt\",\"position\":4,\"original_position\":4,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"original_commit_id\":\"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"I like this too!\",\"created_at\":\"2019-08-11T16:00:49Z\",\"updated_at\":\"2019-08-11T16:00:49Z\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"author_association\":\"NONE\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\"}}}" } ] } @@ -38219,22 +30220,22 @@ "renamed": null }, { - "name": "Search repositories", - "scope": "search", - "id": "repos", + "name": "List commits on a pull request", + "scope": "pulls", + "id": "listCommits", "method": "GET", - "url": "/search/repositories", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/commits", "isDeprecated": false, "isLegacy": false, - "description": "Find repositories via various criteria. This method returns up to 100 results [per page](https://developer.github.com/v3/#pagination).\n\nWhen searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://developer.github.com/v3/search/#text-match-metadata).\n\nSuppose you want to search for popular Tetris repositories written in Assembly. Your query might look like this.\n\nYou can search for multiple topics by adding more `topic:` instances, and including the `mercy-preview` header. For example:\n\nIn this request, we're searching for repositories with the word `tetris` in the name, the description, or the README. We're limiting the results to only find repositories where the primary language is Assembly. We're sorting by stars in descending order, so that the most popular repositories appear first in the search results.", - "documentationUrl": "https://developer.github.com/v3/search/#search-repositories", + "description": "Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [Commit List API](https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository).", + "documentationUrl": "https://developer.github.com/v3/pulls/#list-commits-on-a-pull-request", "previews": [], "headers": [], "parameters": [ { - "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See \"[Searching for repositories](https://help.github.com/articles/searching-for-repositories/)\" for a detailed list of qualifiers.", - "in": "QUERY", + "name": "owner", + "description": "owner parameter", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -38245,12 +30246,12 @@ "deprecated": null }, { - "name": "sort", - "description": "Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", - "in": "QUERY", + "name": "repo", + "description": "repo parameter", + "in": "PATH", "type": "string", - "required": false, - "enum": ["stars", "forks", "help-wanted-issues", "updated"], + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -38258,12 +30259,12 @@ "deprecated": null }, { - "name": "order", - "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["desc", "asc"], + "name": "pull_number", + "description": "pull_number parameter", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -38303,7 +30304,7 @@ "description": "response", "examples": [ { - "data": "{\"total_count\":40,\"incomplete_results\":false,\"items\":[{\"id\":3081286,\"node_id\":\"MDEwOlJlcG9zaXRvcnkzMDgxMjg2\",\"name\":\"Tetris\",\"full_name\":\"dtrupenn/Tetris\",\"owner\":{\"login\":\"dtrupenn\",\"id\":872147,\"node_id\":\"MDQ6VXNlcjg3MjE0Nw==\",\"avatar_url\":\"https://secure.gravatar.com/avatar/e7956084e75f239de85d3a31bc172ace?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/dtrupenn\",\"received_events_url\":\"https://api.github.com/users/dtrupenn/received_events\",\"type\":\"User\"},\"private\":false,\"html_url\":\"https://github.com/dtrupenn/Tetris\",\"description\":\"A C implementation of Tetris using Pennsim through LC4\",\"fork\":false,\"url\":\"https://api.github.com/repos/dtrupenn/Tetris\",\"created_at\":\"2012-01-01T00:31:50Z\",\"updated_at\":\"2013-01-05T17:58:47Z\",\"pushed_at\":\"2012-01-01T00:37:02Z\",\"homepage\":\"\",\"size\":524,\"stargazers_count\":1,\"watchers_count\":1,\"language\":\"Assembly\",\"forks_count\":0,\"open_issues_count\":0,\"master_branch\":\"master\",\"default_branch\":\"master\",\"score\":10.309712}]}" + "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"node_id\":\"MDY6Q29tbWl0NmRjYjA5YjViNTc4NzVmMzM0ZjYxYWViZWQ2OTVlMmU0MTkzZGI1ZQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/git/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"author\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"committer\":{\"name\":\"Monalisa Octocat\",\"email\":\"support@github.com\",\"date\":\"2011-04-14T16:00:49Z\"},\"message\":\"Fix all the bugs\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/tree/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"},\"comment_count\":0,\"verification\":{\"verified\":false,\"reason\":\"unsigned\",\"signature\":null,\"payload\":null}},\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"committer\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\"}]}]" } ] } @@ -38311,22 +30312,22 @@ "renamed": null }, { - "name": "Search topics", - "scope": "search", - "id": "topics", + "name": "List pull requests files", + "scope": "pulls", + "id": "listFiles", "method": "GET", - "url": "/search/topics", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/files", "isDeprecated": false, "isLegacy": false, - "description": "Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://developer.github.com/v3/#pagination).\n\nWhen searching for topics, you can get text match metadata for the topic's **short\\_description**, **description**, **name**, or **display\\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://developer.github.com/v3/search/#text-match-metadata).\n\nSee \"[Searching topics](https://help.github.com/articles/searching-topics/)\" for a detailed list of qualifiers.\n\nSuppose you want to search for topics related to Ruby that are featured on [https://github.com/topics](https://github.com/topics). Your query might look like this:\n\nIn this request, we're searching for topics with the keyword `ruby`, and we're limiting the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.\n\n**Note:** A search for featured Ruby topics only has 6 total results, so a [Link header](https://developer.github.com/v3/#link-header) indicating pagination is not included in the response.", - "documentationUrl": "https://developer.github.com/v3/search/#search-topics", + "description": "**Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default.", + "documentationUrl": "https://developer.github.com/v3/pulls/#list-pull-requests-files", "previews": [], "headers": [], "parameters": [ { - "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query).", - "in": "QUERY", + "name": "owner", + "description": "owner parameter", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -38335,38 +30336,11 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"total_count\":6,\"incomplete_results\":false,\"items\":[{\"name\":\"ruby\",\"display_name\":\"Ruby\",\"short_description\":\"Ruby is a scripting language designed for simplified object-oriented programming.\",\"description\":\"Ruby was developed by Yukihiro \\\"Matz\\\" Matsumoto in 1995 with the intent of having an easily readable programming language. It is integrated with the Rails framework to create dynamic web-applications. Ruby's syntax is similar to that of Perl and Python.\",\"created_by\":\"Yukihiro Matsumoto\",\"released\":\"December 21, 1995\",\"created_at\":\"2016-11-28T22:03:59Z\",\"updated_at\":\"2017-10-30T18:16:32Z\",\"featured\":true,\"curated\":true,\"score\":1750.5872},{\"name\":\"rails\",\"display_name\":\"Rails\",\"short_description\":\"Ruby on Rails (Rails) is a web application framework written in Ruby.\",\"description\":\"Ruby on Rails (Rails) is a web application framework written in Ruby. It is meant to help simplify the building of complex websites.\",\"created_by\":\"David Heinemeier Hansson\",\"released\":\"December 13 2005\",\"created_at\":\"2016-12-09T17:03:50Z\",\"updated_at\":\"2017-10-30T16:20:19Z\",\"featured\":true,\"curated\":true,\"score\":192.49863},{\"name\":\"python\",\"display_name\":\"Python\",\"short_description\":\"Python is a dynamically typed programming language.\",\"description\":\"Python is a dynamically typed programming language designed by Guido Van Rossum. Much like the programming language Ruby, Python was designed to be easily read by programmers. Because of its large following and many libraries, Python can be implemented and used to do anything from webpages to scientific research.\",\"created_by\":\"Guido van Rossum\",\"released\":\"February 20, 1991\",\"created_at\":\"2016-12-07T00:07:02Z\",\"updated_at\":\"2017-10-27T22:45:43Z\",\"featured\":true,\"curated\":true,\"score\":111.92691},{\"name\":\"jekyll\",\"display_name\":\"Jekyll\",\"short_description\":\"Jekyll is a simple, blog-aware static site generator.\",\"description\":\"Jekyll is a blog-aware, site generator written in Ruby. It takes raw text files, runs it through a renderer and produces a publishable static website.\",\"created_by\":\"Tom Preston-Werner\",\"released\":\"2008\",\"created_at\":\"2016-12-16T21:53:08Z\",\"updated_at\":\"2017-10-27T19:00:24Z\",\"featured\":true,\"curated\":true,\"score\":45.06729},{\"name\":\"sass\",\"display_name\":\"Sass\",\"short_description\":\"Sass is a stable extension to classic CSS.\",\"description\":\"Sass is a stylesheet language with a main implementation in Ruby. It is an extension of CSS that makes improvements to the old stylesheet format, such as being able to declare variables and using a cleaner nesting syntax.\",\"created_by\":\"Hampton Catlin, Natalie Weizenbaum, Chris Eppstein\",\"released\":\"November 28, 2006\",\"created_at\":\"2016-12-16T21:53:45Z\",\"updated_at\":\"2018-01-16T16:30:40Z\",\"featured\":true,\"curated\":true,\"score\":42.455986},{\"name\":\"homebrew\",\"display_name\":\"Homebrew\",\"short_description\":\"Homebrew is a package manager for macOS.\",\"description\":\"Homebrew is a package manager for Apple's macOS operating system. It simplifies the installation of software and is popular in the Ruby on Rails community.\",\"created_by\":\"Max Howell\",\"released\":\"2009\",\"created_at\":\"2016-12-17T20:30:44Z\",\"updated_at\":\"2018-02-06T16:14:56Z\",\"featured\":true,\"curated\":true,\"score\":19.194168}]}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Search users", - "scope": "search", - "id": "users", - "method": "GET", - "url": "/search/users", - "isDeprecated": false, - "isLegacy": false, - "description": "Find users via various criteria. This method returns up to 100 results [per page](https://developer.github.com/v3/#pagination).\n\nWhen searching for users, you can get text match metadata for the issue **login**, **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://developer.github.com/v3/search/#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://developer.github.com/v3/search/#text-match-metadata).\n\nImagine you're looking for a list of popular users. You might try out this query:\n\nHere, we're looking at users with the name Tom. We're only interested in those with more than 42 repositories, and only if they have over 1,000 followers.", - "documentationUrl": "https://developer.github.com/v3/search/#search-users", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "q", - "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See \"[Searching users](https://help.github.com/articles/searching-users/)\" for a detailed list of qualifiers.", - "in": "QUERY", + "name": "repo", + "description": "repo parameter", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -38377,25 +30351,12 @@ "deprecated": null }, { - "name": "sort", - "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["followers", "repositories", "joined"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "order", - "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["desc", "asc"], + "name": "pull_number", + "description": "pull_number parameter", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -38435,7 +30396,7 @@ "description": "response", "examples": [ { - "data": "{\"total_count\":12,\"incomplete_results\":false,\"items\":[{\"login\":\"mojombo\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://secure.gravatar.com/avatar/25c7c18223fb42a4c6ae1c8db6f50f9b?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/mojombo\",\"html_url\":\"https://github.com/mojombo\",\"followers_url\":\"https://api.github.com/users/mojombo/followers\",\"subscriptions_url\":\"https://api.github.com/users/mojombo/subscriptions\",\"organizations_url\":\"https://api.github.com/users/mojombo/orgs\",\"repos_url\":\"https://api.github.com/users/mojombo/repos\",\"received_events_url\":\"https://api.github.com/users/mojombo/received_events\",\"type\":\"User\",\"score\":105.47857}]}" + "data": "[{\"sha\":\"bbcd538c8e72b8c175046e27cc8f907076331401\",\"filename\":\"file1.txt\",\"status\":\"added\",\"additions\":103,\"deletions\":21,\"changes\":124,\"blob_url\":\"https://github.com/octocat/Hello-World/blob/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt\",\"raw_url\":\"https://github.com/octocat/Hello-World/raw/6dcb09b5b57875f334f61aebed695e2e4193db5e/file1.txt\",\"contents_url\":\"https://api.github.com/repos/octocat/Hello-World/contents/file1.txt?ref=6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"patch\":\"@@ -132,7 +132,7 @@ module Test @@ -1000,7 +1000,7 @@ module Test\"}]" } ] } @@ -38443,23 +30404,23 @@ "renamed": null }, { - "name": "Get team (Legacy)", - "scope": "teams", - "id": "getLegacy", + "name": "Get if a pull request has been merged", + "scope": "pulls", + "id": "checkIfMerged", "method": "GET", - "url": "/teams/{team_id}", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [`Get team by name`](https://developer.github.com/v3/teams/#get-team-by-name) endpoint.", - "documentationUrl": "https://developer.github.com/v3/teams/#get-team-legacy", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", + "isDeprecated": false, + "isLegacy": false, + "description": "", + "documentationUrl": "https://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged", "previews": [], "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -38467,37 +30428,23 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ + }, { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null,\"members_count\":3,\"repos_count\":10,\"created_at\":\"2017-07-14T16:53:42Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"is_verified\":true,\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"type\":\"Organization\"}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get team (Legacy)", - "scope": "teams", - "id": "get", - "method": "GET", - "url": "/teams/{team_id}", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [`Get team by name`](https://developer.github.com/v3/teams/#get-team-by-name) endpoint.", - "documentationUrl": "https://developer.github.com/v3/teams/#get-team-legacy", - "previews": [], - "headers": [], - "parameters": [ + "name": "repo", + "description": "repo parameter", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { - "name": "team_id", - "description": "team_id parameter", + "name": "pull_number", + "description": "pull_number parameter", "in": "PATH", "type": "integer", "required": true, @@ -38509,42 +30456,27 @@ "deprecated": null } ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null,\"members_count\":3,\"repos_count\":10,\"created_at\":\"2017-07-14T16:53:42Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"is_verified\":true,\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"type\":\"Organization\"}}" - } - ] - } - ], - "renamed": { - "before": { "scope": "teams", "id": "get" }, - "after": { "scope": "teams", "id": "getLegacy" }, - "date": "2020-01-16", - "note": "The path for \"Get team\" changed from \"/teams/{team_id}*\" to \"/orgs/{org}/teams/{team_slug}*\"). The operation ID for the old path now has a \"-legacy\" suffix. The route with the new path has a \"-for-org\" suffix in the operation ID to avoid breaking changes" - } + "responses": [], + "renamed": null }, { - "name": "Edit team (Legacy)", - "scope": "teams", - "id": "updateLegacy", - "method": "PATCH", - "url": "/teams/{team_id}", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Edit team`](https://developer.github.com/v3/teams/#edit-team) endpoint.\n\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** With nested teams, the `privacy` for parent teams cannot be `secret`.", - "documentationUrl": "https://developer.github.com/v3/teams/#edit-team-legacy", + "name": "Merge a pull request (Merge Button)", + "scope": "pulls", + "id": "merge", + "method": "PUT", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/merge", + "isDeprecated": false, + "isLegacy": false, + "description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.", + "documentationUrl": "https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-button", "previews": [], "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -38554,9 +30486,9 @@ "deprecated": null }, { - "name": "name", - "description": "The name of the team.", - "in": "BODY", + "name": "repo", + "description": "repo parameter", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -38567,8 +30499,21 @@ "deprecated": null }, { - "name": "description", - "description": "The description of the team.", + "name": "pull_number", + "description": "pull_number parameter", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "commit_title", + "description": "Title for the automatic commit message.", "in": "BODY", "type": "string", "required": false, @@ -38580,12 +30525,12 @@ "deprecated": null }, { - "name": "privacy", - "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.", + "name": "commit_message", + "description": "Extra detail to append to automatic commit message.", "in": "BODY", "type": "string", "required": false, - "enum": ["secret", "closed"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -38593,12 +30538,12 @@ "deprecated": null }, { - "name": "permission", - "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer newly-added repositories. \n\\* `push` - team members can pull and push, but not administer newly-added repositories. \n\\* `admin` - team members can pull, push and administer newly-added repositories.", + "name": "sha", + "description": "SHA that pull request head must match to allow merge.", "in": "BODY", "type": "string", "required": false, - "enum": ["pull", "push", "admin"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -38606,12 +30551,12 @@ "deprecated": null }, { - "name": "parent_team_id", - "description": "The ID of a team to set as the parent team.", + "name": "merge_method", + "description": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.", "in": "BODY", - "type": "integer", + "type": "string", "required": false, - "enum": null, + "enum": ["merge", "squash", "rebase"], "allowNull": false, "mapToData": null, "validation": null, @@ -38621,11 +30566,29 @@ ], "responses": [ { - "code": 201, - "description": "response", + "code": 200, + "description": "Response if merge was successful", "examples": [ { - "data": "{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null,\"members_count\":3,\"repos_count\":10,\"created_at\":\"2017-07-14T16:53:42Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"is_verified\":true,\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"type\":\"Organization\"}}" + "data": "{\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"merged\":true,\"message\":\"Pull Request successfully merged\"}" + } + ] + }, + { + "code": 405, + "description": "Response if merge cannot be performed", + "examples": [ + { + "data": "{\"message\":\"Pull Request is not mergeable\",\"documentation_url\":\"https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-button\"}" + } + ] + }, + { + "code": 409, + "description": "Response if sha was provided and pull request head did not match", + "examples": [ + { + "data": "{\"message\":\"Head branch was modified. Review and try the merge again.\",\"documentation_url\":\"https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-button\"}" } ] } @@ -38633,23 +30596,23 @@ "renamed": null }, { - "name": "Edit team (Legacy)", - "scope": "teams", - "id": "update", - "method": "PATCH", - "url": "/teams/{team_id}", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Edit team`](https://developer.github.com/v3/teams/#edit-team) endpoint.\n\nTo edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** With nested teams, the `privacy` for parent teams cannot be `secret`.", - "documentationUrl": "https://developer.github.com/v3/teams/#edit-team-legacy", + "name": "List review requests", + "scope": "pulls", + "id": "listReviewRequests", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", + "isDeprecated": false, + "isLegacy": false, + "description": "", + "documentationUrl": "https://developer.github.com/v3/pulls/review_requests/#list-review-requests", "previews": [], "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -38659,9 +30622,9 @@ "deprecated": null }, { - "name": "name", - "description": "The name of the team.", - "in": "BODY", + "name": "repo", + "description": "repo parameter", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -38672,11 +30635,11 @@ "deprecated": null }, { - "name": "description", - "description": "The description of the team.", - "in": "BODY", - "type": "string", - "required": false, + "name": "pull_number", + "description": "pull_number parameter", + "in": "PATH", + "type": "integer", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -38685,25 +30648,12 @@ "deprecated": null }, { - "name": "privacy", - "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.", - "in": "BODY", - "type": "string", - "required": false, - "enum": ["secret", "closed"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "permission", - "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer newly-added repositories. \n\\* `push` - team members can pull and push, but not administer newly-added repositories. \n\\* `admin` - team members can pull, push and administer newly-added repositories.", - "in": "BODY", - "type": "string", + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", "required": false, - "enum": ["pull", "push", "admin"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -38711,9 +30661,9 @@ "deprecated": null }, { - "name": "parent_team_id", - "description": "The ID of a team to set as the parent team.", - "in": "BODY", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", "type": "integer", "required": false, "enum": null, @@ -38726,38 +30676,59 @@ ], "responses": [ { - "code": 201, + "code": 200, "description": "response", "examples": [ { - "data": "{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null,\"members_count\":3,\"repos_count\":10,\"created_at\":\"2017-07-14T16:53:42Z\",\"updated_at\":\"2017-08-17T12:37:15Z\",\"organization\":{\"login\":\"github\",\"id\":1,\"node_id\":\"MDEyOk9yZ2FuaXphdGlvbjE=\",\"url\":\"https://api.github.com/orgs/github\",\"repos_url\":\"https://api.github.com/orgs/github/repos\",\"events_url\":\"https://api.github.com/orgs/github/events\",\"hooks_url\":\"https://api.github.com/orgs/github/hooks\",\"issues_url\":\"https://api.github.com/orgs/github/issues\",\"members_url\":\"https://api.github.com/orgs/github/members{/member}\",\"public_members_url\":\"https://api.github.com/orgs/github/public_members{/member}\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"description\":\"A great organization\",\"name\":\"github\",\"company\":\"GitHub\",\"blog\":\"https://github.com/blog\",\"location\":\"San Francisco\",\"email\":\"octocat@github.com\",\"is_verified\":true,\"has_organization_projects\":true,\"has_repository_projects\":true,\"public_repos\":2,\"public_gists\":1,\"followers\":20,\"following\":0,\"html_url\":\"https://github.com/octocat\",\"created_at\":\"2008-01-14T04:33:35Z\",\"type\":\"Organization\"}}" + "data": "{\"users\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}],\"teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]}" } ] } ], - "renamed": { - "before": { "scope": "teams", "id": "update" }, - "after": { "scope": "teams", "id": "updateLegacy" }, - "date": "2020-01-16", - "note": "The path for \"Edit team\" changed from \"/teams/{team_id}*\" to \"/orgs/{org}/teams/{team_slug}*\"). The operation ID for the old path now has a \"-legacy\" suffix. The route with the new path has a \"-for-org\" suffix in the operation ID to avoid breaking changes" - } + "renamed": null }, { - "name": "Delete team (Legacy)", - "scope": "teams", - "id": "deleteLegacy", - "method": "DELETE", - "url": "/teams/{team_id}", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete team`](https://developer.github.com/v3/teams/#delete-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.", - "documentationUrl": "https://developer.github.com/v3/teams/#delete-team-legacy", + "name": "Create a review request", + "scope": "pulls", + "id": "createReviewRequest", + "method": "POST", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", + "isDeprecated": false, + "isLegacy": false, + "description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.", + "documentationUrl": "https://developer.github.com/v3/pulls/review_requests/#create-a-review-request", "previews": [], "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "repo parameter", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "pull_number", + "description": "pull_number parameter", "in": "PATH", "type": "integer", "required": true, @@ -38767,29 +30738,65 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "reviewers", + "description": "An array of user `login`s that will be requested.", + "in": "BODY", + "type": "string[]", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "team_reviewers", + "description": "An array of team `slug`s that will be requested.", + "in": "BODY", + "type": "string[]", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 201, + "description": "response", + "examples": [ + { + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\"id\":1,\"node_id\":\"MDExOlB1bGxSZXF1ZXN0MQ==\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1347\",\"diff_url\":\"https://github.com/octocat/Hello-World/pull/1347.diff\",\"patch_url\":\"https://github.com/octocat/Hello-World/pull/1347.patch\",\"issue_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\"commits_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\",\"review_comments_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\",\"review_comment_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\",\"comments_url\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\"statuses_url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"number\":1347,\"state\":\"open\",\"locked\":true,\"title\":\"Amazing new feature\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Please pull these awesome changes in!\",\"labels\":[{\"id\":208045946,\"node_id\":\"MDU6TGFiZWwyMDgwNDU5NDY=\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\"name\":\"bug\",\"description\":\"Something isn't working\",\"color\":\"f29513\",\"default\":true}],\"milestone\":{\"url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\"html_url\":\"https://github.com/octocat/Hello-World/milestones/v1.0\",\"labels_url\":\"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\"id\":1002604,\"node_id\":\"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\"number\":1,\"state\":\"open\",\"title\":\"v1.0\",\"description\":\"Tracking milestone for version 1.0\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"open_issues\":4,\"closed_issues\":8,\"created_at\":\"2011-04-10T20:09:31Z\",\"updated_at\":\"2014-03-03T18:58:10Z\",\"closed_at\":\"2013-02-12T13:22:01Z\",\"due_on\":\"2012-10-09T23:39:01Z\"},\"active_lock_reason\":\"too heated\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:01:12Z\",\"closed_at\":\"2011-01-26T19:01:12Z\",\"merged_at\":\"2011-01-26T19:01:12Z\",\"merge_commit_sha\":\"e5bd3914e2e596debea16f433f57875b5b90bcd6\",\"assignee\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assignees\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true}],\"requested_reviewers\":[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},{\"login\":\"hubot\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/hubot\",\"html_url\":\"https://github.com/hubot\",\"followers_url\":\"https://api.github.com/users/hubot/followers\",\"following_url\":\"https://api.github.com/users/hubot/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/hubot/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/hubot/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/hubot/subscriptions\",\"organizations_url\":\"https://api.github.com/users/hubot/orgs\",\"repos_url\":\"https://api.github.com/users/hubot/repos\",\"events_url\":\"https://api.github.com/users/hubot/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/hubot/received_events\",\"type\":\"User\",\"site_admin\":true},{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false}],\"requested_teams\":[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}],\"head\":{\"label\":\"octocat:new-topic\",\"ref\":\"new-topic\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}},\"base\":{\"label\":\"octocat:master\",\"ref\":\"master\",\"sha\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repo\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}},\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1347\"},\"issue\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347\"},\"comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\"},\"review_comments\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments\"},\"review_comment\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}\"},\"commits\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits\"},\"statuses\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\"}},\"author_association\":\"OWNER\",\"draft\":false}" + } + ] } ], - "responses": [], "renamed": null }, { - "name": "Delete team (Legacy)", - "scope": "teams", - "id": "delete", + "name": "Delete a review request", + "scope": "pulls", + "id": "deleteReviewRequest", "method": "DELETE", - "url": "/teams/{team_id}", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete team`](https://developer.github.com/v3/teams/#delete-team) endpoint.\n\nTo delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.", - "documentationUrl": "https://developer.github.com/v3/teams/#delete-team-legacy", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers", + "isDeprecated": false, + "isLegacy": false, + "description": "", + "documentationUrl": "https://developer.github.com/v3/pulls/review_requests/#delete-a-review-request", "previews": [], "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -38797,34 +30804,12 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [], - "renamed": { - "before": { "scope": "teams", "id": "delete" }, - "after": { "scope": "teams", "id": "deleteLegacy" }, - "date": "2020-01-16", - "note": "The path for \"Delete team\" changed from \"/teams/{team_id}*\" to \"/orgs/{org}/teams/{team_slug}*\"). The operation ID for the old path now has a \"-legacy\" suffix. The route with the new path has a \"-for-org\" suffix in the operation ID to avoid breaking changes" - } - }, - { - "name": "List discussions (Legacy)", - "scope": "teams", - "id": "listDiscussionsLegacy", - "method": "GET", - "url": "/teams/{team_id}/discussions", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://developer.github.com/v3/teams/discussions/#list-discussions) endpoint.\n\nList all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://developer.github.com/v3/teams/discussions/#list-discussions-legacy", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "team_id", - "description": "team_id parameter", + "name": "repo", + "description": "repo parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -38834,12 +30819,12 @@ "deprecated": null }, { - "name": "direction", - "description": "Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], + "name": "pull_number", + "description": "pull_number parameter", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -38847,10 +30832,10 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", + "name": "reviewers", + "description": "An array of user `login`s that will be removed.", + "in": "BODY", + "type": "string[]", "required": false, "enum": null, "allowNull": false, @@ -38860,10 +30845,10 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", + "name": "team_reviewers", + "description": "An array of team `slug`s that will be removed.", + "in": "BODY", + "type": "string[]", "required": false, "enum": null, "allowNull": false, @@ -38873,37 +30858,27 @@ "deprecated": null } ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"

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

\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":0,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":null,\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Our first team post\",\"updated_at\":\"2018-01-25T18:56:31Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0}}]" - } - ] - } - ], + "responses": [], "renamed": null }, { - "name": "List discussions (Legacy)", - "scope": "teams", - "id": "listDiscussions", + "name": "List reviews on a pull request", + "scope": "pulls", + "id": "listReviews", "method": "GET", - "url": "/teams/{team_id}/discussions", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://developer.github.com/v3/teams/discussions/#list-discussions) endpoint.\n\nList all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://developer.github.com/v3/teams/discussions/#list-discussions-legacy", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", + "isDeprecated": false, + "isLegacy": false, + "description": "The list of reviews returns in chronological order.", + "documentationUrl": "https://developer.github.com/v3/pulls/reviews/#list-reviews-on-a-pull-request", "previews": [], "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -38913,12 +30888,25 @@ "deprecated": null }, { - "name": "direction", - "description": "Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`.", - "in": "QUERY", + "name": "repo", + "description": "repo parameter", + "in": "PATH", "type": "string", - "required": false, - "enum": ["asc", "desc"], + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "pull_number", + "description": "pull_number parameter", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -38955,39 +30943,34 @@ "responses": [ { "code": 200, - "description": "response", + "description": "The list of reviews returns in chronological order.", "examples": [ { - "data": "[{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"

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

\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":0,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":null,\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Our first team post\",\"updated_at\":\"2018-01-25T18:56:31Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0}}]" + "data": "[{\"id\":80,\"node_id\":\"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Here is the body for the review.\",\"submitted_at\":\"2019-11-17T17:43:43Z\",\"commit_id\":\"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\"state\":\"APPROVED\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\"_links\":{\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\"}}}]" } ] } ], - "renamed": { - "before": { "scope": "teams", "id": "listDiscussions" }, - "after": { "scope": "teams", "id": "listDiscussionsLegacy" }, - "date": "2020-01-16", - "note": "The path for \"List discussions\" changed from \"/teams/{team_id}*\" to \"/orgs/{org}/teams/{team_slug}*\"). The operation ID for the old path now has a \"-legacy\" suffix. The route with the new path has a \"-for-org\" suffix in the operation ID to avoid breaking changes" - } + "renamed": null }, { - "name": "Create a discussion (Legacy)", - "scope": "teams", - "id": "createDiscussionLegacy", + "name": "Create a pull request review", + "scope": "pulls", + "id": "createReview", "method": "POST", - "url": "/teams/{team_id}/discussions", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://developer.github.com/v3/teams/discussions/#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.", - "documentationUrl": "https://developer.github.com/v3/teams/discussions/#create-a-discussion-legacy", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews", + "isDeprecated": false, + "isLegacy": false, + "description": "This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.\n\n**Note:** To comment on a specific line in a file, you need to first determine the _position_ of that line in the diff. The GitHub REST API v3 offers the `application/vnd.github.v3.diff` [media type](https://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests). To see a pull request diff, add this media type to the `Accept` header of a call to the [single pull request](https://developer.github.com/v3/pulls/#get-a-single-pull-request) endpoint.\n\nThe `position` value equals the number of lines down from the first \"@@\" hunk header in the file you want to add a comment. The line just below the \"@@\" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file.", + "documentationUrl": "https://developer.github.com/v3/pulls/reviews/#create-a-pull-request-review", "previews": [], "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -38997,9 +30980,9 @@ "deprecated": null }, { - "name": "title", - "description": "The discussion post's title.", - "in": "BODY", + "name": "repo", + "description": "repo parameter", + "in": "PATH", "type": "string", "required": true, "enum": null, @@ -39010,11 +30993,24 @@ "deprecated": null }, { - "name": "body", - "description": "The discussion post's body text.", + "name": "pull_number", + "description": "pull_number parameter", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "commit_id", + "description": "The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value.", "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -39023,10 +31019,10 @@ "deprecated": null }, { - "name": "private", - "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.", + "name": "body", + "description": "**Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review.", "in": "BODY", - "type": "boolean", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -39034,40 +31030,26 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ + }, { - "code": 201, - "description": "response", - "examples": [ - { - "data": "{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"

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

\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":0,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":null,\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Our first team post\",\"updated_at\":\"2018-01-25T18:56:31Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a discussion (Legacy)", - "scope": "teams", - "id": "createDiscussion", - "method": "POST", - "url": "/teams/{team_id}/discussions", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://developer.github.com/v3/teams/discussions/#create-a-discussion) endpoint.\n\nCreates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.", - "documentationUrl": "https://developer.github.com/v3/teams/discussions/#create-a-discussion-legacy", - "previews": [], - "headers": [], - "parameters": [ + "name": "event", + "description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://developer.github.com/v3/pulls/reviews/#submit-a-pull-request-review) when you are ready.", + "in": "BODY", + "type": "string", + "required": false, + "enum": ["APPROVE", "REQUEST_CHANGES", "COMMENT"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { - "name": "team_id", - "description": "team_id parameter", - "in": "PATH", - "type": "integer", - "required": true, + "name": "comments", + "description": "Use the following table to specify the location, destination, and contents of the draft review comment.", + "in": "BODY", + "type": "object[]", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -39076,8 +31058,8 @@ "deprecated": null }, { - "name": "title", - "description": "The discussion post's title.", + "name": "comments[].path", + "description": "The relative path to the file that necessitates a review comment.", "in": "BODY", "type": "string", "required": true, @@ -39089,10 +31071,10 @@ "deprecated": null }, { - "name": "body", - "description": "The discussion post's body text.", + "name": "comments[].position", + "description": "The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note below.", "in": "BODY", - "type": "string", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -39102,11 +31084,11 @@ "deprecated": null }, { - "name": "private", - "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.", + "name": "comments[].body", + "description": "Text of the review comment.", "in": "BODY", - "type": "boolean", - "required": false, + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -39117,40 +31099,35 @@ ], "responses": [ { - "code": 201, + "code": 200, "description": "response", "examples": [ { - "data": "{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"

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

\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":0,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":null,\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Our first team post\",\"updated_at\":\"2018-01-25T18:56:31Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0}}" + "data": "{\"id\":80,\"node_id\":\"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"This is close to perfect! Please address the suggested inline change.\",\"commit_id\":\"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\"state\":\"CHANGES_REQUESTED\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\"_links\":{\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\"}}}" } ] } ], - "renamed": { - "before": { "scope": "teams", "id": "createDiscussion" }, - "after": { "scope": "teams", "id": "createDiscussionLegacy" }, - "date": "2020-01-16", - "note": "The path for \"Create a discussion\" changed from \"/teams/{team_id}*\" to \"/orgs/{org}/teams/{team_slug}*\"). The operation ID for the old path now has a \"-legacy\" suffix. The route with the new path has a \"-for-org\" suffix in the operation ID to avoid breaking changes" - } + "renamed": null }, { - "name": "Get a single discussion (Legacy)", - "scope": "teams", - "id": "getDiscussionLegacy", + "name": "Get a single review", + "scope": "pulls", + "id": "getReview", "method": "GET", - "url": "/teams/{team_id}/discussions/{discussion_number}", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Get a single discussion`](https://developer.github.com/v3/teams/discussions/#get-a-single-discussion) endpoint.\n\nGet a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://developer.github.com/v3/teams/discussions/#get-a-single-discussion-legacy", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", + "isDeprecated": false, + "isLegacy": false, + "description": "", + "documentationUrl": "https://developer.github.com/v3/pulls/reviews/#get-a-single-review", "previews": [], "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -39160,10 +31137,10 @@ "deprecated": null }, { - "name": "discussion_number", - "description": "discussion_number parameter", + "name": "repo", + "description": "repo parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -39171,37 +31148,10 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"

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

\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":0,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":null,\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Our first team post\",\"updated_at\":\"2018-01-25T18:56:31Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Get a single discussion (Legacy)", - "scope": "teams", - "id": "getDiscussion", - "method": "GET", - "url": "/teams/{team_id}/discussions/{discussion_number}", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Get a single discussion`](https://developer.github.com/v3/teams/discussions/#get-a-single-discussion) endpoint.\n\nGet a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://developer.github.com/v3/teams/discussions/#get-a-single-discussion-legacy", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "team_id", - "description": "team_id parameter", + "name": "pull_number", + "description": "pull_number parameter", "in": "PATH", "type": "integer", "required": true, @@ -39213,8 +31163,8 @@ "deprecated": null }, { - "name": "discussion_number", - "description": "discussion_number parameter", + "name": "review_id", + "description": "review_id parameter", "in": "PATH", "type": "integer", "required": true, @@ -39232,36 +31182,31 @@ "description": "response", "examples": [ { - "data": "{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"

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

\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":0,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":null,\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Our first team post\",\"updated_at\":\"2018-01-25T18:56:31Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0}}" + "data": "{\"id\":80,\"node_id\":\"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Here is the body for the review.\",\"submitted_at\":\"2019-11-17T17:43:43Z\",\"commit_id\":\"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\"state\":\"APPROVED\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\"_links\":{\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\"}}}" } ] } ], - "renamed": { - "before": { "scope": "teams", "id": "getDiscussion" }, - "after": { "scope": "teams", "id": "getDiscussionLegacy" }, - "date": "2020-01-16", - "note": "The path for \"Get a single discussion\" changed from \"/teams/{team_id}*\" to \"/orgs/{org}/teams/{team_slug}*\"). The operation ID for the old path now has a \"-legacy\" suffix. The route with the new path has a \"-for-org\" suffix in the operation ID to avoid breaking changes" - } + "renamed": null }, { - "name": "Edit a discussion (Legacy)", - "scope": "teams", - "id": "updateDiscussionLegacy", - "method": "PATCH", - "url": "/teams/{team_id}/discussions/{discussion_number}", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Edit a discussion`](https://developer.github.com/v3/teams/discussions/#edit-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://developer.github.com/v3/teams/discussions/#edit-a-discussion-legacy", + "name": "Delete a pending review", + "scope": "pulls", + "id": "deletePendingReview", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", + "isDeprecated": false, + "isLegacy": false, + "description": "", + "documentationUrl": "https://developer.github.com/v3/pulls/reviews/#delete-a-pending-review", "previews": [], "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -39271,10 +31216,10 @@ "deprecated": null }, { - "name": "discussion_number", - "description": "discussion_number parameter", + "name": "repo", + "description": "repo parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -39284,11 +31229,11 @@ "deprecated": null }, { - "name": "title", - "description": "The discussion post's title.", - "in": "BODY", - "type": "string", - "required": false, + "name": "pull_number", + "description": "pull_number parameter", + "in": "PATH", + "type": "integer", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -39297,11 +31242,11 @@ "deprecated": null }, { - "name": "body", - "description": "The discussion post's body text.", - "in": "BODY", - "type": "string", - "required": false, + "name": "review_id", + "description": "review_id parameter", + "in": "PATH", + "type": "integer", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -39316,7 +31261,7 @@ "description": "response", "examples": [ { - "data": "{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"

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

\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":1,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":\"2018-01-26T18:22:20Z\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Welcome to our first team post\",\"updated_at\":\"2018-01-26T18:22:20Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0}}" + "data": "{\"id\":80,\"node_id\":\"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Here is the body for the review.\",\"commit_id\":\"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\"state\":\"PENDING\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\"_links\":{\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\"}}}" } ] } @@ -39324,23 +31269,23 @@ "renamed": null }, { - "name": "Edit a discussion (Legacy)", - "scope": "teams", - "id": "updateDiscussion", - "method": "PATCH", - "url": "/teams/{team_id}/discussions/{discussion_number}", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Edit a discussion`](https://developer.github.com/v3/teams/discussions/#edit-a-discussion) endpoint.\n\nEdits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://developer.github.com/v3/teams/discussions/#edit-a-discussion-legacy", + "name": "Update a pull request review", + "scope": "pulls", + "id": "updateReview", + "method": "PUT", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}", + "isDeprecated": false, + "isLegacy": false, + "description": "Update the review summary comment with new text.", + "documentationUrl": "https://developer.github.com/v3/pulls/reviews/#update-a-pull-request-review", "previews": [], "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -39350,8 +31295,21 @@ "deprecated": null }, { - "name": "discussion_number", - "description": "discussion_number parameter", + "name": "repo", + "description": "repo parameter", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "pull_number", + "description": "pull_number parameter", "in": "PATH", "type": "integer", "required": true, @@ -39363,11 +31321,11 @@ "deprecated": null }, { - "name": "title", - "description": "The discussion post's title.", - "in": "BODY", - "type": "string", - "required": false, + "name": "review_id", + "description": "review_id parameter", + "in": "PATH", + "type": "integer", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -39377,10 +31335,10 @@ }, { "name": "body", - "description": "The discussion post's body text.", + "description": "The body text of the pull request review.", "in": "BODY", "type": "string", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -39395,79 +31353,31 @@ "description": "response", "examples": [ { - "data": "{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Hi! This is an area for us to collaborate as a team.\",\"body_html\":\"

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

\",\"body_version\":\"0d495416a700fb06133c612575d92bfb\",\"comments_count\":1,\"comments_url\":\"https://api.github.com/teams/2343027/discussions/1/comments\",\"created_at\":\"2018-01-25T18:56:31Z\",\"last_edited_at\":\"2018-01-26T18:22:20Z\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1\",\"node_id\":\"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\"number\":1,\"pinned\":false,\"private\":false,\"team_url\":\"https://api.github.com/teams/2343027\",\"title\":\"Welcome to our first team post\",\"updated_at\":\"2018-01-26T18:22:20Z\",\"url\":\"https://api.github.com/teams/2343027/discussions/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2343027/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0}}" + "data": "{\"id\":80,\"node_id\":\"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"This is close to perfect! Please address the suggested inline change. And add more about this.\",\"commit_id\":\"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\"state\":\"CHANGES_REQUESTED\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\"_links\":{\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\"}}}" } ] } ], - "renamed": { - "before": { "scope": "teams", "id": "updateDiscussion" }, - "after": { "scope": "teams", "id": "updateDiscussionLegacy" }, - "date": "2020-01-16", - "note": "The path for \"Edit a discussion\" changed from \"/teams/{team_id}*\" to \"/orgs/{org}/teams/{team_slug}*\"). The operation ID for the old path now has a \"-legacy\" suffix. The route with the new path has a \"-for-org\" suffix in the operation ID to avoid breaking changes" - } - }, - { - "name": "Delete a discussion (Legacy)", - "scope": "teams", - "id": "deleteDiscussionLegacy", - "method": "DELETE", - "url": "/teams/{team_id}/discussions/{discussion_number}", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://developer.github.com/v3/teams/discussions/#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://developer.github.com/v3/teams/discussions/#delete-a-discussion-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "team_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "discussion_number", - "description": "discussion_number parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [], "renamed": null }, { - "name": "Delete a discussion (Legacy)", - "scope": "teams", - "id": "deleteDiscussion", - "method": "DELETE", - "url": "/teams/{team_id}/discussions/{discussion_number}", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://developer.github.com/v3/teams/discussions/#delete-a-discussion) endpoint.\n\nDelete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://developer.github.com/v3/teams/discussions/#delete-a-discussion-legacy", + "name": "Get comments for a single review", + "scope": "pulls", + "id": "getCommentsForReview", + "method": "GET", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments", + "isDeprecated": false, + "isLegacy": false, + "description": "", + "documentationUrl": "https://developer.github.com/v3/pulls/reviews/#get-comments-for-a-single-review", "previews": [], "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -39477,10 +31387,10 @@ "deprecated": null }, { - "name": "discussion_number", - "description": "discussion_number parameter", + "name": "repo", + "description": "repo parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -39488,32 +31398,10 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [], - "renamed": { - "before": { "scope": "teams", "id": "deleteDiscussion" }, - "after": { "scope": "teams", "id": "deleteDiscussionLegacy" }, - "date": "2020-01-16", - "note": "The path for \"Delete a discussion\" changed from \"/teams/{team_id}*\" to \"/orgs/{org}/teams/{team_slug}*\"). The operation ID for the old path now has a \"-legacy\" suffix. The route with the new path has a \"-for-org\" suffix in the operation ID to avoid breaking changes" - } - }, - { - "name": "List comments (Legacy)", - "scope": "teams", - "id": "listDiscussionCommentsLegacy", - "method": "GET", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List comments`](https://developer.github.com/v3/teams/discussion_comments/#list-comments) endpoint.\n\nList all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://developer.github.com/v3/teams/discussion_comments/#list-comments-legacy", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "team_id", - "description": "team_id parameter", + "name": "pull_number", + "description": "pull_number parameter", "in": "PATH", "type": "integer", "required": true, @@ -39525,8 +31413,8 @@ "deprecated": null }, { - "name": "discussion_number", - "description": "discussion_number parameter", + "name": "review_id", + "description": "review_id parameter", "in": "PATH", "type": "integer", "required": true, @@ -39537,19 +31425,6 @@ "alias": null, "deprecated": null }, - { - "name": "direction", - "description": "Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, { "name": "per_page", "description": "Results per page (max 100)", @@ -39583,7 +31458,7 @@ "description": "response", "examples": [ { - "data": "[{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Do you like apples?\",\"body_html\":\"

Do you like apples?

\",\"body_version\":\"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":null,\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-15T23:53:58Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0}}]" + "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\",\"id\":10,\"node_id\":\"MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw\",\"pull_request_review_id\":42,\"diff_hunk\":\"@@ -16,33 +16,40 @@ public class Connection : IConnection...\",\"path\":\"file1.txt\",\"position\":1,\"original_position\":4,\"commit_id\":\"6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"original_commit_id\":\"9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840\",\"in_reply_to_id\":8,\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Great stuff!\",\"created_at\":\"2011-04-14T16:00:49Z\",\"updated_at\":\"2011-04-14T16:00:49Z\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\",\"author_association\":\"NONE\",\"_links\":{\"self\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/comments/1\"},\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/1#discussion-diff-1\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/1\"}}}]" } ] } @@ -39591,23 +31466,23 @@ "renamed": null }, { - "name": "List comments (Legacy)", - "scope": "teams", - "id": "listDiscussionComments", - "method": "GET", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List comments`](https://developer.github.com/v3/teams/discussion_comments/#list-comments) endpoint.\n\nList all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://developer.github.com/v3/teams/discussion_comments/#list-comments-legacy", + "name": "Dismiss a pull request review", + "scope": "pulls", + "id": "dismissReview", + "method": "PUT", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals", + "isDeprecated": false, + "isLegacy": false, + "description": "**Note:** To dismiss a pull request review on a [protected branch](https://developer.github.com/v3/repos/branches/), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews.", + "documentationUrl": "https://developer.github.com/v3/pulls/reviews/#dismiss-a-pull-request-review", "previews": [], "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -39617,10 +31492,10 @@ "deprecated": null }, { - "name": "discussion_number", - "description": "discussion_number parameter", + "name": "repo", + "description": "repo parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -39630,12 +31505,12 @@ "deprecated": null }, { - "name": "direction", - "description": "Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": ["asc", "desc"], + "name": "pull_number", + "description": "pull_number parameter", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -39643,11 +31518,11 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", + "name": "review_id", + "description": "review_id parameter", + "in": "PATH", "type": "integer", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -39656,11 +31531,11 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "message", + "description": "The message for the pull request review dismissal", + "in": "BODY", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -39675,36 +31550,31 @@ "description": "response", "examples": [ { - "data": "[{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Do you like apples?\",\"body_html\":\"

Do you like apples?

\",\"body_version\":\"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":null,\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-15T23:53:58Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0}}]" + "data": "{\"id\":80,\"node_id\":\"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Here is the body for the review.\",\"commit_id\":\"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\"state\":\"DISMISSED\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\"_links\":{\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\"}}}" } ] } ], - "renamed": { - "before": { "scope": "teams", "id": "listDiscussionComments" }, - "after": { "scope": "teams", "id": "listDiscussionCommentsLegacy" }, - "date": "2020-01-16", - "note": "The path for \"List comments\" changed from \"/teams/{team_id}*\" to \"/orgs/{org}/teams/{team_slug}*\"). The operation ID for the old path now has a \"-legacy\" suffix. The route with the new path has a \"-for-org\" suffix in the operation ID to avoid breaking changes" - } + "renamed": null }, { - "name": "Create a comment (Legacy)", - "scope": "teams", - "id": "createDiscussionCommentLegacy", + "name": "Submit a pull request review", + "scope": "pulls", + "id": "submitReview", "method": "POST", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a comment`](https://developer.github.com/v3/teams/discussion_comments/#create-a-comment) endpoint.\n\nCreates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.", - "documentationUrl": "https://developer.github.com/v3/teams/discussion_comments/#create-a-comment-legacy", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events", + "isDeprecated": false, + "isLegacy": false, + "description": "", + "documentationUrl": "https://developer.github.com/v3/pulls/reviews/#submit-a-pull-request-review", "previews": [], "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -39714,10 +31584,10 @@ "deprecated": null }, { - "name": "discussion_number", - "description": "discussion_number parameter", + "name": "repo", + "description": "repo parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -39727,10 +31597,10 @@ "deprecated": null }, { - "name": "body", - "description": "The discussion comment's body text.", - "in": "BODY", - "type": "string", + "name": "pull_number", + "description": "pull_number parameter", + "in": "PATH", + "type": "integer", "required": true, "enum": null, "allowNull": false, @@ -39738,37 +31608,10 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "response", - "examples": [ - { - "data": "{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Do you like apples?\",\"body_html\":\"

Do you like apples?

\",\"body_version\":\"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":null,\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-15T23:53:58Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0}}" - } - ] - } - ], - "renamed": null - }, - { - "name": "Create a comment (Legacy)", - "scope": "teams", - "id": "createDiscussionComment", - "method": "POST", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a comment`](https://developer.github.com/v3/teams/discussion_comments/#create-a-comment) endpoint.\n\nCreates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.", - "documentationUrl": "https://developer.github.com/v3/teams/discussion_comments/#create-a-comment-legacy", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "team_id", - "description": "team_id parameter", + "name": "review_id", + "description": "review_id parameter", "in": "PATH", "type": "integer", "required": true, @@ -39780,11 +31623,11 @@ "deprecated": null }, { - "name": "discussion_number", - "description": "discussion_number parameter", - "in": "PATH", - "type": "integer", - "required": true, + "name": "body", + "description": "The body text of the pull request review", + "in": "BODY", + "type": "string", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -39793,12 +31636,12 @@ "deprecated": null }, { - "name": "body", - "description": "The discussion comment's body text.", + "name": "event", + "description": "The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action.", "in": "BODY", "type": "string", "required": true, - "enum": null, + "enum": ["APPROVE", "REQUEST_CHANGES", "COMMENT"], "allowNull": false, "mapToData": null, "validation": null, @@ -39808,40 +31651,41 @@ ], "responses": [ { - "code": 201, + "code": 200, "description": "response", "examples": [ { - "data": "{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Do you like apples?\",\"body_html\":\"

Do you like apples?

\",\"body_version\":\"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":null,\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-15T23:53:58Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0}}" + "data": "{\"id\":80,\"node_id\":\"MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Here is the body for the review.\",\"submitted_at\":\"2019-11-17T17:43:43Z\",\"commit_id\":\"ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091\",\"state\":\"APPROVED\",\"html_url\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\",\"pull_request_url\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\",\"_links\":{\"html\":{\"href\":\"https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80\"},\"pull_request\":{\"href\":\"https://api.github.com/repos/octocat/Hello-World/pulls/12\"}}}" } ] } ], - "renamed": { - "before": { "scope": "teams", "id": "createDiscussionComment" }, - "after": { "scope": "teams", "id": "createDiscussionCommentLegacy" }, - "date": "2020-01-16", - "note": "The path for \"Create a comment\" changed from \"/teams/{team_id}*\" to \"/orgs/{org}/teams/{team_slug}*\"). The operation ID for the old path now has a \"-legacy\" suffix. The route with the new path has a \"-for-org\" suffix in the operation ID to avoid breaking changes" - } + "renamed": null }, { - "name": "Get a single comment (Legacy)", - "scope": "teams", - "id": "getDiscussionCommentLegacy", - "method": "GET", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Get a single comment`](https://developer.github.com/v3/teams/discussion_comments/#get-a-single-comment) endpoint.\n\nGet a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://developer.github.com/v3/teams/discussion_comments/#get-a-single-comment-legacy", - "previews": [], - "headers": [], + "name": "Update a pull request branch", + "scope": "pulls", + "id": "updateBranch", + "method": "PUT", + "url": "/repos/{owner}/{repo}/pulls/{pull_number}/update-branch", + "isDeprecated": false, + "isLegacy": false, + "description": "Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.", + "documentationUrl": "https://developer.github.com/v3/pulls/#update-a-pull-request-branch", + "previews": [{ "name": "lydian" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.lydian-preview+json", + "required": true + } + ], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -39851,10 +31695,10 @@ "deprecated": null }, { - "name": "discussion_number", - "description": "discussion_number parameter", + "name": "repo", + "description": "repo parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -39864,8 +31708,8 @@ "deprecated": null }, { - "name": "comment_number", - "description": "comment_number parameter", + "name": "pull_number", + "description": "pull_number parameter", "in": "PATH", "type": "integer", "required": true, @@ -39875,15 +31719,28 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "expected_head_sha", + "description": "The expected SHA of the pull request's HEAD ref. This is the most recent commit on the pull request's branch. If the expected SHA does not match the pull request's HEAD, you will receive a `422 Unprocessable Entity` status. You can use the \"[List commits on a repository](https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository)\" endpoint to find the most recent commit SHA. Default: SHA of the pull request's current HEAD ref.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ { - "code": 200, + "code": 202, "description": "response", "examples": [ { - "data": "{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Do you like apples?\",\"body_html\":\"

Do you like apples?

\",\"body_version\":\"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":null,\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-15T23:53:58Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0}}" + "data": "{\"message\":\"Updating pull request branch.\",\"url\":\"https://github.com/repos/octocat/Hello-World/pulls/53\"}" } ] } @@ -39891,23 +31748,23 @@ "renamed": null }, { - "name": "Get a single comment (Legacy)", - "scope": "teams", - "id": "getDiscussionComment", + "name": "Get the README", + "scope": "repos", + "id": "getReadme", "method": "GET", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Get a single comment`](https://developer.github.com/v3/teams/discussion_comments/#get-a-single-comment) endpoint.\n\nGet a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://developer.github.com/v3/teams/discussion_comments/#get-a-single-comment-legacy", + "url": "/repos/{owner}/{repo}/readme", + "isDeprecated": false, + "isLegacy": false, + "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://developer.github.com/v3/repos/contents/#custom-media-types) for retrieving the raw content or rendered HTML.", + "documentationUrl": "https://developer.github.com/v3/repos/contents/#get-the-readme", "previews": [], "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -39917,10 +31774,10 @@ "deprecated": null }, { - "name": "discussion_number", - "description": "discussion_number parameter", + "name": "repo", + "description": "repo parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -39930,11 +31787,11 @@ "deprecated": null }, { - "name": "comment_number", - "description": "comment_number parameter", - "in": "PATH", - "type": "integer", - "required": true, + "name": "ref", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", + "in": "QUERY", + "type": "string", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -39949,36 +31806,31 @@ "description": "response", "examples": [ { - "data": "{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Do you like apples?\",\"body_html\":\"

Do you like apples?

\",\"body_version\":\"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":null,\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-15T23:53:58Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0}}" + "data": "{\"type\":\"file\",\"encoding\":\"base64\",\"size\":5362,\"name\":\"README.md\",\"path\":\"README.md\",\"content\":\"encoded content ...\",\"sha\":\"3d21ec53a331a6f037a91c368710b99387d012c1\",\"url\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"git_url\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"html_url\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\",\"download_url\":\"https://raw.githubusercontent.com/octokit/octokit.rb/master/README.md\",\"_links\":{\"git\":\"https://api.github.com/repos/octokit/octokit.rb/git/blobs/3d21ec53a331a6f037a91c368710b99387d012c1\",\"self\":\"https://api.github.com/repos/octokit/octokit.rb/contents/README.md\",\"html\":\"https://github.com/octokit/octokit.rb/blob/master/README.md\"}}" } ] } ], - "renamed": { - "before": { "scope": "teams", "id": "getDiscussionComment" }, - "after": { "scope": "teams", "id": "getDiscussionCommentLegacy" }, - "date": "2020-01-16", - "note": "The path for \"Get a single comment\" changed from \"/teams/{team_id}*\" to \"/orgs/{org}/teams/{team_slug}*\"). The operation ID for the old path now has a \"-legacy\" suffix. The route with the new path has a \"-for-org\" suffix in the operation ID to avoid breaking changes" - } + "renamed": null }, { - "name": "Edit a comment (Legacy)", - "scope": "teams", - "id": "updateDiscussionCommentLegacy", - "method": "PATCH", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Edit a comment`](https://developer.github.com/v3/teams/discussion_comments/#edit-a-comment) endpoint.\n\nEdits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://developer.github.com/v3/teams/discussion_comments/#edit-a-comment-legacy", + "name": "List releases for a repository", + "scope": "repos", + "id": "listReleases", + "method": "GET", + "url": "/repos/{owner}/{repo}/releases", + "isDeprecated": false, + "isLegacy": false, + "description": "This returns a list of releases, which does not include regular Git tags that have not been associated with a release. To get a list of Git tags, use the [Repository Tags API](https://developer.github.com/v3/repos/#list-tags).\n\nInformation about published releases are available to everyone. Only users with push access will receive listings for draft releases.", + "documentationUrl": "https://developer.github.com/v3/repos/releases/#list-releases-for-a-repository", "previews": [], "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -39988,10 +31840,10 @@ "deprecated": null }, { - "name": "discussion_number", - "description": "discussion_number parameter", + "name": "repo", + "description": "repo parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -40001,11 +31853,11 @@ "deprecated": null }, { - "name": "comment_number", - "description": "comment_number parameter", - "in": "PATH", + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", "type": "integer", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -40014,11 +31866,11 @@ "deprecated": null }, { - "name": "body", - "description": "The discussion comment's body text.", - "in": "BODY", - "type": "string", - "required": true, + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -40033,7 +31885,7 @@ "description": "response", "examples": [ { - "data": "{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Do you like pineapples?\",\"body_html\":\"

Do you like pineapples?

\",\"body_version\":\"e6907b24d9c93cc0c5024a7af5888116\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":\"2018-01-26T18:22:20Z\",\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-26T18:22:20Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0}}" + "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1\",\"html_url\":\"https://github.com/octocat/Hello-World/releases/v1.0.0\",\"assets_url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\"upload_url\":\"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\"tarball_url\":\"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\"zipball_url\":\"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\"id\":1,\"node_id\":\"MDc6UmVsZWFzZTE=\",\"tag_name\":\"v1.0.0\",\"target_commitish\":\"master\",\"name\":\"v1.0.0\",\"body\":\"Description of the release\",\"draft\":false,\"prerelease\":false,\"created_at\":\"2013-02-27T19:35:32Z\",\"published_at\":\"2013-02-27T19:35:32Z\",\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assets\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]}]" } ] } @@ -40041,23 +31893,23 @@ "renamed": null }, { - "name": "Edit a comment (Legacy)", - "scope": "teams", - "id": "updateDiscussionComment", - "method": "PATCH", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Edit a comment`](https://developer.github.com/v3/teams/discussion_comments/#edit-a-comment) endpoint.\n\nEdits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://developer.github.com/v3/teams/discussion_comments/#edit-a-comment-legacy", + "name": "Create a release", + "scope": "repos", + "id": "createRelease", + "method": "POST", + "url": "/repos/{owner}/{repo}/releases", + "isDeprecated": false, + "isLegacy": false, + "description": "Users with push access to the repository can create a release.\n\nThis endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See \"[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)\" for details.", + "documentationUrl": "https://developer.github.com/v3/repos/releases/#create-a-release", "previews": [], "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -40067,10 +31919,10 @@ "deprecated": null }, { - "name": "discussion_number", - "description": "discussion_number parameter", + "name": "repo", + "description": "repo parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -40080,10 +31932,10 @@ "deprecated": null }, { - "name": "comment_number", - "description": "comment_number parameter", - "in": "PATH", - "type": "integer", + "name": "tag_name", + "description": "The name of the tag.", + "in": "BODY", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -40092,12 +31944,64 @@ "alias": null, "deprecated": null }, + { + "name": "target_commitish", + "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`).", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "name", + "description": "The name of the release.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "body", - "description": "The discussion comment's body text.", + "description": "Text describing the contents of the tag.", "in": "BODY", "type": "string", - "required": true, + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "draft", + "description": "`true` to create a draft (unpublished) release, `false` to create a published one.", + "in": "BODY", + "type": "boolean", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "prerelease", + "description": "`true` to identify the release as a prerelease. `false` to identify the release as a full release.", + "in": "BODY", + "type": "boolean", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -40108,40 +32012,35 @@ ], "responses": [ { - "code": 200, + "code": 201, "description": "response", "examples": [ { - "data": "{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"body\":\"Do you like pineapples?\",\"body_html\":\"

Do you like pineapples?

\",\"body_version\":\"e6907b24d9c93cc0c5024a7af5888116\",\"created_at\":\"2018-01-15T23:53:58Z\",\"last_edited_at\":\"2018-01-26T18:22:20Z\",\"discussion_url\":\"https://api.github.com/teams/2403582/discussions/1\",\"html_url\":\"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\"node_id\":\"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\"number\":1,\"updated_at\":\"2018-01-26T18:22:20Z\",\"url\":\"https://api.github.com/teams/2403582/discussions/1/comments/1\",\"reactions\":{\"url\":\"https://api.github.com/teams/2403582/discussions/1/reactions\",\"total_count\":5,\"+1\":3,\"-1\":1,\"laugh\":0,\"confused\":0,\"heart\":1,\"hooray\":0}}" + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1\",\"html_url\":\"https://github.com/octocat/Hello-World/releases/v1.0.0\",\"assets_url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\"upload_url\":\"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\"tarball_url\":\"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\"zipball_url\":\"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\"id\":1,\"node_id\":\"MDc6UmVsZWFzZTE=\",\"tag_name\":\"v1.0.0\",\"target_commitish\":\"master\",\"name\":\"v1.0.0\",\"body\":\"Description of the release\",\"draft\":false,\"prerelease\":false,\"created_at\":\"2013-02-27T19:35:32Z\",\"published_at\":\"2013-02-27T19:35:32Z\",\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assets\":[]}" } ] } ], - "renamed": { - "before": { "scope": "teams", "id": "updateDiscussionComment" }, - "after": { "scope": "teams", "id": "updateDiscussionCommentLegacy" }, - "date": "2020-01-16", - "note": "The path for \"Edit a comment\" changed from \"/teams/{team_id}*\" to \"/orgs/{org}/teams/{team_slug}*\"). The operation ID for the old path now has a \"-legacy\" suffix. The route with the new path has a \"-for-org\" suffix in the operation ID to avoid breaking changes" - } + "renamed": null }, { - "name": "Delete a comment (Legacy)", - "scope": "teams", - "id": "deleteDiscussionCommentLegacy", - "method": "DELETE", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a comment`](https://developer.github.com/v3/teams/discussion_comments/#delete-a-comment) endpoint.\n\nDeletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://developer.github.com/v3/teams/discussion_comments/#delete-a-comment-legacy", + "name": "Get a single release asset", + "scope": "repos", + "id": "getReleaseAsset", + "method": "GET", + "url": "/repos/{owner}/{repo}/releases/assets/{asset_id}", + "isDeprecated": false, + "isLegacy": false, + "description": "To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://developer.github.com/v3/media/#media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.", + "documentationUrl": "https://developer.github.com/v3/repos/releases/#get-a-single-release-asset", "previews": [], "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -40151,10 +32050,10 @@ "deprecated": null }, { - "name": "discussion_number", - "description": "discussion_number parameter", + "name": "repo", + "description": "repo parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -40164,8 +32063,8 @@ "deprecated": null }, { - "name": "comment_number", - "description": "comment_number parameter", + "name": "asset_id", + "description": "asset_id parameter", "in": "PATH", "type": "integer", "required": true, @@ -40177,27 +32076,37 @@ "deprecated": null } ], - "responses": [], + "responses": [ + { + "code": 200, + "description": "To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://developer.github.com/v3/media/#media-types). The API will either redirect the client to the location, or stream it directly if possible. API clients should handle both a `200` or `302` response.", + "examples": [ + { + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" + } + ] + } + ], "renamed": null }, { - "name": "Delete a comment (Legacy)", - "scope": "teams", - "id": "deleteDiscussionComment", - "method": "DELETE", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a comment`](https://developer.github.com/v3/teams/discussion_comments/#delete-a-comment) endpoint.\n\nDeletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://developer.github.com/v3/teams/discussion_comments/#delete-a-comment-legacy", + "name": "Edit a release asset", + "scope": "repos", + "id": "updateReleaseAsset", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/releases/assets/{asset_id}", + "isDeprecated": false, + "isLegacy": false, + "description": "Users with push access to the repository can edit a release asset.", + "documentationUrl": "https://developer.github.com/v3/repos/releases/#edit-a-release-asset", "previews": [], "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -40207,10 +32116,10 @@ "deprecated": null }, { - "name": "discussion_number", - "description": "discussion_number parameter", + "name": "repo", + "description": "repo parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -40220,8 +32129,8 @@ "deprecated": null }, { - "name": "comment_number", - "description": "comment_number parameter", + "name": "asset_id", + "description": "asset_id parameter", "in": "PATH", "type": "integer", "required": true, @@ -40231,39 +32140,65 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "name", + "description": "The file name of the asset.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "label", + "description": "An alternate short description of the asset. Used in place of the filename.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], - "responses": [], - "renamed": { - "before": { "scope": "teams", "id": "deleteDiscussionComment" }, - "after": { "scope": "teams", "id": "deleteDiscussionCommentLegacy" }, - "date": "2020-01-16", - "note": "The path for \"Delete a comment\" changed from \"/teams/{team_id}*\" to \"/orgs/{org}/teams/{team_slug}*\"). The operation ID for the old path now has a \"-legacy\" suffix. The route with the new path has a \"-for-org\" suffix in the operation ID to avoid breaking changes" - } - }, - { - "name": "List reactions for a team discussion comment (Legacy)", - "scope": "reactions", - "id": "listForTeamDiscussionCommentLegacy", - "method": "GET", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-comment) endpoint.\n\nList the reactions to a [team discussion comment](https://developer.github.com/v3/teams/discussion_comments/). OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-comment-legacy", - "previews": [{ "name": "squirrel-girl" }], - "headers": [ + "responses": [ { - "name": "accept", - "value": "application/vnd.github.squirrel-girl-preview+json" + "code": 200, + "description": "response", + "examples": [ + { + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" + } + ] } ], + "renamed": null + }, + { + "name": "Delete a release asset", + "scope": "repos", + "id": "deleteReleaseAsset", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/releases/assets/{asset_id}", + "isDeprecated": false, + "isLegacy": false, + "description": "", + "documentationUrl": "https://developer.github.com/v3/repos/releases/#delete-a-release-asset", + "previews": [], + "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -40273,10 +32208,10 @@ "deprecated": null }, { - "name": "discussion_number", - "description": "discussion_number parameter", + "name": "repo", + "description": "repo parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -40286,8 +32221,8 @@ "deprecated": null }, { - "name": "comment_number", - "description": "comment_number parameter", + "name": "asset_id", + "description": "asset_id parameter", "in": "PATH", "type": "integer", "required": true, @@ -40297,35 +32232,30 @@ "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [], + "renamed": null + }, + { + "name": "Get the latest release", + "scope": "repos", + "id": "getLatestRelease", + "method": "GET", + "url": "/repos/{owner}/{repo}/releases/latest", + "isDeprecated": false, + "isLegacy": false, + "description": "View the latest published full release for the repository.\n\nThe latest release is the most recent non-prerelease, non-draft release, sorted by the `created_at` attribute. The `created_at` attribute is the date of the commit used for the release, and not the date when the release was drafted or published.", + "documentationUrl": "https://developer.github.com/v3/repos/releases/#get-the-latest-release", + "previews": [], + "headers": [], + "parameters": [ { - "name": "content", - "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion comment.", - "in": "QUERY", + "name": "owner", + "description": "owner parameter", + "in": "PATH", "type": "string", - "required": false, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -40334,11 +32264,11 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "repo", + "description": "repo parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -40353,7 +32283,7 @@ "description": "response", "examples": [ { - "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1\",\"html_url\":\"https://github.com/octocat/Hello-World/releases/v1.0.0\",\"assets_url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\"upload_url\":\"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\"tarball_url\":\"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\"zipball_url\":\"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\"id\":1,\"node_id\":\"MDc6UmVsZWFzZTE=\",\"tag_name\":\"v1.0.0\",\"target_commitish\":\"master\",\"name\":\"v1.0.0\",\"body\":\"Description of the release\",\"draft\":false,\"prerelease\":false,\"created_at\":\"2013-02-27T19:35:32Z\",\"published_at\":\"2013-02-27T19:35:32Z\",\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assets\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]}" } ] } @@ -40361,28 +32291,23 @@ "renamed": null }, { - "name": "List reactions for a team discussion comment (Legacy)", - "scope": "reactions", - "id": "listForTeamDiscussionComment", + "name": "Get a release by tag name", + "scope": "repos", + "id": "getReleaseByTag", "method": "GET", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-comment) endpoint.\n\nList the reactions to a [team discussion comment](https://developer.github.com/v3/teams/discussion_comments/). OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-comment-legacy", - "previews": [{ "name": "squirrel-girl" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.squirrel-girl-preview+json" - } - ], + "url": "/repos/{owner}/{repo}/releases/tags/{tag}", + "isDeprecated": false, + "isLegacy": false, + "description": "Get a published release with the specified tag.", + "documentationUrl": "https://developer.github.com/v3/repos/releases/#get-a-release-by-tag-name", + "previews": [], + "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -40392,10 +32317,10 @@ "deprecated": null }, { - "name": "discussion_number", - "description": "discussion_number parameter", + "name": "repo", + "description": "repo parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -40405,59 +32330,11 @@ "deprecated": null }, { - "name": "comment_number", - "description": "comment_number parameter", + "name": "tag", + "description": "tag parameter", "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion comment.", - "in": "QUERY", "type": "string", - "required": false, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -40472,44 +32349,31 @@ "description": "response", "examples": [ { - "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1\",\"html_url\":\"https://github.com/octocat/Hello-World/releases/v1.0.0\",\"assets_url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\"upload_url\":\"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\"tarball_url\":\"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\"zipball_url\":\"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\"id\":1,\"node_id\":\"MDc6UmVsZWFzZTE=\",\"tag_name\":\"v1.0.0\",\"target_commitish\":\"master\",\"name\":\"v1.0.0\",\"body\":\"Description of the release\",\"draft\":false,\"prerelease\":false,\"created_at\":\"2013-02-27T19:35:32Z\",\"published_at\":\"2013-02-27T19:35:32Z\",\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assets\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]}" } ] } ], - "renamed": { - "before": { "scope": "reactions", "id": "listForTeamDiscussionComment" }, - "after": { - "scope": "reactions", - "id": "listForTeamDiscussionCommentLegacy" - }, - "date": "2020-01-16", - "note": "The path for \"List reactions for a team discussion comment\" changed from \"/teams/{team_id}*\" to \"/orgs/{org}/teams/{team_slug}*\"). The operation ID for the old path now has a \"-legacy\" suffix. The route with the new path has a \"-for-org\" suffix in the operation ID to avoid breaking changes" - } + "renamed": null }, { - "name": "Create reaction for a team discussion comment (Legacy)", - "scope": "reactions", - "id": "createForTeamDiscussionCommentLegacy", - "method": "POST", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion comment`](https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-comment) endpoint.\n\nCreate a reaction to a [team discussion comment](https://developer.github.com/v3/teams/discussion_comments/). OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment.", - "documentationUrl": "https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-comment-legacy", - "previews": [{ "name": "squirrel-girl" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.squirrel-girl-preview+json" - } - ], + "name": "Get a single release", + "scope": "repos", + "id": "getRelease", + "method": "GET", + "url": "/repos/{owner}/{repo}/releases/{release_id}", + "isDeprecated": false, + "isLegacy": false, + "description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://developer.github.com/v3/#hypermedia).", + "documentationUrl": "https://developer.github.com/v3/repos/releases/#get-a-single-release", + "previews": [], + "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -40519,10 +32383,10 @@ "deprecated": null }, { - "name": "discussion_number", - "description": "discussion_number parameter", + "name": "repo", + "description": "repo parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -40532,8 +32396,8 @@ "deprecated": null }, { - "name": "comment_number", - "description": "comment_number parameter", + "name": "release_id", + "description": "release_id parameter", "in": "PATH", "type": "integer", "required": true, @@ -40543,37 +32407,15 @@ "validation": null, "alias": null, "deprecated": null - }, - { - "name": "content", - "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion comment.", - "in": "BODY", - "type": "string", - "required": true, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null } ], "responses": [ { - "code": 201, - "description": "response", + "code": 200, + "description": "**Note:** This returns an `upload_url` key corresponding to the endpoint for uploading release assets. This key is a [hypermedia resource](https://developer.github.com/v3/#hypermedia).", "examples": [ { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1\",\"html_url\":\"https://github.com/octocat/Hello-World/releases/v1.0.0\",\"assets_url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\"upload_url\":\"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\"tarball_url\":\"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\"zipball_url\":\"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\"id\":1,\"node_id\":\"MDc6UmVsZWFzZTE=\",\"tag_name\":\"v1.0.0\",\"target_commitish\":\"master\",\"name\":\"v1.0.0\",\"body\":\"Description of the release\",\"draft\":false,\"prerelease\":false,\"created_at\":\"2013-02-27T19:35:32Z\",\"published_at\":\"2013-02-27T19:35:32Z\",\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assets\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]}" } ] } @@ -40581,28 +32423,23 @@ "renamed": null }, { - "name": "Create reaction for a team discussion comment (Legacy)", - "scope": "reactions", - "id": "createForTeamDiscussionComment", - "method": "POST", - "url": "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion comment`](https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-comment) endpoint.\n\nCreate a reaction to a [team discussion comment](https://developer.github.com/v3/teams/discussion_comments/). OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment.", - "documentationUrl": "https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-comment-legacy", - "previews": [{ "name": "squirrel-girl" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.squirrel-girl-preview+json" - } - ], + "name": "Edit a release", + "scope": "repos", + "id": "updateRelease", + "method": "PATCH", + "url": "/repos/{owner}/{repo}/releases/{release_id}", + "isDeprecated": false, + "isLegacy": false, + "description": "Users with push access to the repository can edit a release.", + "documentationUrl": "https://developer.github.com/v3/repos/releases/#edit-a-release", + "previews": [], + "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -40612,10 +32449,10 @@ "deprecated": null }, { - "name": "discussion_number", - "description": "discussion_number parameter", + "name": "repo", + "description": "repo parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -40625,8 +32462,8 @@ "deprecated": null }, { - "name": "comment_number", - "description": "comment_number parameter", + "name": "release_id", + "description": "release_id parameter", "in": "PATH", "type": "integer", "required": true, @@ -40638,76 +32475,24 @@ "deprecated": null }, { - "name": "content", - "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion comment.", + "name": "tag_name", + "description": "The name of the tag.", "in": "BODY", "type": "string", - "required": true, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], + "required": false, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - } - ], - "renamed": { - "before": { - "scope": "reactions", - "id": "createForTeamDiscussionComment" }, - "after": { - "scope": "reactions", - "id": "createForTeamDiscussionCommentLegacy" - }, - "date": "2020-01-16", - "note": "The path for \"Create reaction for a team discussion comment\" changed from \"/teams/{team_id}*\" to \"/orgs/{org}/teams/{team_slug}*\"). The operation ID for the old path now has a \"-legacy\" suffix. The route with the new path has a \"-for-org\" suffix in the operation ID to avoid breaking changes" - } - }, - { - "name": "List reactions for a team discussion (Legacy)", - "scope": "reactions", - "id": "listForTeamDiscussionLegacy", - "method": "GET", - "url": "/teams/{team_id}/discussions/{discussion_number}/reactions", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion) endpoint.\n\nList the reactions to a [team discussion](https://developer.github.com/v3/teams/discussions/). OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-legacy", - "previews": [{ "name": "squirrel-girl" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.squirrel-girl-preview+json" - } - ], - "parameters": [ { - "name": "team_id", - "description": "team_id parameter", - "in": "PATH", - "type": "integer", - "required": true, + "name": "target_commitish", + "description": "Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository's default branch (usually `master`).", + "in": "BODY", + "type": "string", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -40716,11 +32501,11 @@ "deprecated": null }, { - "name": "discussion_number", - "description": "discussion_number parameter", - "in": "PATH", - "type": "integer", - "required": true, + "name": "name", + "description": "The name of the release.", + "in": "BODY", + "type": "string", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -40729,21 +32514,12 @@ "deprecated": null }, { - "name": "content", - "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion.", - "in": "QUERY", + "name": "body", + "description": "Text describing the contents of the tag.", + "in": "BODY", "type": "string", "required": false, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -40751,10 +32527,10 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", + "name": "draft", + "description": "`true` makes the release a draft, and `false` publishes the release.", + "in": "BODY", + "type": "boolean", "required": false, "enum": null, "allowNull": false, @@ -40764,10 +32540,10 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", + "name": "prerelease", + "description": "`true` to identify the release as a prerelease, `false` to identify the release as a full release.", + "in": "BODY", + "type": "boolean", "required": false, "enum": null, "allowNull": false, @@ -40783,7 +32559,7 @@ "description": "response", "examples": [ { - "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1\",\"html_url\":\"https://github.com/octocat/Hello-World/releases/v1.0.0\",\"assets_url\":\"https://api.github.com/repos/octocat/Hello-World/releases/1/assets\",\"upload_url\":\"https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}\",\"tarball_url\":\"https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0\",\"zipball_url\":\"https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0\",\"id\":1,\"node_id\":\"MDc6UmVsZWFzZTE=\",\"tag_name\":\"v1.0.0\",\"target_commitish\":\"master\",\"name\":\"v1.0.0\",\"body\":\"Description of the release\",\"draft\":false,\"prerelease\":false,\"created_at\":\"2013-02-27T19:35:32Z\",\"published_at\":\"2013-02-27T19:35:32Z\",\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"assets\":[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]}" } ] } @@ -40791,28 +32567,23 @@ "renamed": null }, { - "name": "List reactions for a team discussion (Legacy)", - "scope": "reactions", - "id": "listForTeamDiscussion", - "method": "GET", - "url": "/teams/{team_id}/discussions/{discussion_number}/reactions", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion) endpoint.\n\nList the reactions to a [team discussion](https://developer.github.com/v3/teams/discussions/). OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "documentationUrl": "https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-legacy", - "previews": [{ "name": "squirrel-girl" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.squirrel-girl-preview+json" - } - ], + "name": "Delete a release", + "scope": "repos", + "id": "deleteRelease", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/releases/{release_id}", + "isDeprecated": false, + "isLegacy": false, + "description": "Users with push access to the repository can delete a release.", + "documentationUrl": "https://developer.github.com/v3/repos/releases/#delete-a-release", + "previews": [], + "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -40822,10 +32593,10 @@ "deprecated": null }, { - "name": "discussion_number", - "description": "discussion_number parameter", + "name": "repo", + "description": "repo parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -40835,33 +32606,41 @@ "deprecated": null }, { - "name": "content", - "description": "Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion.", - "in": "QUERY", - "type": "string", - "required": false, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], + "name": "release_id", + "description": "release_id parameter", + "in": "PATH", + "type": "integer", + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [], + "renamed": null + }, + { + "name": "List assets for a release", + "scope": "repos", + "id": "listAssetsForRelease", + "method": "GET", + "url": "/repos/{owner}/{repo}/releases/{release_id}/assets", + "isDeprecated": false, + "isLegacy": false, + "description": "", + "documentationUrl": "https://developer.github.com/v3/repos/releases/#list-assets-for-a-release", + "previews": [], + "headers": [], + "parameters": [ { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "owner", + "description": "owner parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -40870,58 +32649,21 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "repo", + "description": "repo parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}]" - } - ] - } - ], - "renamed": { - "before": { "scope": "reactions", "id": "listForTeamDiscussion" }, - "after": { "scope": "reactions", "id": "listForTeamDiscussionLegacy" }, - "date": "2020-01-16", - "note": "The path for \"List reactions for a team discussion\" changed from \"/teams/{team_id}*\" to \"/orgs/{org}/teams/{team_slug}*\"). The operation ID for the old path now has a \"-legacy\" suffix. The route with the new path has a \"-for-org\" suffix in the operation ID to avoid breaking changes" - } - }, - { - "name": "Create reaction for a team discussion (Legacy)", - "scope": "reactions", - "id": "createForTeamDiscussionLegacy", - "method": "POST", - "url": "/teams/{team_id}/discussions/{discussion_number}/reactions", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion) endpoint.\n\nCreate a reaction to a [team discussion](https://developer.github.com/v3/teams/discussions/). OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion.", - "documentationUrl": "https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-legacy", - "previews": [{ "name": "squirrel-girl" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.squirrel-girl-preview+json" - } - ], - "parameters": [ + }, { - "name": "team_id", - "description": "team_id parameter", + "name": "release_id", + "description": "release_id parameter", "in": "PATH", "type": "integer", "required": true, @@ -40933,11 +32675,11 @@ "deprecated": null }, { - "name": "discussion_number", - "description": "discussion_number parameter", - "in": "PATH", + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", "type": "integer", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -40946,21 +32688,12 @@ "deprecated": null }, { - "name": "content", - "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion.", - "in": "BODY", - "type": "string", - "required": true, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -40970,11 +32703,11 @@ ], "responses": [ { - "code": 201, + "code": 200, "description": "response", "examples": [ { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" + "data": "[{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]" } ] } @@ -40982,28 +32715,26 @@ "renamed": null }, { - "name": "Create reaction for a team discussion (Legacy)", - "scope": "reactions", - "id": "createForTeamDiscussion", + "name": "Upload a release asset", + "scope": "repos", + "id": "uploadReleaseAsset", "method": "POST", - "url": "/teams/{team_id}/discussions/{discussion_number}/reactions", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion) endpoint.\n\nCreate a reaction to a [team discussion](https://developer.github.com/v3/teams/discussions/). OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion.", - "documentationUrl": "https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-legacy", - "previews": [{ "name": "squirrel-girl" }], + "url": "{origin}/repos/{owner}/{repo}/releases/{release_id}/assets{?name,label}", + "isDeprecated": false, + "isLegacy": false, + "description": "This endpoint makes use of [a Hypermedia relation](https://developer.github.com/v3/#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the `upload_url` returned in the response of the [Create a release endpoint](https://developer.github.com/v3/repos/releases/#create-a-release) to upload a release asset.\n\nYou need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint.\n\nMost libraries will set the required `Content-Length` header automatically. Use the required `Content-Type` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example:\n\n`application/zip`\n\nGitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example, you'll still need to pass your authentication to be able to upload an asset.\n\n**Notes:**\n\n* GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The \"[List assets for a release](https://developer.github.com/v3/repos/releases/#list-assets-for-a-release)\" endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://github.com/contact).\n* If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset.\n\nThis may leave an empty asset with a state of `starter`. It can be safely deleted.", + "documentationUrl": "https://developer.github.com/v3/repos/releases/#upload-a-release-asset", + "previews": [], "headers": [ - { - "name": "accept", - "value": "application/vnd.github.squirrel-girl-preview+json" - } + { "name": "content-length", "value": null, "required": true }, + { "name": "content-type", "value": null, "required": true } ], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -41013,10 +32744,10 @@ "deprecated": null }, { - "name": "discussion_number", - "description": "discussion_number parameter", + "name": "repo", + "description": "repo parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -41026,65 +32757,24 @@ "deprecated": null }, { - "name": "content", - "description": "The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion.", - "in": "BODY", - "type": "string", + "name": "release_id", + "description": "release_id parameter", + "in": "PATH", + "type": "integer", "required": true, - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 201, - "description": "response", - "examples": [ - { - "data": "{\"id\":1,\"node_id\":\"MDg6UmVhY3Rpb24x\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"content\":\"heart\",\"created_at\":\"2016-05-20T20:09:31Z\"}" - } - ] - } - ], - "renamed": { - "before": { "scope": "reactions", "id": "createForTeamDiscussion" }, - "after": { "scope": "reactions", "id": "createForTeamDiscussionLegacy" }, - "date": "2020-01-16", - "note": "The path for \"Create reaction for a team discussion\" changed from \"/teams/{team_id}*\" to \"/orgs/{org}/teams/{team_slug}*\"). The operation ID for the old path now has a \"-legacy\" suffix. The route with the new path has a \"-for-org\" suffix in the operation ID to avoid breaking changes" - } - }, - { - "name": "List pending team invitations (Legacy)", - "scope": "teams", - "id": "listPendingInvitationsLegacy", - "method": "GET", - "url": "/teams/{team_id}/invitations", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://developer.github.com/v3/teams/members/#list-pending-team-invitations) endpoint.\n\nThe return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.", - "documentationUrl": "https://developer.github.com/v3/teams/members/#list-pending-team-invitations-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "team_id parameter", - "in": "PATH", - "type": "integer", - "required": true, + "deprecated": null + }, + { + "name": "name", + "description": "name parameter", + "in": "QUERY", + "type": "string", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -41093,10 +32783,10 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", + "name": "label", + "description": "label parameter", "in": "QUERY", - "type": "integer", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -41106,13 +32796,26 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "data", + "description": "The raw file data", + "in": "BODY", + "type": "string", + "required": true, "enum": null, "allowNull": false, + "mapToData": true, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "origin", + "description": "The URL origin (protocol + host name + port) is included in `upload_url` returned in the response of the \"Create a release\" endpoint", + "in": "PATH", + "type": "string", + "required": null, + "enum": null, + "allowNull": null, "mapToData": null, "validation": null, "alias": null, @@ -41121,11 +32824,11 @@ ], "responses": [ { - "code": 200, - "description": "response", + "code": 201, + "description": "Response for successful upload", "examples": [ { - "data": "[{\"id\":1,\"login\":\"monalisa\",\"email\":\"octocat@github.com\",\"role\":\"direct_member\",\"created_at\":\"2016-11-30T06:46:10-08:00\",\"inviter\":{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false},\"team_count\":2,\"invitation_team_url\":\"https://api.github.com/organizations/2/invitations/1/teams\"}]" + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/releases/assets/1\",\"browser_download_url\":\"https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip\",\"id\":1,\"node_id\":\"MDEyOlJlbGVhc2VBc3NldDE=\",\"name\":\"example.zip\",\"label\":\"short description\",\"state\":\"uploaded\",\"content_type\":\"application/zip\",\"size\":1024,\"download_count\":42,\"created_at\":\"2013-02-27T19:35:32Z\",\"updated_at\":\"2013-02-27T19:35:32Z\",\"uploader\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" } ] } @@ -41133,23 +32836,36 @@ "renamed": null }, { - "name": "List pending team invitations (Legacy)", - "scope": "teams", - "id": "listPendingInvitations", + "name": "List Stargazers", + "scope": "activity", + "id": "listStargazersForRepo", "method": "GET", - "url": "/teams/{team_id}/invitations", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://developer.github.com/v3/teams/members/#list-pending-team-invitations) endpoint.\n\nThe return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`.", - "documentationUrl": "https://developer.github.com/v3/teams/members/#list-pending-team-invitations-legacy", + "url": "/repos/{owner}/{repo}/stargazers", + "isDeprecated": false, + "isLegacy": false, + "description": "You can also find out _when_ stars were created by passing the following custom [media type](https://developer.github.com/v3/media/) via the `Accept` header:", + "documentationUrl": "https://developer.github.com/v3/activity/starring/#list-stargazers", "previews": [], "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "repo parameter", + "in": "PATH", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -41191,36 +32907,40 @@ "description": "response", "examples": [ { - "data": "[{\"id\":1,\"login\":\"monalisa\",\"email\":\"octocat@github.com\",\"role\":\"direct_member\",\"created_at\":\"2016-11-30T06:46:10-08:00\",\"inviter\":{\"login\":\"other_user\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/other_user_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/other_user\",\"html_url\":\"https://github.com/other_user\",\"followers_url\":\"https://api.github.com/users/other_user/followers\",\"following_url\":\"https://api.github.com/users/other_user/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/other_user/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/other_user/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/other_user/subscriptions\",\"organizations_url\":\"https://api.github.com/users/other_user/orgs\",\"repos_url\":\"https://api.github.com/users/other_user/repos\",\"events_url\":\"https://api.github.com/users/other_user/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/other_user/received_events\",\"type\":\"User\",\"site_admin\":false},\"team_count\":2,\"invitation_team_url\":\"https://api.github.com/organizations/2/invitations/1/teams\"}]" + "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" + } + ] + }, + { + "code": 200, + "description": "response", + "examples": [ + { + "data": "[{\"starred_at\":\"2011-01-16T19:06:43Z\",\"user\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}]" } ] } ], - "renamed": { - "before": { "scope": "teams", "id": "listPendingInvitations" }, - "after": { "scope": "teams", "id": "listPendingInvitationsLegacy" }, - "date": "2020-01-16", - "note": "The path for \"List pending team invitations\" changed from \"/teams/{team_id}*\" to \"/orgs/{org}/teams/{team_slug}*\"). The operation ID for the old path now has a \"-legacy\" suffix. The route with the new path has a \"-for-org\" suffix in the operation ID to avoid breaking changes" - } + "renamed": null }, { - "name": "List team members (Legacy)", - "scope": "teams", - "id": "listMembersLegacy", + "name": "Get the number of additions and deletions per week", + "scope": "repos", + "id": "getCodeFrequencyStats", "method": "GET", - "url": "/teams/{team_id}/members", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://developer.github.com/v3/teams/members/#list-team-members) endpoint.\n\nTeam members will include the members of child teams.", - "documentationUrl": "https://developer.github.com/v3/teams/members/#list-team-members-legacy", + "url": "/repos/{owner}/{repo}/stats/code_frequency", + "isDeprecated": false, + "isLegacy": false, + "description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.\n\n", + "documentationUrl": "https://developer.github.com/v3/repos/statistics/#get-the-number-of-additions-and-deletions-per-week", "previews": [], "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -41230,24 +32950,47 @@ "deprecated": null }, { - "name": "role", - "description": "Filters members returned by their role in the team. Can be one of: \n\\* `member` - normal members of the team. \n\\* `maintainer` - team maintainers. \n\\* `all` - all members of the team.", - "in": "QUERY", + "name": "repo", + "description": "repo parameter", + "in": "PATH", "type": "string", - "required": false, - "enum": ["member", "maintainer", "all"], + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, + "code": 200, + "description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.", + "examples": [{ "data": "[[1302998400,1124,-435]]" }] + } + ], + "renamed": null + }, + { + "name": "Get the last year of commit activity data", + "scope": "repos", + "id": "getCommitActivityStats", + "method": "GET", + "url": "/repos/{owner}/{repo}/stats/commit_activity", + "isDeprecated": false, + "isLegacy": false, + "description": "Returns the last year of commit activity grouped by week. The `days` array is a group of commits per day, starting on `Sunday`.\n\n", + "documentationUrl": "https://developer.github.com/v3/repos/statistics/#get-the-last-year-of-commit-activity-data", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "owner parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -41256,11 +32999,11 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "repo", + "description": "repo parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -41275,7 +33018,7 @@ "description": "response", "examples": [ { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" + "data": "[{\"days\":[0,3,26,20,39,1,0],\"total\":89,\"week\":1336280400}]" } ] } @@ -41283,23 +33026,23 @@ "renamed": null }, { - "name": "List team members (Legacy)", - "scope": "teams", - "id": "listMembers", + "name": "Get contributors list with additions, deletions, and commit counts", + "scope": "repos", + "id": "getContributorsStats", "method": "GET", - "url": "/teams/{team_id}/members", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://developer.github.com/v3/teams/members/#list-team-members) endpoint.\n\nTeam members will include the members of child teams.", - "documentationUrl": "https://developer.github.com/v3/teams/members/#list-team-members-legacy", + "url": "/repos/{owner}/{repo}/stats/contributors", + "isDeprecated": false, + "isLegacy": false, + "description": "* `total` - The Total number of commits authored by the contributor.\n\nWeekly Hash (`weeks` array):\n\n* `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time).\n* `a` - Number of additions\n* `d` - Number of deletions\n* `c` - Number of commits\n\n", + "documentationUrl": "https://developer.github.com/v3/repos/statistics/#get-contributors-list-with-additions-deletions-and-commit-counts", "previews": [], "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -41309,24 +33052,51 @@ "deprecated": null }, { - "name": "role", - "description": "Filters members returned by their role in the team. Can be one of: \n\\* `member` - normal members of the team. \n\\* `maintainer` - team maintainers. \n\\* `all` - all members of the team.", - "in": "QUERY", + "name": "repo", + "description": "repo parameter", + "in": "PATH", "type": "string", - "required": false, - "enum": ["member", "maintainer", "all"], + "required": true, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, + "code": 200, + "description": "* `w` - Start of the week, given as a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time).\n* `a` - Number of additions\n* `d` - Number of deletions\n* `c` - Number of commits", + "examples": [ + { + "data": "[{\"author\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"total\":135,\"weeks\":[{\"w\":\"1367712000\",\"a\":6898,\"d\":77,\"c\":10}]}]" + } + ] + } + ], + "renamed": null + }, + { + "name": "Get the weekly commit count for the repository owner and everyone else", + "scope": "repos", + "id": "getParticipationStats", + "method": "GET", + "url": "/repos/{owner}/{repo}/stats/participation", + "isDeprecated": false, + "isLegacy": false, + "description": "Returns the total commit counts for the `owner` and total commit counts in `all`. `all` is everyone combined, including the `owner` in the last 52 weeks. If you'd like to get the commit counts for non-owners, you can subtract `owner` from `all`.\n\nThe array order is oldest week (index 0) to most recent week.\n\n", + "documentationUrl": "https://developer.github.com/v3/repos/statistics/#get-the-weekly-commit-count-for-the-repository-owner-and-everyone-else", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "owner", + "description": "owner parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -41335,11 +33105,11 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "repo", + "description": "repo parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -41351,39 +33121,34 @@ "responses": [ { "code": 200, - "description": "response", + "description": "The array order is oldest week (index 0) to most recent week.", "examples": [ { - "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" + "data": "{\"all\":[11,21,15,2,8,1,8,23,17,21,11,10,33,91,38,34,22,23,32,3,43,87,71,18,13,5,13,16,66,27,12,45,110,117,13,8,18,9,19,26,39,12,20,31,46,91,45,10,24,9,29,7],\"owner\":[3,2,3,0,2,0,5,14,7,9,1,5,0,48,19,2,0,1,10,2,23,40,35,8,8,2,10,6,30,0,2,9,53,104,3,3,10,4,7,11,21,4,4,22,26,63,11,2,14,1,10,3]}" } ] } ], - "renamed": { - "before": { "scope": "teams", "id": "listMembers" }, - "after": { "scope": "teams", "id": "listMembersLegacy" }, - "date": "2020-01-16", - "note": "The path for \"List team members\" changed from \"/teams/{team_id}*\" to \"/orgs/{org}/teams/{team_slug}*\"). The operation ID for the old path now has a \"-legacy\" suffix. The route with the new path has a \"-for-org\" suffix in the operation ID to avoid breaking changes" - } + "renamed": null }, { - "name": "Get team member (Legacy)", - "scope": "teams", - "id": "getMemberLegacy", + "name": "Get the number of commits per hour in each day", + "scope": "repos", + "id": "getPunchCardStats", "method": "GET", - "url": "/teams/{team_id}/members/{username}", - "isDeprecated": true, - "isLegacy": true, - "description": "The \"Get team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Get team membership](https://developer.github.com/v3/teams/members/#get-team-membership) endpoint instead. It allows you to get both active and pending memberships.\n\nTo list members in a team, the team must be visible to the authenticated user.", - "documentationUrl": "https://developer.github.com/v3/teams/members/#get-team-member-legacy", + "url": "/repos/{owner}/{repo}/stats/punch_card", + "isDeprecated": false, + "isLegacy": false, + "description": "Each array contains the day number, hour number, and number of commits:\n\n* `0-6`: Sunday - Saturday\n* `0-23`: Hour of day\n* Number of commits\n\nFor example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.", + "documentationUrl": "https://developer.github.com/v3/repos/statistics/#get-the-number-of-commits-per-hour-in-each-day", "previews": [], "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -41393,8 +33158,8 @@ "deprecated": null }, { - "name": "username", - "description": "username parameter", + "name": "repo", + "description": "repo parameter", "in": "PATH", "type": "string", "required": true, @@ -41406,27 +33171,33 @@ "deprecated": null } ], - "responses": [], + "responses": [ + { + "code": 200, + "description": "For example, `[2, 14, 25]` indicates that there were 25 total commits, during the 2:00pm hour on Tuesdays. All times are based on the time zone of individual commits.", + "examples": [{ "data": "[[0,0,5],[0,1,43],[0,2,21]]" }] + } + ], "renamed": null }, { - "name": "Get team member (Legacy)", - "scope": "teams", - "id": "getMember", - "method": "GET", - "url": "/teams/{team_id}/members/{username}", - "isDeprecated": true, - "isLegacy": true, - "description": "The \"Get team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Get team membership](https://developer.github.com/v3/teams/members/#get-team-membership) endpoint instead. It allows you to get both active and pending memberships.\n\nTo list members in a team, the team must be visible to the authenticated user.", - "documentationUrl": "https://developer.github.com/v3/teams/members/#get-team-member-legacy", + "name": "Create a status", + "scope": "repos", + "id": "createStatus", + "method": "POST", + "url": "/repos/{owner}/{repo}/statuses/{sha}", + "isDeprecated": false, + "isLegacy": false, + "description": "Users with push access in a repository can create commit statuses for a given SHA.\n\nNote: there is a limit of 1000 statuses per `sha` and `context` within a repository. Attempts to create more than 1000 statuses will result in a validation error.", + "documentationUrl": "https://developer.github.com/v3/repos/statuses/#create-a-status", "previews": [], "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -41436,8 +33207,8 @@ "deprecated": null }, { - "name": "username", - "description": "username parameter", + "name": "repo", + "description": "repo parameter", "in": "PATH", "type": "string", "required": true, @@ -41447,34 +33218,12 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [], - "renamed": { - "before": { "scope": "teams", "id": "getMember" }, - "after": { "scope": "teams", "id": "getMemberLegacy" }, - "date": "2020-01-16", - "note": "\"Get team member\" is now \"Get team member (Legacy)\"" - } - }, - { - "name": "Add team member (Legacy)", - "scope": "teams", - "id": "addMemberLegacy", - "method": "PUT", - "url": "/teams/{team_id}/members/{username}", - "isDeprecated": true, - "isLegacy": true, - "description": "The \"Add team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Add team membership](https://developer.github.com/v3/teams/members/#add-or-update-team-membership) endpoint instead. It allows you to invite new organization members to your teams.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\"", - "documentationUrl": "https://developer.github.com/v3/teams/members/#add-team-member-legacy", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "team_id", - "description": "team_id parameter", + "name": "sha", + "description": "sha parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -41484,11 +33233,50 @@ "deprecated": null }, { - "name": "username", - "description": "username parameter", - "in": "PATH", + "name": "state", + "description": "The state of the status. Can be one of `error`, `failure`, `pending`, or `success`.", + "in": "BODY", "type": "string", "required": true, + "enum": ["error", "failure", "pending", "success"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "target_url", + "description": "The target URL to associate with this status. This URL will be linked from the GitHub UI to allow users to easily see the source of the status. \nFor example, if your continuous integration system is posting build status, you would want to provide the deep link for the build output for this specific SHA: \n`http://ci.example.com/user/repo/build/sha`", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "description", + "description": "A short description of the status.", + "in": "BODY", + "type": "string", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "context", + "description": "A string label to differentiate this status from the status of other systems.", + "in": "BODY", + "type": "string", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -41499,14 +33287,11 @@ ], "responses": [ { - "code": 422, + "code": 201, "description": "response", "examples": [ { - "data": "{\"message\":\"Cannot add an organization as a member.\",\"errors\":[{\"code\":\"org\",\"field\":\"user\",\"resource\":\"TeamMember\"}]}" - }, - { - "data": "{\"message\":\"User isn't a member of this organization. Please invite them first.\",\"errors\":[{\"code\":\"unaffiliated\",\"field\":\"user\",\"resource\":\"TeamMember\"}]}" + "data": "{\"url\":\"https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e\",\"avatar_url\":\"https://github.com/images/error/hubot_happy.gif\",\"id\":1,\"node_id\":\"MDY6U3RhdHVzMQ==\",\"state\":\"success\",\"description\":\"Build has completed successfully\",\"target_url\":\"https://ci.example.com/1000/output\",\"context\":\"continuous-integration/jenkins\",\"created_at\":\"2012-07-20T01:19:13Z\",\"updated_at\":\"2012-07-20T01:19:13Z\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}}" } ] } @@ -41514,23 +33299,23 @@ "renamed": null }, { - "name": "Add team member (Legacy)", - "scope": "teams", - "id": "addMember", - "method": "PUT", - "url": "/teams/{team_id}/members/{username}", - "isDeprecated": true, - "isLegacy": true, - "description": "The \"Add team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Add team membership](https://developer.github.com/v3/teams/members/#add-or-update-team-membership) endpoint instead. It allows you to invite new organization members to your teams.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\"", - "documentationUrl": "https://developer.github.com/v3/teams/members/#add-team-member-legacy", + "name": "List watchers", + "scope": "activity", + "id": "listWatchersForRepo", + "method": "GET", + "url": "/repos/{owner}/{repo}/subscribers", + "isDeprecated": false, + "isLegacy": false, + "description": "", + "documentationUrl": "https://developer.github.com/v3/activity/watching/#list-watchers", "previews": [], "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -41540,8 +33325,8 @@ "deprecated": null }, { - "name": "username", - "description": "username parameter", + "name": "repo", + "description": "repo parameter", "in": "PATH", "type": "string", "required": true, @@ -41551,47 +33336,65 @@ "validation": null, "alias": null, "deprecated": null + }, + { + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], "responses": [ { - "code": 422, + "code": 200, "description": "response", "examples": [ { - "data": "{\"message\":\"Cannot add an organization as a member.\",\"errors\":[{\"code\":\"org\",\"field\":\"user\",\"resource\":\"TeamMember\"}]}" - }, - { - "data": "{\"message\":\"User isn't a member of this organization. Please invite them first.\",\"errors\":[{\"code\":\"unaffiliated\",\"field\":\"user\",\"resource\":\"TeamMember\"}]}" + "data": "[{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false}]" } ] } ], - "renamed": { - "before": { "scope": "teams", "id": "addMember" }, - "after": { "scope": "teams", "id": "addMemberLegacy" }, - "date": "2020-01-16", - "note": "\"Add team member\" is now \"Add team member (Legacy)\"" - } + "renamed": null }, { - "name": "Remove team member (Legacy)", - "scope": "teams", - "id": "removeMemberLegacy", - "method": "DELETE", - "url": "/teams/{team_id}/members/{username}", - "isDeprecated": true, - "isLegacy": true, - "description": "The \"Remove team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Remove team membership](https://developer.github.com/v3/teams/members/#remove-team-membership) endpoint instead. It allows you to remove both active and pending memberships.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", - "documentationUrl": "https://developer.github.com/v3/teams/members/#remove-team-member-legacy", + "name": "Get a Repository Subscription", + "scope": "activity", + "id": "getRepoSubscription", + "method": "GET", + "url": "/repos/{owner}/{repo}/subscription", + "isDeprecated": false, + "isLegacy": false, + "description": "", + "documentationUrl": "https://developer.github.com/v3/activity/watching/#get-a-repository-subscription", "previews": [], "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -41601,8 +33404,8 @@ "deprecated": null }, { - "name": "username", - "description": "username parameter", + "name": "repo", + "description": "repo parameter", "in": "PATH", "type": "string", "required": true, @@ -41614,27 +33417,37 @@ "deprecated": null } ], - "responses": [], + "responses": [ + { + "code": 200, + "description": "Response if you are subscribed to the repository", + "examples": [ + { + "data": "{\"subscribed\":true,\"ignored\":false,\"reason\":null,\"created_at\":\"2012-10-06T21:34:12Z\",\"url\":\"https://api.github.com/repos/octocat/example/subscription\",\"repository_url\":\"https://api.github.com/repos/octocat/example\"}" + } + ] + } + ], "renamed": null }, { - "name": "Remove team member (Legacy)", - "scope": "teams", - "id": "removeMember", - "method": "DELETE", - "url": "/teams/{team_id}/members/{username}", - "isDeprecated": true, - "isLegacy": true, - "description": "The \"Remove team member\" endpoint (described below) is deprecated.\n\nWe recommend using the [Remove team membership](https://developer.github.com/v3/teams/members/#remove-team-membership) endpoint instead. It allows you to remove both active and pending memberships.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", - "documentationUrl": "https://developer.github.com/v3/teams/members/#remove-team-member-legacy", + "name": "Set a Repository Subscription", + "scope": "activity", + "id": "setRepoSubscription", + "method": "PUT", + "url": "/repos/{owner}/{repo}/subscription", + "isDeprecated": false, + "isLegacy": false, + "description": "If you would like to watch a repository, set `subscribed` to `true`. If you would like to ignore notifications made within a repository, set `ignored` to `true`. If you would like to stop watching a repository, [delete the repository's subscription](https://developer.github.com/v3/activity/watching/#delete-a-repository-subscription) completely.", + "documentationUrl": "https://developer.github.com/v3/activity/watching/#set-a-repository-subscription", "previews": [], "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -41644,8 +33457,8 @@ "deprecated": null }, { - "name": "username", - "description": "username parameter", + "name": "repo", + "description": "repo parameter", "in": "PATH", "type": "string", "required": true, @@ -41655,35 +33468,13 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [], - "renamed": { - "before": { "scope": "teams", "id": "removeMember" }, - "after": { "scope": "teams", "id": "removeMemberLegacy" }, - "date": "2020-01-16", - "note": "\"Remove team member\" is now \"Remove team member (Legacy)\"" - } - }, - { - "name": "Get team membership (Legacy)", - "scope": "teams", - "id": "getMembershipLegacy", - "method": "GET", - "url": "/teams/{team_id}/memberships/{username}", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Get team membership`](https://developer.github.com/v3/teams/members/#get-team-membership) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create team](https://developer.github.com/v3/teams#create-team).", - "documentationUrl": "https://developer.github.com/v3/teams/members/#get-team-membership-legacy", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "team_id", - "description": "team_id parameter", - "in": "PATH", - "type": "integer", - "required": true, + "name": "subscribed", + "description": "Determines if notifications should be received from this repository.", + "in": "BODY", + "type": "boolean", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -41692,11 +33483,11 @@ "deprecated": null }, { - "name": "username", - "description": "username parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "ignored", + "description": "Determines if all notifications should be blocked from this repository.", + "in": "BODY", + "type": "boolean", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -41711,13 +33502,7 @@ "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/teams/1/memberships/octocat\",\"role\":\"member\",\"state\":\"active\"}" - }, - { - "data": "{\"url\":\"https://api.github.com/teams/1/memberships/octocat\",\"role\":\"maintainer\",\"state\":\"active\"}" - }, - { - "data": "{\"url\":\"https://api.github.com/teams/1/memberships/octocat\",\"role\":\"member\",\"state\":\"pending\"}" + "data": "{\"subscribed\":true,\"ignored\":false,\"reason\":null,\"created_at\":\"2012-10-06T21:34:12Z\",\"url\":\"https://api.github.com/repos/octocat/example/subscription\",\"repository_url\":\"https://api.github.com/repos/octocat/example\"}" } ] } @@ -41725,23 +33510,23 @@ "renamed": null }, { - "name": "Get team membership (Legacy)", - "scope": "teams", - "id": "getMembership", - "method": "GET", - "url": "/teams/{team_id}/memberships/{username}", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Get team membership`](https://developer.github.com/v3/teams/members/#get-team-membership) endpoint.\n\nTeam members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create team](https://developer.github.com/v3/teams#create-team).", - "documentationUrl": "https://developer.github.com/v3/teams/members/#get-team-membership-legacy", + "name": "Delete a Repository Subscription", + "scope": "activity", + "id": "deleteRepoSubscription", + "method": "DELETE", + "url": "/repos/{owner}/{repo}/subscription", + "isDeprecated": false, + "isLegacy": false, + "description": "This endpoint should only be used to stop watching a repository. To control whether or not you wish to receive notifications from a repository, [set the repository's subscription manually](https://developer.github.com/v3/activity/watching/#set-a-repository-subscription).", + "documentationUrl": "https://developer.github.com/v3/activity/watching/#delete-a-repository-subscription", "previews": [], "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -41751,8 +33536,8 @@ "deprecated": null }, { - "name": "username", - "description": "username parameter", + "name": "repo", + "description": "repo parameter", "in": "PATH", "type": "string", "required": true, @@ -41764,48 +33549,27 @@ "deprecated": null } ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"url\":\"https://api.github.com/teams/1/memberships/octocat\",\"role\":\"member\",\"state\":\"active\"}" - }, - { - "data": "{\"url\":\"https://api.github.com/teams/1/memberships/octocat\",\"role\":\"maintainer\",\"state\":\"active\"}" - }, - { - "data": "{\"url\":\"https://api.github.com/teams/1/memberships/octocat\",\"role\":\"member\",\"state\":\"pending\"}" - } - ] - } - ], - "renamed": { - "before": { "scope": "teams", "id": "getMembership" }, - "after": { "scope": "teams", "id": "getMembershipLegacy" }, - "date": "2020-01-16", - "note": "The path for \"Get team membership\" changed from \"/teams/{team_id}*\" to \"/orgs/{org}/teams/{team_slug}*\"). The operation ID for the old path now has a \"-legacy\" suffix. The route with the new path has a \"-for-org\" suffix in the operation ID to avoid breaking changes" - } + "responses": [], + "renamed": null }, { - "name": "Add or update team membership (Legacy)", - "scope": "teams", - "id": "addOrUpdateMembershipLegacy", - "method": "PUT", - "url": "/teams/{team_id}/memberships/{username}", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Add or update team membership`](https://developer.github.com/v3/teams/members/#add-or-update-team-membership) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.", - "documentationUrl": "https://developer.github.com/v3/teams/members/#add-or-update-team-membership-legacy", + "name": "List tags", + "scope": "repos", + "id": "listTags", + "method": "GET", + "url": "/repos/{owner}/{repo}/tags", + "isDeprecated": false, + "isLegacy": false, + "description": "", + "documentationUrl": "https://developer.github.com/v3/repos/#list-tags", "previews": [], "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -41815,8 +33579,8 @@ "deprecated": null }, { - "name": "username", - "description": "username parameter", + "name": "repo", + "description": "repo parameter", "in": "PATH", "type": "string", "required": true, @@ -41828,12 +33592,25 @@ "deprecated": null }, { - "name": "role", - "description": "The role that this user should have in the team. Can be one of: \n\\* `member` - a normal member of the team. \n\\* `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description.", - "in": "BODY", - "type": "string", + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", "required": false, - "enum": ["member", "maintainer"], + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -41847,19 +33624,7 @@ "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/teams/1/memberships/octocat\",\"role\":\"member\",\"state\":\"active\"}" - }, - { - "data": "{\"url\":\"https://api.github.com/teams/1/memberships/octocat\",\"role\":\"member\",\"state\":\"pending\"}" - } - ] - }, - { - "code": 422, - "description": "Response if you attempt to add an organization to a team", - "examples": [ - { - "data": "{\"message\":\"Cannot add an organization as a member.\",\"errors\":[{\"code\":\"org\",\"field\":\"user\",\"resource\":\"TeamMember\"}]}" + "data": "[{\"name\":\"v0.1\",\"commit\":{\"sha\":\"c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\",\"url\":\"https://api.github.com/repos/octocat/Hello-World/commits/c5b97d5ae6c19d5c5df71a34c7fbeeda2479ccbc\"},\"zipball_url\":\"https://github.com/octocat/Hello-World/zipball/v0.1\",\"tarball_url\":\"https://github.com/octocat/Hello-World/tarball/v0.1\"}]" } ] } @@ -41867,23 +33632,23 @@ "renamed": null }, { - "name": "Add or update team membership (Legacy)", - "scope": "teams", - "id": "addOrUpdateMembership", - "method": "PUT", - "url": "/teams/{team_id}/memberships/{username}", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Add or update team membership`](https://developer.github.com/v3/teams/members/#add-or-update-team-membership) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nIf the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nIf the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the \"pending\" state until the user accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.", - "documentationUrl": "https://developer.github.com/v3/teams/members/#add-or-update-team-membership-legacy", + "name": "List teams", + "scope": "repos", + "id": "listTeams", + "method": "GET", + "url": "/repos/{owner}/{repo}/teams", + "isDeprecated": false, + "isLegacy": false, + "description": "", + "documentationUrl": "https://developer.github.com/v3/repos/#list-teams", "previews": [], "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -41893,8 +33658,8 @@ "deprecated": null }, { - "name": "username", - "description": "username parameter", + "name": "repo", + "description": "repo parameter", "in": "PATH", "type": "string", "required": true, @@ -41906,12 +33671,25 @@ "deprecated": null }, { - "name": "role", - "description": "The role that this user should have in the team. Can be one of: \n\\* `member` - a normal member of the team. \n\\* `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description.", - "in": "BODY", - "type": "string", + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", "required": false, - "enum": ["member", "maintainer"], + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -41925,91 +33703,37 @@ "description": "response", "examples": [ { - "data": "{\"url\":\"https://api.github.com/teams/1/memberships/octocat\",\"role\":\"member\",\"state\":\"active\"}" - }, - { - "data": "{\"url\":\"https://api.github.com/teams/1/memberships/octocat\",\"role\":\"member\",\"state\":\"pending\"}" - } - ] - }, - { - "code": 422, - "description": "Response if you attempt to add an organization to a team", - "examples": [ - { - "data": "{\"message\":\"Cannot add an organization as a member.\",\"errors\":[{\"code\":\"org\",\"field\":\"user\",\"resource\":\"TeamMember\"}]}" + "data": "[{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\",\"parent\":null}]" } ] } ], - "renamed": { - "before": { "scope": "teams", "id": "addOrUpdateMembership" }, - "after": { "scope": "teams", "id": "addOrUpdateMembershipLegacy" }, - "date": "2020-01-16", - "note": "The path for \"Add or update team membership\" changed from \"/teams/{team_id}*\" to \"/orgs/{org}/teams/{team_slug}*\"). The operation ID for the old path now has a \"-legacy\" suffix. The route with the new path has a \"-for-org\" suffix in the operation ID to avoid breaking changes" - } + "renamed": null }, { - "name": "Remove team membership (Legacy)", - "scope": "teams", - "id": "removeMembershipLegacy", - "method": "DELETE", - "url": "/teams/{team_id}/memberships/{username}", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Remove team membership`](https://developer.github.com/v3/teams/members/#remove-team-membership) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", - "documentationUrl": "https://developer.github.com/v3/teams/members/#remove-team-membership-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "team_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - }, + "name": "List all topics for a repository", + "scope": "repos", + "id": "listTopics", + "method": "GET", + "url": "/repos/{owner}/{repo}/topics", + "isDeprecated": false, + "isLegacy": false, + "description": "", + "documentationUrl": "https://developer.github.com/v3/repos/#list-all-topics-for-a-repository", + "previews": [{ "name": "mercy" }], + "headers": [ { - "name": "username", - "description": "username parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null + "name": "accept", + "value": "application/vnd.github.mercy-preview+json", + "required": true } ], - "responses": [], - "renamed": null - }, - { - "name": "Remove team membership (Legacy)", - "scope": "teams", - "id": "removeMembership", - "method": "DELETE", - "url": "/teams/{team_id}/memberships/{username}", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Remove team membership`](https://developer.github.com/v3/teams/members/#remove-team-membership) endpoint.\n\nTeam synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n**Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see \"[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"", - "documentationUrl": "https://developer.github.com/v3/teams/members/#remove-team-membership-legacy", - "previews": [], - "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -42019,8 +33743,8 @@ "deprecated": null }, { - "name": "username", - "description": "username parameter", + "name": "repo", + "description": "repo parameter", "in": "PATH", "type": "string", "required": true, @@ -42032,37 +33756,41 @@ "deprecated": null } ], - "responses": [], - "renamed": { - "before": { "scope": "teams", "id": "removeMembership" }, - "after": { "scope": "teams", "id": "removeMembershipLegacy" }, - "date": "2020-01-16", - "note": "The path for \"Remove team membership\" changed from \"/teams/{team_id}*\" to \"/orgs/{org}/teams/{team_slug}*\"). The operation ID for the old path now has a \"-legacy\" suffix. The route with the new path has a \"-for-org\" suffix in the operation ID to avoid breaking changes" - } + "responses": [ + { + "code": 200, + "description": "response", + "examples": [ + { "data": "{\"names\":[\"octocat\",\"atom\",\"electron\",\"api\"]}" } + ] + } + ], + "renamed": null }, { - "name": "List team projects (Legacy)", - "scope": "teams", - "id": "listProjectsLegacy", - "method": "GET", - "url": "/teams/{team_id}/projects", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://developer.github.com/v3/teams/#list-team-projects) endpoint.\n\nLists the organization projects for a team.", - "documentationUrl": "https://developer.github.com/v3/teams/#list-team-projects-legacy", - "previews": [{ "name": "inertia" }], + "name": "Replace all topics for a repository", + "scope": "repos", + "id": "replaceTopics", + "method": "PUT", + "url": "/repos/{owner}/{repo}/topics", + "isDeprecated": false, + "isLegacy": false, + "description": "", + "documentationUrl": "https://developer.github.com/v3/repos/#replace-all-topics-for-a-repository", + "previews": [{ "name": "mercy" }], "headers": [ { "name": "accept", - "value": "application/vnd.github.inertia-preview+json" + "value": "application/vnd.github.mercy-preview+json", + "required": true } ], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -42072,11 +33800,11 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "repo", + "description": "repo parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -42085,11 +33813,11 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "names", + "description": "An array of topics to add to the repository. Pass one or more topics to _replace_ the set of existing topics. Send an empty array (`[]`) to clear all topics from the repository. **Note:** Topic `names` cannot contain uppercase letters.", + "in": "BODY", + "type": "string[]", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -42103,37 +33831,30 @@ "code": 200, "description": "response", "examples": [ - { - "data": "[{\"owner_url\":\"https://api.github.com/orgs/octocat\",\"url\":\"https://api.github.com/projects/1002605\",\"html_url\":\"https://github.com/orgs/api-playground/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002605/columns\",\"id\":1002605,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDU=\",\"name\":\"Organization Roadmap\",\"body\":\"High-level roadmap for the upcoming year.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-11T20:09:31Z\",\"updated_at\":\"2014-03-04T18:58:10Z\",\"organization_permission\":\"write\",\"private\":false,\"permissions\":{\"read\":true,\"write\":true,\"admin\":false}}]" - } + { "data": "{\"names\":[\"octocat\",\"atom\",\"electron\",\"api\"]}" } ] } ], "renamed": null }, { - "name": "List team projects (Legacy)", - "scope": "teams", - "id": "listProjects", + "name": "Clones", + "scope": "repos", + "id": "getClones", "method": "GET", - "url": "/teams/{team_id}/projects", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://developer.github.com/v3/teams/#list-team-projects) endpoint.\n\nLists the organization projects for a team.", - "documentationUrl": "https://developer.github.com/v3/teams/#list-team-projects-legacy", - "previews": [{ "name": "inertia" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.inertia-preview+json" - } - ], + "url": "/repos/{owner}/{repo}/traffic/clones", + "isDeprecated": false, + "isLegacy": false, + "description": "Get the total number of clones and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.", + "documentationUrl": "https://developer.github.com/v3/repos/traffic/#clones", + "previews": [], + "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -42143,11 +33864,11 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "repo", + "description": "repo parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -42156,12 +33877,12 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", + "name": "per", + "description": "Must be one of: `day`, `week`.", "in": "QUERY", - "type": "integer", + "type": "string", "required": false, - "enum": null, + "enum": ["day", "week"], "allowNull": false, "mapToData": null, "validation": null, @@ -42175,41 +33896,31 @@ "description": "response", "examples": [ { - "data": "[{\"owner_url\":\"https://api.github.com/orgs/octocat\",\"url\":\"https://api.github.com/projects/1002605\",\"html_url\":\"https://github.com/orgs/api-playground/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002605/columns\",\"id\":1002605,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDU=\",\"name\":\"Organization Roadmap\",\"body\":\"High-level roadmap for the upcoming year.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-11T20:09:31Z\",\"updated_at\":\"2014-03-04T18:58:10Z\",\"organization_permission\":\"write\",\"private\":false,\"permissions\":{\"read\":true,\"write\":true,\"admin\":false}}]" + "data": "{\"count\":173,\"uniques\":128,\"clones\":[{\"timestamp\":\"2016-10-10T00:00:00Z\",\"count\":2,\"uniques\":1},{\"timestamp\":\"2016-10-11T00:00:00Z\",\"count\":17,\"uniques\":16},{\"timestamp\":\"2016-10-12T00:00:00Z\",\"count\":21,\"uniques\":15},{\"timestamp\":\"2016-10-13T00:00:00Z\",\"count\":8,\"uniques\":7},{\"timestamp\":\"2016-10-14T00:00:00Z\",\"count\":5,\"uniques\":5},{\"timestamp\":\"2016-10-15T00:00:00Z\",\"count\":2,\"uniques\":2},{\"timestamp\":\"2016-10-16T00:00:00Z\",\"count\":8,\"uniques\":7},{\"timestamp\":\"2016-10-17T00:00:00Z\",\"count\":26,\"uniques\":15},{\"timestamp\":\"2016-10-18T00:00:00Z\",\"count\":19,\"uniques\":17},{\"timestamp\":\"2016-10-19T00:00:00Z\",\"count\":19,\"uniques\":14},{\"timestamp\":\"2016-10-20T00:00:00Z\",\"count\":19,\"uniques\":15},{\"timestamp\":\"2016-10-21T00:00:00Z\",\"count\":9,\"uniques\":7},{\"timestamp\":\"2016-10-22T00:00:00Z\",\"count\":5,\"uniques\":5},{\"timestamp\":\"2016-10-23T00:00:00Z\",\"count\":6,\"uniques\":5},{\"timestamp\":\"2016-10-24T00:00:00Z\",\"count\":7,\"uniques\":5}]}" } ] } ], - "renamed": { - "before": { "scope": "teams", "id": "listProjects" }, - "after": { "scope": "teams", "id": "listProjectsLegacy" }, - "date": "2020-01-16", - "note": "The path for \"List team projects\" changed from \"/teams/{team_id}*\" to \"/orgs/{org}/teams/{team_slug}*\"). The operation ID for the old path now has a \"-legacy\" suffix. The route with the new path has a \"-for-org\" suffix in the operation ID to avoid breaking changes" - } + "renamed": null }, { - "name": "Review a team project (Legacy)", - "scope": "teams", - "id": "reviewProjectLegacy", + "name": "List paths", + "scope": "repos", + "id": "getTopPaths", "method": "GET", - "url": "/teams/{team_id}/projects/{project_id}", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Review a team project`](https://developer.github.com/v3/teams/#review-a-team-project) endpoint.\n\nChecks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.", - "documentationUrl": "https://developer.github.com/v3/teams/#review-a-team-project-legacy", - "previews": [{ "name": "inertia" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.inertia-preview+json" - } - ], + "url": "/repos/{owner}/{repo}/traffic/popular/paths", + "isDeprecated": false, + "isLegacy": false, + "description": "Get the top 10 popular contents over the last 14 days.", + "documentationUrl": "https://developer.github.com/v3/repos/traffic/#list-paths", + "previews": [], + "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -42219,10 +33930,10 @@ "deprecated": null }, { - "name": "project_id", - "description": "project_id parameter", + "name": "repo", + "description": "repo parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -42238,7 +33949,7 @@ "description": "response", "examples": [ { - "data": "{\"owner_url\":\"https://api.github.com/orgs/octocat\",\"url\":\"https://api.github.com/projects/1002605\",\"html_url\":\"https://github.com/orgs/api-playground/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002605/columns\",\"id\":1002605,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDU=\",\"name\":\"Organization Roadmap\",\"body\":\"High-level roadmap for the upcoming year.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-11T20:09:31Z\",\"updated_at\":\"2014-03-04T18:58:10Z\",\"organization_permission\":\"write\",\"private\":false,\"permissions\":{\"read\":true,\"write\":true,\"admin\":false}}" + "data": "[{\"path\":\"/github/hubot\",\"title\":\"github/hubot: A customizable life embetterment robot.\",\"count\":3542,\"uniques\":2225},{\"path\":\"/github/hubot/blob/master/docs/scripting.md\",\"title\":\"hubot/scripting.md at master · github/hubot · GitHub\",\"count\":1707,\"uniques\":804},{\"path\":\"/github/hubot/tree/master/docs\",\"title\":\"hubot/docs at master · github/hubot · GitHub\",\"count\":685,\"uniques\":435},{\"path\":\"/github/hubot/tree/master/src\",\"title\":\"hubot/src at master · github/hubot · GitHub\",\"count\":577,\"uniques\":347},{\"path\":\"/github/hubot/blob/master/docs/index.md\",\"title\":\"hubot/index.md at master · github/hubot · GitHub\",\"count\":379,\"uniques\":259},{\"path\":\"/github/hubot/blob/master/docs/adapters.md\",\"title\":\"hubot/adapters.md at master · github/hubot · GitHub\",\"count\":354,\"uniques\":201},{\"path\":\"/github/hubot/tree/master/examples\",\"title\":\"hubot/examples at master · github/hubot · GitHub\",\"count\":340,\"uniques\":260},{\"path\":\"/github/hubot/blob/master/docs/deploying/heroku.md\",\"title\":\"hubot/heroku.md at master · github/hubot · GitHub\",\"count\":324,\"uniques\":217},{\"path\":\"/github/hubot/blob/master/src/robot.coffee\",\"title\":\"hubot/robot.coffee at master · github/hubot · GitHub\",\"count\":293,\"uniques\":191},{\"path\":\"/github/hubot/blob/master/LICENSE.md\",\"title\":\"hubot/LICENSE.md at master · github/hubot · GitHub\",\"count\":281,\"uniques\":222}]" } ] } @@ -42246,28 +33957,23 @@ "renamed": null }, { - "name": "Review a team project (Legacy)", - "scope": "teams", - "id": "reviewProject", + "name": "List referrers", + "scope": "repos", + "id": "getTopReferrers", "method": "GET", - "url": "/teams/{team_id}/projects/{project_id}", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Review a team project`](https://developer.github.com/v3/teams/#review-a-team-project) endpoint.\n\nChecks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.", - "documentationUrl": "https://developer.github.com/v3/teams/#review-a-team-project-legacy", - "previews": [{ "name": "inertia" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.inertia-preview+json" - } - ], + "url": "/repos/{owner}/{repo}/traffic/popular/referrers", + "isDeprecated": false, + "isLegacy": false, + "description": "Get the top 10 referrers over the last 14 days.", + "documentationUrl": "https://developer.github.com/v3/repos/traffic/#list-referrers", + "previews": [], + "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -42277,10 +33983,10 @@ "deprecated": null }, { - "name": "project_id", - "description": "project_id parameter", + "name": "repo", + "description": "repo parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -42296,41 +34002,31 @@ "description": "response", "examples": [ { - "data": "{\"owner_url\":\"https://api.github.com/orgs/octocat\",\"url\":\"https://api.github.com/projects/1002605\",\"html_url\":\"https://github.com/orgs/api-playground/projects/1\",\"columns_url\":\"https://api.github.com/projects/1002605/columns\",\"id\":1002605,\"node_id\":\"MDc6UHJvamVjdDEwMDI2MDU=\",\"name\":\"Organization Roadmap\",\"body\":\"High-level roadmap for the upcoming year.\",\"number\":1,\"state\":\"open\",\"creator\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"created_at\":\"2011-04-11T20:09:31Z\",\"updated_at\":\"2014-03-04T18:58:10Z\",\"organization_permission\":\"write\",\"private\":false,\"permissions\":{\"read\":true,\"write\":true,\"admin\":false}}" + "data": "[{\"referrer\":\"Google\",\"count\":4,\"uniques\":3},{\"referrer\":\"stackoverflow.com\",\"count\":2,\"uniques\":2},{\"referrer\":\"eggsonbread.com\",\"count\":1,\"uniques\":1},{\"referrer\":\"yandex.ru\",\"count\":1,\"uniques\":1}]" } ] } ], - "renamed": { - "before": { "scope": "teams", "id": "reviewProject" }, - "after": { "scope": "teams", "id": "reviewProjectLegacy" }, - "date": "2020-01-16", - "note": "The path for \"Review a team project\" changed from \"/teams/{team_id}*\" to \"/orgs/{org}/teams/{team_slug}*\"). The operation ID for the old path now has a \"-legacy\" suffix. The route with the new path has a \"-for-org\" suffix in the operation ID to avoid breaking changes" - } + "renamed": null }, { - "name": "Add or update team project (Legacy)", - "scope": "teams", - "id": "addOrUpdateProjectLegacy", - "method": "PUT", - "url": "/teams/{team_id}/projects/{project_id}", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Add or update team project`](https://developer.github.com/v3/teams/#add-or-update-team-project) endpoint.\n\nAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.", - "documentationUrl": "https://developer.github.com/v3/teams/#add-or-update-team-project-legacy", - "previews": [{ "name": "inertia" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.inertia-preview+json" - } - ], + "name": "Views", + "scope": "repos", + "id": "getViews", + "method": "GET", + "url": "/repos/{owner}/{repo}/traffic/views", + "isDeprecated": false, + "isLegacy": false, + "description": "Get the total number of views and breakdown per day or week for the last 14 days. Timestamps are aligned to UTC midnight of the beginning of the day or week. Week begins on Monday.", + "documentationUrl": "https://developer.github.com/v3/repos/traffic/#views", + "previews": [], + "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -42340,10 +34036,10 @@ "deprecated": null }, { - "name": "project_id", - "description": "project_id parameter", + "name": "repo", + "description": "repo parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -42353,12 +34049,12 @@ "deprecated": null }, { - "name": "permission", - "description": "The permission to grant to the team for this project. Can be one of: \n\\* `read` - team members can read, but not write to or administer this project. \n\\* `write` - team members can read and write, but not administer this project. \n\\* `admin` - team members can read, write and administer this project. \nDefault: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\"", - "in": "BODY", + "name": "per", + "description": "Must be one of: `day`, `week`.", + "in": "QUERY", "type": "string", "required": false, - "enum": ["read", "write", "admin"], + "enum": ["day", "week"], "allowNull": false, "mapToData": null, "validation": null, @@ -42368,11 +34064,11 @@ ], "responses": [ { - "code": 403, - "description": "Response if the project is not owned by the organization", + "code": 200, + "description": "response", "examples": [ { - "data": "{\"message\":\"Must have admin rights to Repository.\",\"documentation_url\":\"https://developer.github.com/v3/teams/#add-or-update-team-project\"}" + "data": "{\"count\":14850,\"uniques\":3782,\"views\":[{\"timestamp\":\"2016-10-10T00:00:00Z\",\"count\":440,\"uniques\":143},{\"timestamp\":\"2016-10-11T00:00:00Z\",\"count\":1308,\"uniques\":414},{\"timestamp\":\"2016-10-12T00:00:00Z\",\"count\":1486,\"uniques\":452},{\"timestamp\":\"2016-10-13T00:00:00Z\",\"count\":1170,\"uniques\":401},{\"timestamp\":\"2016-10-14T00:00:00Z\",\"count\":868,\"uniques\":266},{\"timestamp\":\"2016-10-15T00:00:00Z\",\"count\":495,\"uniques\":157},{\"timestamp\":\"2016-10-16T00:00:00Z\",\"count\":524,\"uniques\":175},{\"timestamp\":\"2016-10-17T00:00:00Z\",\"count\":1263,\"uniques\":412},{\"timestamp\":\"2016-10-18T00:00:00Z\",\"count\":1402,\"uniques\":417},{\"timestamp\":\"2016-10-19T00:00:00Z\",\"count\":1394,\"uniques\":424},{\"timestamp\":\"2016-10-20T00:00:00Z\",\"count\":1492,\"uniques\":448},{\"timestamp\":\"2016-10-21T00:00:00Z\",\"count\":1153,\"uniques\":332},{\"timestamp\":\"2016-10-22T00:00:00Z\",\"count\":566,\"uniques\":168},{\"timestamp\":\"2016-10-23T00:00:00Z\",\"count\":675,\"uniques\":184},{\"timestamp\":\"2016-10-24T00:00:00Z\",\"count\":614,\"uniques\":237}]}" } ] } @@ -42380,28 +34076,23 @@ "renamed": null }, { - "name": "Add or update team project (Legacy)", - "scope": "teams", - "id": "addOrUpdateProject", - "method": "PUT", - "url": "/teams/{team_id}/projects/{project_id}", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Add or update team project`](https://developer.github.com/v3/teams/#add-or-update-team-project) endpoint.\n\nAdds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.", - "documentationUrl": "https://developer.github.com/v3/teams/#add-or-update-team-project-legacy", - "previews": [{ "name": "inertia" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.inertia-preview+json" - } - ], + "name": "Transfer a repository", + "scope": "repos", + "id": "transfer", + "method": "POST", + "url": "/repos/{owner}/{repo}/transfer", + "isDeprecated": false, + "isLegacy": false, + "description": "A transfer request will need to be accepted by the new owner when transferring a personal repository to another user. The response will contain the original `owner`, and the transfer will continue asynchronously. For more details on the requirements to transfer personal and organization-owned repositories, see [about repository transfers](https://help.github.com/articles/about-repository-transfers/).", + "documentationUrl": "https://developer.github.com/v3/repos/#transfer-a-repository", + "previews": [], + "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -42411,10 +34102,10 @@ "deprecated": null }, { - "name": "project_id", - "description": "project_id parameter", + "name": "repo", + "description": "repo parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -42424,12 +34115,25 @@ "deprecated": null }, { - "name": "permission", - "description": "The permission to grant to the team for this project. Can be one of: \n\\* `read` - team members can read, but not write to or administer this project. \n\\* `write` - team members can read and write, but not administer this project. \n\\* `admin` - team members can read, write and administer this project. \nDefault: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\"", + "name": "new_owner", + "description": "**Required:** The username or organization name the repository will be transferred to.", "in": "BODY", "type": "string", "required": false, - "enum": ["read", "write", "admin"], + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "team_ids", + "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.", + "in": "BODY", + "type": "integer[]", + "required": false, + "enum": null, "allowNull": false, "mapToData": null, "validation": null, @@ -42439,40 +34143,90 @@ ], "responses": [ { - "code": 403, - "description": "Response if the project is not owned by the organization", + "code": 202, + "description": "response", "examples": [ { - "data": "{\"message\":\"Must have admin rights to Repository.\",\"documentation_url\":\"https://developer.github.com/v3/teams/#add-or-update-team-project\"}" + "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}" } ] } ], - "renamed": { - "before": { "scope": "teams", "id": "addOrUpdateProject" }, - "after": { "scope": "teams", "id": "addOrUpdateProjectLegacy" }, - "date": "2020-01-16", - "note": "The path for \"Add or update team project\" changed from \"/teams/{team_id}*\" to \"/orgs/{org}/teams/{team_slug}*\"). The operation ID for the old path now has a \"-legacy\" suffix. The route with the new path has a \"-for-org\" suffix in the operation ID to avoid breaking changes" - } + "renamed": null + }, + { + "name": "Check if vulnerability alerts are enabled for a repository", + "scope": "repos", + "id": "checkVulnerabilityAlerts", + "method": "GET", + "url": "/repos/{owner}/{repo}/vulnerability-alerts", + "isDeprecated": false, + "isLegacy": false, + "description": "Shows whether vulnerability alerts are enabled or disabled for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)\" in the GitHub Help documentation.", + "documentationUrl": "https://developer.github.com/v3/repos/#check-if-vulnerability-alerts-are-enabled-for-a-repository", + "previews": [{ "name": "dorian" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.dorian-preview+json", + "required": true + } + ], + "parameters": [ + { + "name": "owner", + "description": "owner parameter", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "repo", + "description": "repo parameter", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [], + "renamed": null }, { - "name": "Remove team project (Legacy)", - "scope": "teams", - "id": "removeProjectLegacy", - "method": "DELETE", - "url": "/teams/{team_id}/projects/{project_id}", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Remove team project`](https://developer.github.com/v3/teams/#remove-team-project) endpoint.\n\nRemoves an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it.", - "documentationUrl": "https://developer.github.com/v3/teams/#remove-team-project-legacy", - "previews": [], - "headers": [], + "name": "Enable vulnerability alerts", + "scope": "repos", + "id": "enableVulnerabilityAlerts", + "method": "PUT", + "url": "/repos/{owner}/{repo}/vulnerability-alerts", + "isDeprecated": false, + "isLegacy": false, + "description": "Enables vulnerability alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)\" in the GitHub Help documentation.", + "documentationUrl": "https://developer.github.com/v3/repos/#enable-vulnerability-alerts", + "previews": [{ "name": "dorian" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.dorian-preview+json", + "required": true + } + ], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -42482,10 +34236,10 @@ "deprecated": null }, { - "name": "project_id", - "description": "project_id parameter", + "name": "repo", + "description": "repo parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -42499,23 +34253,29 @@ "renamed": null }, { - "name": "Remove team project (Legacy)", - "scope": "teams", - "id": "removeProject", + "name": "Disable vulnerability alerts", + "scope": "repos", + "id": "disableVulnerabilityAlerts", "method": "DELETE", - "url": "/teams/{team_id}/projects/{project_id}", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Remove team project`](https://developer.github.com/v3/teams/#remove-team-project) endpoint.\n\nRemoves an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it.", - "documentationUrl": "https://developer.github.com/v3/teams/#remove-team-project-legacy", - "previews": [], - "headers": [], + "url": "/repos/{owner}/{repo}/vulnerability-alerts", + "isDeprecated": false, + "isLegacy": false, + "description": "Disables vulnerability alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)\" in the GitHub Help documentation.", + "documentationUrl": "https://developer.github.com/v3/repos/#disable-vulnerability-alerts", + "previews": [{ "name": "dorian" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.dorian-preview+json", + "required": true + } + ], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -42525,10 +34285,10 @@ "deprecated": null }, { - "name": "project_id", - "description": "project_id parameter", + "name": "repo", + "description": "repo parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -42539,31 +34299,26 @@ } ], "responses": [], - "renamed": { - "before": { "scope": "teams", "id": "removeProject" }, - "after": { "scope": "teams", "id": "removeProjectLegacy" }, - "date": "2020-01-16", - "note": "The path for \"Remove team project\" changed from \"/teams/{team_id}*\" to \"/orgs/{org}/teams/{team_slug}*\"). The operation ID for the old path now has a \"-legacy\" suffix. The route with the new path has a \"-for-org\" suffix in the operation ID to avoid breaking changes" - } + "renamed": null }, { - "name": "List team repos (Legacy)", - "scope": "teams", - "id": "listReposLegacy", + "name": "Get archive link", + "scope": "repos", + "id": "getArchiveLink", "method": "GET", - "url": "/teams/{team_id}/repos", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team repos`](https://developer.github.com/v3/teams/#list-team-repos) endpoint.", - "documentationUrl": "https://developer.github.com/v3/teams/#list-team-repos-legacy", + "url": "/repos/{owner}/{repo}/{archive_format}/{ref}", + "isDeprecated": false, + "isLegacy": false, + "description": "Gets a redirect URL to download an archive for a repository. The `:archive_format` can be either `tarball` or `zipball`. The `:ref` must be a valid Git reference. If you omit `:ref`, the repository’s default branch (usually `master`) will be used. Please make sure your HTTP framework is configured to follow redirects or you will need to use the `Location` header to make a second `GET` request.\n\n_Note_: For private repositories, these links are temporary and expire after five minutes.\n\nTo follow redirects with curl, use the `-L` switch:\n\n", + "documentationUrl": "https://developer.github.com/v3/repos/contents/#get-archive-link", "previews": [], "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "owner", + "description": "owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -42573,11 +34328,11 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "repo", + "description": "repo parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -42586,50 +34341,59 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "archive_format", + "description": "archive_format parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ + }, { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"}}]" - } - ] + "name": "ref", + "description": "ref parameter", + "in": "PATH", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null } ], + "responses": [], "renamed": null }, { - "name": "List team repos (Legacy)", - "scope": "teams", - "id": "listRepos", - "method": "GET", - "url": "/teams/{team_id}/repos", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team repos`](https://developer.github.com/v3/teams/#list-team-repos) endpoint.", - "documentationUrl": "https://developer.github.com/v3/teams/#list-team-repos-legacy", - "previews": [], - "headers": [], + "name": "Create repository using a repository template", + "scope": "repos", + "id": "createUsingTemplate", + "method": "POST", + "url": "/repos/{template_owner}/{template_repo}/generate", + "isDeprecated": false, + "isLegacy": false, + "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [`GET /repos/:owner/:repo`](https://developer.github.com/v3/repos/#get) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository\n\n\\`", + "documentationUrl": "https://developer.github.com/v3/repos/#create-repository-using-a-repository-template", + "previews": [{ "name": "baptiste" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.baptiste-preview+json", + "required": true + } + ], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", + "name": "template_owner", + "description": "template_owner parameter", "in": "PATH", - "type": "integer", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -42639,11 +34403,11 @@ "deprecated": null }, { - "name": "per_page", - "description": "Results per page (max 100)", - "in": "QUERY", - "type": "integer", - "required": false, + "name": "template_repo", + "description": "template_repo parameter", + "in": "PATH", + "type": "string", + "required": true, "enum": null, "allowNull": false, "mapToData": null, @@ -42652,10 +34416,10 @@ "deprecated": null }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "QUERY", - "type": "integer", + "name": "owner", + "description": "The organization or person who will own the new repository. To create a new repository in an organization, the authenticated user must be a member of the specified organization.", + "in": "BODY", + "type": "string", "required": false, "enum": null, "allowNull": false, @@ -42663,44 +34427,12 @@ "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"subscribers_count\":42,\"network_count\":0,\"license\":{\"key\":\"mit\",\"name\":\"MIT License\",\"spdx_id\":\"MIT\",\"url\":\"https://api.github.com/licenses/mit\",\"node_id\":\"MDc6TGljZW5zZW1pdA==\"}}]" - } - ] - } - ], - "renamed": { - "before": { "scope": "teams", "id": "listRepos" }, - "after": { "scope": "teams", "id": "listReposLegacy" }, - "date": "2020-01-16", - "note": "The path for \"List team repos\" changed from \"/teams/{team_id}*\" to \"/orgs/{org}/teams/{team_slug}*\"). The operation ID for the old path now has a \"-legacy\" suffix. The route with the new path has a \"-for-org\" suffix in the operation ID to avoid breaking changes" - } - }, - { - "name": "Check if a team manages a repository (Legacy)", - "scope": "teams", - "id": "checkManagesRepoLegacy", - "method": "GET", - "url": "/teams/{team_id}/repos/{owner}/{repo}", - "isDeprecated": true, - "isLegacy": true, - "description": "**Note**: Repositories inherited through a parent team will also be checked.\n\n**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Check if a team manages a repository`](https://developer.github.com/v3/teams/#check-if-a-team-manages-a-repository) endpoint.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://developer.github.com/v3/media/) via the `Accept` header:", - "documentationUrl": "https://developer.github.com/v3/teams/#check-if-a-team-manages-a-repository-legacy", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "team_id", - "description": "team_id parameter", - "in": "PATH", - "type": "integer", + "name": "name", + "description": "The name of the new repository.", + "in": "BODY", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -42710,11 +34442,11 @@ "deprecated": null }, { - "name": "owner", - "description": "owner parameter", - "in": "PATH", + "name": "description", + "description": "A short description of the new repository.", + "in": "BODY", "type": "string", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -42723,11 +34455,11 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "private", + "description": "Either `true` to create a new private repository or `false` to create a new public one.", + "in": "BODY", + "type": "boolean", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -42738,11 +34470,11 @@ ], "responses": [ { - "code": 200, - "description": "Alternative response with extra repository information", + "code": 201, + "description": "response", "examples": [ { - "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}" + "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":false,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0},\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}" } ] } @@ -42750,24 +34482,24 @@ "renamed": null }, { - "name": "Check if a team manages a repository (Legacy)", - "scope": "teams", - "id": "checkManagesRepo", + "name": "List all public repositories", + "scope": "repos", + "id": "listPublic", "method": "GET", - "url": "/teams/{team_id}/repos/{owner}/{repo}", - "isDeprecated": true, - "isLegacy": true, - "description": "**Note**: Repositories inherited through a parent team will also be checked.\n\n**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Check if a team manages a repository`](https://developer.github.com/v3/teams/#check-if-a-team-manages-a-repository) endpoint.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://developer.github.com/v3/media/) via the `Accept` header:", - "documentationUrl": "https://developer.github.com/v3/teams/#check-if-a-team-manages-a-repository-legacy", + "url": "/repositories", + "isDeprecated": false, + "isLegacy": false, + "description": "Lists all public repositories in the order that they were created.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://developer.github.com/v3/#link-header) to get the URL for the next page of repositories.", + "documentationUrl": "https://developer.github.com/v3/repos/#list-all-public-repositories", "previews": [], "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", - "in": "PATH", + "name": "since", + "description": "The integer ID of the last repository that you've seen.", + "in": "QUERY", "type": "integer", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -42776,11 +34508,11 @@ "deprecated": null }, { - "name": "owner", - "description": "owner parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -42789,11 +34521,11 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -42805,39 +34537,34 @@ "responses": [ { "code": 200, - "description": "Alternative response with extra repository information", + "description": "response", "examples": [ { - "data": "{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\"clone_url\":\"https://github.com/octocat/Hello-World.git\",\"mirror_url\":\"git:git.example.com/octocat/Hello-World\",\"hooks_url\":\"http://api.github.com/repos/octocat/Hello-World/hooks\",\"svn_url\":\"https://svn.github.com/octocat/Hello-World\",\"homepage\":\"https://github.com\",\"language\":null,\"forks_count\":9,\"stargazers_count\":80,\"watchers_count\":80,\"size\":108,\"default_branch\":\"master\",\"open_issues_count\":0,\"is_template\":true,\"topics\":[\"octocat\",\"atom\",\"electron\",\"api\"],\"has_issues\":true,\"has_projects\":true,\"has_wiki\":true,\"has_pages\":false,\"has_downloads\":true,\"archived\":false,\"disabled\":false,\"visibility\":\"public\",\"pushed_at\":\"2011-01-26T19:06:43Z\",\"created_at\":\"2011-01-26T19:01:12Z\",\"updated_at\":\"2011-01-26T19:14:43Z\",\"permissions\":{\"admin\":false,\"push\":false,\"pull\":true},\"allow_rebase_merge\":true,\"template_repository\":null,\"temp_clone_token\":\"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\"allow_squash_merge\":true,\"allow_merge_commit\":true,\"subscribers_count\":42,\"network_count\":0}" + "data": "[{\"id\":1296269,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\"name\":\"Hello-World\",\"full_name\":\"octocat/Hello-World\",\"owner\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Hello-World\",\"description\":\"This your first repo!\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Hello-World\",\"archive_url\":\"http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\"assignees_url\":\"http://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\"blobs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\"branches_url\":\"http://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\"collaborators_url\":\"http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\"comments_url\":\"http://api.github.com/repos/octocat/Hello-World/comments{/number}\",\"commits_url\":\"http://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\"compare_url\":\"http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\"contents_url\":\"http://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\"contributors_url\":\"http://api.github.com/repos/octocat/Hello-World/contributors\",\"deployments_url\":\"http://api.github.com/repos/octocat/Hello-World/deployments\",\"downloads_url\":\"http://api.github.com/repos/octocat/Hello-World/downloads\",\"events_url\":\"http://api.github.com/repos/octocat/Hello-World/events\",\"forks_url\":\"http://api.github.com/repos/octocat/Hello-World/forks\",\"git_commits_url\":\"http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\"git_refs_url\":\"http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\"git_tags_url\":\"http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\"git_url\":\"git:github.com/octocat/Hello-World.git\",\"issue_comment_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\"issue_events_url\":\"http://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\"issues_url\":\"http://api.github.com/repos/octocat/Hello-World/issues{/number}\",\"keys_url\":\"http://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\"labels_url\":\"http://api.github.com/repos/octocat/Hello-World/labels{/name}\",\"languages_url\":\"http://api.github.com/repos/octocat/Hello-World/languages\",\"merges_url\":\"http://api.github.com/repos/octocat/Hello-World/merges\",\"milestones_url\":\"http://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\"notifications_url\":\"http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\"pulls_url\":\"http://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\"releases_url\":\"http://api.github.com/repos/octocat/Hello-World/releases{/id}\",\"ssh_url\":\"git@github.com:octocat/Hello-World.git\",\"stargazers_url\":\"http://api.github.com/repos/octocat/Hello-World/stargazers\",\"statuses_url\":\"http://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\"subscribers_url\":\"http://api.github.com/repos/octocat/Hello-World/subscribers\",\"subscription_url\":\"http://api.github.com/repos/octocat/Hello-World/subscription\",\"tags_url\":\"http://api.github.com/repos/octocat/Hello-World/tags\",\"teams_url\":\"http://api.github.com/repos/octocat/Hello-World/teams\",\"trees_url\":\"http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\"}]" } ] } ], - "renamed": { - "before": { "scope": "teams", "id": "checkManagesRepo" }, - "after": { "scope": "teams", "id": "checkManagesRepoLegacy" }, - "date": "2020-01-16", - "note": "The path for \"Check if a team manages a repository\" changed from \"/teams/{team_id}*\" to \"/orgs/{org}/teams/{team_slug}*\"). The operation ID for the old path now has a \"-legacy\" suffix. The route with the new path has a \"-for-org\" suffix in the operation ID to avoid breaking changes" - } + "renamed": null }, { - "name": "Add or update team repository (Legacy)", - "scope": "teams", - "id": "addOrUpdateRepoLegacy", - "method": "PUT", - "url": "/teams/{team_id}/repos/{owner}/{repo}", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Add or update team repository`](https://developer.github.com/v3/teams/#add-or-update-team-repository) endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\"", - "documentationUrl": "https://developer.github.com/v3/teams/#add-or-update-team-repository-legacy", + "name": "Search code", + "scope": "search", + "id": "code", + "method": "GET", + "url": "/search/code", + "isDeprecated": false, + "isLegacy": false, + "description": "Find file contents via various criteria. This method returns up to 100 results [per page](https://developer.github.com/v3/#pagination).\n\nWhen searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://developer.github.com/v3/search/#text-match-metadata).\n\n**Note:** You must [authenticate](https://developer.github.com/v3/#authentication) to search for code across all public repositories.\n\n**Considerations for code search**\n\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:\n\n* Only the _default branch_ is considered. In most cases, this will be the `master` branch.\n* Only files smaller than 384 KB are searchable.\n* You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.\n\nSuppose you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery). Your query would look something like this:\n\nHere, we're searching for the keyword `addClass` within a file's contents. We're making sure that we're only looking in files where the language is JavaScript. And we're scoping the search to the `repo:jquery/jquery` repository.", + "documentationUrl": "https://developer.github.com/v3/search/#search-code", "previews": [], "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", - "in": "PATH", - "type": "integer", + "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See \"[Searching code](https://help.github.com/articles/searching-code/)\" for a detailed list of qualifiers.", + "in": "QUERY", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -42847,12 +34574,12 @@ "deprecated": null }, { - "name": "owner", - "description": "owner parameter", - "in": "PATH", + "name": "sort", + "description": "Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub search infrastructure. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", + "in": "QUERY", "type": "string", - "required": true, - "enum": null, + "required": false, + "enum": ["indexed"], "allowNull": false, "mapToData": null, "validation": null, @@ -42860,12 +34587,12 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "order", + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", + "in": "QUERY", "type": "string", - "required": true, - "enum": null, + "required": false, + "enum": ["desc", "asc"], "allowNull": false, "mapToData": null, "validation": null, @@ -42873,52 +34600,68 @@ "deprecated": null }, { - "name": "permission", - "description": "The permission to grant the team on this repository. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer this repository. \n\\* `push` - team members can pull and push, but not administer this repository. \n\\* `admin` - team members can pull, push and administer this repository. \n \nIf no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.", - "in": "BODY", - "type": "string", + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", "required": false, - "enum": ["pull", "push", "admin"], + "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [], - "renamed": null - }, - { - "name": "Add or update team repository (Legacy)", - "scope": "teams", - "id": "addOrUpdateRepo", - "method": "PUT", - "url": "/teams/{team_id}/repos/{owner}/{repo}", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Add or update team repository`](https://developer.github.com/v3/teams/#add-or-update-team-repository) endpoint.\n\nTo add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/v3/#http-verbs).\"", - "documentationUrl": "https://developer.github.com/v3/teams/#add-or-update-team-repository-legacy", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "team_id", - "description": "team_id parameter", - "in": "PATH", + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", "type": "integer", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "owner", - "description": "owner parameter", - "in": "PATH", + "code": 200, + "description": "response", + "examples": [ + { + "data": "{\"total_count\":7,\"incomplete_results\":false,\"items\":[{\"name\":\"classes.js\",\"path\":\"src/attributes/classes.js\",\"sha\":\"d7212f9dee2dcc18f084d7df8f417b80846ded5a\",\"url\":\"https://api.github.com/repositories/167174/contents/src/attributes/classes.js?ref=825ac3773694e0cd23ee74895fd5aeb535b27da4\",\"git_url\":\"https://api.github.com/repositories/167174/git/blobs/d7212f9dee2dcc18f084d7df8f417b80846ded5a\",\"html_url\":\"https://github.com/jquery/jquery/blob/825ac3773694e0cd23ee74895fd5aeb535b27da4/src/attributes/classes.js\",\"repository\":{\"id\":167174,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxNjcxNzQ=\",\"name\":\"jquery\",\"full_name\":\"jquery/jquery\",\"owner\":{\"login\":\"jquery\",\"id\":70142,\"node_id\":\"MDQ6VXNlcjcwMTQy\",\"avatar_url\":\"https://0.gravatar.com/avatar/6906f317a4733f4379b06c32229ef02f?d=https%3A%2F%2Fidenticons.github.com%2Ff426f04f2f9813718fb806b30e0093de.png\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/jquery\",\"html_url\":\"https://github.com/jquery\",\"followers_url\":\"https://api.github.com/users/jquery/followers\",\"following_url\":\"https://api.github.com/users/jquery/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/jquery/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/jquery/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/jquery/subscriptions\",\"organizations_url\":\"https://api.github.com/users/jquery/orgs\",\"repos_url\":\"https://api.github.com/users/jquery/repos\",\"events_url\":\"https://api.github.com/users/jquery/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/jquery/received_events\",\"type\":\"Organization\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/jquery/jquery\",\"description\":\"jQuery JavaScript Library\",\"fork\":false,\"url\":\"https://api.github.com/repos/jquery/jquery\",\"forks_url\":\"https://api.github.com/repos/jquery/jquery/forks\",\"keys_url\":\"https://api.github.com/repos/jquery/jquery/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/jquery/jquery/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/jquery/jquery/teams\",\"hooks_url\":\"https://api.github.com/repos/jquery/jquery/hooks\",\"issue_events_url\":\"https://api.github.com/repos/jquery/jquery/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/jquery/jquery/events\",\"assignees_url\":\"https://api.github.com/repos/jquery/jquery/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/jquery/jquery/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/jquery/jquery/tags\",\"blobs_url\":\"https://api.github.com/repos/jquery/jquery/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/jquery/jquery/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/jquery/jquery/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/jquery/jquery/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/jquery/jquery/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/jquery/jquery/languages\",\"stargazers_url\":\"https://api.github.com/repos/jquery/jquery/stargazers\",\"contributors_url\":\"https://api.github.com/repos/jquery/jquery/contributors\",\"subscribers_url\":\"https://api.github.com/repos/jquery/jquery/subscribers\",\"subscription_url\":\"https://api.github.com/repos/jquery/jquery/subscription\",\"commits_url\":\"https://api.github.com/repos/jquery/jquery/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/jquery/jquery/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/jquery/jquery/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/jquery/jquery/issues/comments/{number}\",\"contents_url\":\"https://api.github.com/repos/jquery/jquery/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/jquery/jquery/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/jquery/jquery/merges\",\"archive_url\":\"https://api.github.com/repos/jquery/jquery/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/jquery/jquery/downloads\",\"issues_url\":\"https://api.github.com/repos/jquery/jquery/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/jquery/jquery/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/jquery/jquery/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/jquery/jquery/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/jquery/jquery/labels{/name}\"},\"score\":0.5269679}]}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Search commits", + "scope": "search", + "id": "commits", + "method": "GET", + "url": "/search/commits", + "isDeprecated": false, + "isLegacy": false, + "description": "Find commits via various criteria. This method returns up to 100 results [per page](https://developer.github.com/v3/#pagination).\n\nWhen searching for commits, you can get text match metadata for the **message** field when you provide the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://developer.github.com/v3/search/#text-match-metadata).\n\n**Considerations for commit search**\n\nOnly the _default branch_ is considered. In most cases, this will be the `master` branch.\n\nSuppose you want to find commits related to CSS in the [octocat/Spoon-Knife](https://github.com/octocat/Spoon-Knife) repository. Your query would look something like this:", + "documentationUrl": "https://developer.github.com/v3/search/#search-commits", + "previews": [{ "name": "cloak" }], + "headers": [ + { + "name": "accept", + "value": "application/vnd.github.cloak-preview+json", + "required": true + } + ], + "parameters": [ + { + "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See \"[Searching commits](https://help.github.com/articles/searching-commits/)\" for a detailed list of qualifiers.", + "in": "QUERY", "type": "string", "required": true, "enum": null, @@ -42929,12 +34672,12 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "sort", + "description": "Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", + "in": "QUERY", "type": "string", - "required": true, - "enum": null, + "required": false, + "enum": ["author-date", "committer-date"], "allowNull": false, "mapToData": null, "validation": null, @@ -42942,46 +34685,24 @@ "deprecated": null }, { - "name": "permission", - "description": "The permission to grant the team on this repository. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer this repository. \n\\* `push` - team members can pull and push, but not administer this repository. \n\\* `admin` - team members can pull, push and administer this repository. \n \nIf no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.", - "in": "BODY", + "name": "order", + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", + "in": "QUERY", "type": "string", "required": false, - "enum": ["pull", "push", "admin"], + "enum": ["desc", "asc"], "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - } - ], - "responses": [], - "renamed": { - "before": { "scope": "teams", "id": "addOrUpdateRepo" }, - "after": { "scope": "teams", "id": "addOrUpdateRepoLegacy" }, - "date": "2020-01-16", - "note": "The path for \"Add or update team repository\" changed from \"/teams/{team_id}*\" to \"/orgs/{org}/teams/{team_slug}*\"). The operation ID for the old path now has a \"-legacy\" suffix. The route with the new path has a \"-for-org\" suffix in the operation ID to avoid breaking changes" - } - }, - { - "name": "Remove team repository (Legacy)", - "scope": "teams", - "id": "removeRepoLegacy", - "method": "DELETE", - "url": "/teams/{team_id}/repos/{owner}/{repo}", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Remove team repository`](https://developer.github.com/v3/teams/#remove-team-repository) endpoint.\n\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.", - "documentationUrl": "https://developer.github.com/v3/teams/#remove-team-repository-legacy", - "previews": [], - "headers": [], - "parameters": [ + }, { - "name": "team_id", - "description": "team_id parameter", - "in": "PATH", + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", "type": "integer", - "required": true, + "required": false, "enum": null, "allowNull": false, "mapToData": null, @@ -42990,53 +34711,50 @@ "deprecated": null }, { - "name": "owner", - "description": "owner parameter", - "in": "PATH", - "type": "string", - "required": true, + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, "enum": null, "allowNull": false, "mapToData": null, "validation": null, "alias": null, "deprecated": null - }, + } + ], + "responses": [ { - "name": "repo", - "description": "repo parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null + "code": 200, + "description": "response", + "examples": [ + { + "data": "{\"total_count\":1,\"incomplete_results\":false,\"items\":[{\"url\":\"https://api.github.com/repos/octocat/Spoon-Knife/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f\",\"sha\":\"bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f\",\"html_url\":\"https://github.com/octocat/Spoon-Knife/commit/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f\",\"comments_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f/comments\",\"commit\":{\"url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/commits/bb4cc8d3b2e14b3af5df699876dd4ff3acd00b7f\",\"author\":{\"date\":\"2014-02-04T14:38:36-08:00\",\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"},\"committer\":{\"date\":\"2014-02-12T15:18:55-08:00\",\"name\":\"The Octocat\",\"email\":\"octocat@nowhere.com\"},\"message\":\"Create styles.css and updated README\",\"tree\":{\"url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/trees/a639e96f9038797fba6e0469f94a4b0cc459fa68\",\"sha\":\"a639e96f9038797fba6e0469f94a4b0cc459fa68\"},\"comment_count\":8},\"author\":{\"login\":\"octocat\",\"id\":583231,\"node_id\":\"MDQ6VXNlcjU4MzIzMQ==\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=3\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"committer\":{\"login\":\"octocat\",\"id\":583231,\"node_id\":\"MDQ6VXNlcjU4MzIzMQ==\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=3\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"parents\":[{\"url\":\"https://api.github.com/repos/octocat/Spoon-Knife/commits/a30c19e3f13765a3b48829788bc1cb8b4e95cee4\",\"html_url\":\"https://github.com/octocat/Spoon-Knife/commit/a30c19e3f13765a3b48829788bc1cb8b4e95cee4\",\"sha\":\"a30c19e3f13765a3b48829788bc1cb8b4e95cee4\"}],\"repository\":{\"id\":1300192,\"node_id\":\"MDEwOlJlcG9zaXRvcnkxMzAwMTky\",\"name\":\"Spoon-Knife\",\"full_name\":\"octocat/Spoon-Knife\",\"owner\":{\"login\":\"octocat\",\"id\":583231,\"node_id\":\"MDQ6VXNlcjU4MzIzMQ==\",\"avatar_url\":\"https://avatars.githubusercontent.com/u/583231?v=3\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"private\":false,\"html_url\":\"https://github.com/octocat/Spoon-Knife\",\"description\":\"This repo is for demonstration purposes only.\",\"fork\":false,\"url\":\"https://api.github.com/repos/octocat/Spoon-Knife\",\"forks_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/forks\",\"keys_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/keys{/key_id}\",\"collaborators_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/collaborators{/collaborator}\",\"teams_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/teams\",\"hooks_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/hooks\",\"issue_events_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/issues/events{/number}\",\"events_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/events\",\"assignees_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/assignees{/user}\",\"branches_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/branches{/branch}\",\"tags_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/tags\",\"blobs_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/blobs{/sha}\",\"git_tags_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/tags{/sha}\",\"git_refs_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/refs{/sha}\",\"trees_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/trees{/sha}\",\"statuses_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/statuses/{sha}\",\"languages_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/languages\",\"stargazers_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/stargazers\",\"contributors_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/contributors\",\"subscribers_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/subscribers\",\"subscription_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/subscription\",\"commits_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/commits{/sha}\",\"git_commits_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/git/commits{/sha}\",\"comments_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/comments{/number}\",\"issue_comment_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/issues/comments{/number}\",\"contents_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/contents/{+path}\",\"compare_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/compare/{base}...{head}\",\"merges_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/merges\",\"archive_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/{archive_format}{/ref}\",\"downloads_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/downloads\",\"issues_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/issues{/number}\",\"pulls_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/pulls{/number}\",\"milestones_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/milestones{/number}\",\"notifications_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/notifications{?since,all,participating}\",\"labels_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/labels{/name}\",\"releases_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/releases{/id}\",\"deployments_url\":\"https://api.github.com/repos/octocat/Spoon-Knife/deployments\"},\"score\":4.9971514}]}" + } + ] } ], - "responses": [], "renamed": null }, { - "name": "Remove team repository (Legacy)", - "scope": "teams", - "id": "removeRepo", - "method": "DELETE", - "url": "/teams/{team_id}/repos/{owner}/{repo}", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Remove team repository`](https://developer.github.com/v3/teams/#remove-team-repository) endpoint.\n\nIf the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team.", - "documentationUrl": "https://developer.github.com/v3/teams/#remove-team-repository-legacy", + "name": "Search issues and pull requests", + "scope": "search", + "id": "issuesAndPullRequests", + "method": "GET", + "url": "/search/issues", + "isDeprecated": false, + "isLegacy": false, + "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://developer.github.com/v3/#pagination).\n\nWhen searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://developer.github.com/v3/search/#text-match-metadata).\n\nLet's say you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this.\n\nIn this query, we're searching for the keyword `windows`, within any open issue that's labeled as `bug`. The search runs across repositories whose primary language is Python. We’re sorting by creation date in ascending order, so that the oldest issues appear first in the search results.", + "documentationUrl": "https://developer.github.com/v3/search/#search-issues-and-pull-requests", "previews": [], "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", - "in": "PATH", - "type": "integer", + "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See \"[Searching issues and pull requests](https://help.github.com/articles/searching-issues-and-pull-requests/)\" for a detailed list of qualifiers.", + "in": "QUERY", + "type": "string", "required": true, "enum": null, "allowNull": false, @@ -43046,12 +34764,24 @@ "deprecated": null }, { - "name": "owner", - "description": "owner parameter", - "in": "PATH", + "name": "sort", + "description": "Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", + "in": "QUERY", "type": "string", - "required": true, - "enum": null, + "required": false, + "enum": [ + "comments", + "reactions", + "reactions-+1", + "reactions--1", + "reactions-smile", + "reactions-thinking_face", + "reactions-heart", + "reactions-tada", + "interactions", + "created", + "updated" + ], "allowNull": false, "mapToData": null, "validation": null, @@ -43059,47 +34789,12 @@ "deprecated": null }, { - "name": "repo", - "description": "repo parameter", - "in": "PATH", + "name": "order", + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", + "in": "QUERY", "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [], - "renamed": { - "before": { "scope": "teams", "id": "removeRepo" }, - "after": { "scope": "teams", "id": "removeRepoLegacy" }, - "date": "2020-01-16", - "note": "The path for \"Remove team repository\" changed from \"/teams/{team_id}*\" to \"/orgs/{org}/teams/{team_slug}*\"). The operation ID for the old path now has a \"-legacy\" suffix. The route with the new path has a \"-for-org\" suffix in the operation ID to avoid breaking changes" - } - }, - { - "name": "List child teams (Legacy)", - "scope": "teams", - "id": "listChildLegacy", - "method": "GET", - "url": "/teams/{team_id}/teams", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://developer.github.com/v3/teams/#list-child-teams) endpoint.\n\n", - "documentationUrl": "https://developer.github.com/v3/teams/#list-child-teams-legacy", - "previews": [], - "headers": [], - "parameters": [ - { - "name": "team_id", - "description": "team_id parameter", - "in": "PATH", - "type": "integer", - "required": true, - "enum": null, + "required": false, + "enum": ["desc", "asc"], "allowNull": false, "mapToData": null, "validation": null, @@ -43136,10 +34831,10 @@ "responses": [ { "code": 200, - "description": "Response if child teams exist", + "description": "response", "examples": [ { - "data": "[{\"id\":2,\"node_id\":\"MDQ6VGVhbTI=\",\"url\":\"https://api.github.com/teams/2\",\"name\":\"Original Roster\",\"slug\":\"original-roster\",\"description\":\"Started it all.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/2/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/2/repos\",\"parent\":{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"}}]" + "data": "{\"total_count\":280,\"incomplete_results\":false,\"items\":[{\"url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132\",\"repository_url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit\",\"labels_url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/labels{/name}\",\"comments_url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/comments\",\"events_url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/issues/132/events\",\"html_url\":\"https://github.com/batterseapower/pinyin-toolkit/issues/132\",\"id\":35802,\"node_id\":\"MDU6SXNzdWUzNTgwMg==\",\"number\":132,\"title\":\"Line Number Indexes Beyond 20 Not Displayed\",\"user\":{\"login\":\"Nick3C\",\"id\":90254,\"node_id\":\"MDQ6VXNlcjkwMjU0\",\"avatar_url\":\"https://secure.gravatar.com/avatar/934442aadfe3b2f4630510de416c5718?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/Nick3C\",\"html_url\":\"https://github.com/Nick3C\",\"followers_url\":\"https://api.github.com/users/Nick3C/followers\",\"following_url\":\"https://api.github.com/users/Nick3C/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/Nick3C/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/Nick3C/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/Nick3C/subscriptions\",\"organizations_url\":\"https://api.github.com/users/Nick3C/orgs\",\"repos_url\":\"https://api.github.com/users/Nick3C/repos\",\"events_url\":\"https://api.github.com/users/Nick3C/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/Nick3C/received_events\",\"type\":\"User\"},\"labels\":[{\"id\":4,\"node_id\":\"MDU6TGFiZWw0\",\"url\":\"https://api.github.com/repos/batterseapower/pinyin-toolkit/labels/bug\",\"name\":\"bug\",\"color\":\"ff0000\"}],\"state\":\"open\",\"assignee\":null,\"milestone\":null,\"comments\":15,\"created_at\":\"2009-07-12T20:10:41Z\",\"updated_at\":\"2009-07-19T09:23:43Z\",\"closed_at\":null,\"pull_request\":{\"html_url\":null,\"diff_url\":null,\"patch_url\":null},\"body\":\"...\",\"score\":1.3859273}]}" } ] } @@ -43147,22 +34842,22 @@ "renamed": null }, { - "name": "List child teams (Legacy)", - "scope": "teams", - "id": "listChild", + "name": "Search labels", + "scope": "search", + "id": "labels", "method": "GET", - "url": "/teams/{team_id}/teams", - "isDeprecated": true, - "isLegacy": true, - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://developer.github.com/v3/teams/#list-child-teams) endpoint.\n\n", - "documentationUrl": "https://developer.github.com/v3/teams/#list-child-teams-legacy", + "url": "/search/labels", + "isDeprecated": false, + "isLegacy": false, + "description": "Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://developer.github.com/v3/#pagination).\n\nWhen searching for labels, you can get text match metadata for the label **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://developer.github.com/v3/search/#text-match-metadata).\n\nSuppose you want to find labels in the `linguist` repository that match `bug`, `defect`, or `enhancement`. Your query might look like this:\n\nThe labels that best match for the query appear first in the search results.", + "documentationUrl": "https://developer.github.com/v3/search/#search-labels", "previews": [], "headers": [], "parameters": [ { - "name": "team_id", - "description": "team_id parameter", - "in": "PATH", + "name": "repository_id", + "description": "The id of the repository.", + "in": "QUERY", "type": "integer", "required": true, "enum": null, @@ -43172,6 +34867,111 @@ "alias": null, "deprecated": null }, + { + "name": "q", + "description": "The search keywords. This endpoint does not accept qualifiers in the query. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query).", + "in": "QUERY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "sort", + "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["created", "updated"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "order", + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["desc", "asc"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "response", + "examples": [ + { + "data": "{\"total_count\":2,\"incomplete_results\":false,\"items\":[{\"id\":418327088,\"node_id\":\"MDU6TGFiZWw0MTgzMjcwODg=\",\"url\":\"https://api.github.com/repos/octocat/linguist/labels/enhancement\",\"name\":\"enhancement\",\"color\":\"84b6eb\",\"default\":true,\"description\":\"New feature or request.\",\"score\":0.1193385},{\"id\":418327086,\"node_id\":\"MDU6TGFiZWw0MTgzMjcwODY=\",\"url\":\"https://api.github.com/repos/octocat/linguist/labels/bug\",\"name\":\"bug\",\"color\":\"ee0701\",\"default\":true,\"description\":\"Something isn't working.\",\"score\":0.11928606}]}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Search repositories", + "scope": "search", + "id": "repos", + "method": "GET", + "url": "/search/repositories", + "isDeprecated": false, + "isLegacy": false, + "description": "Find repositories via various criteria. This method returns up to 100 results [per page](https://developer.github.com/v3/#pagination).\n\nWhen searching for repositories, you can get text match metadata for the **name** and **description** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://developer.github.com/v3/search/#text-match-metadata).\n\nSuppose you want to search for popular Tetris repositories written in Assembly. Your query might look like this.\n\nYou can search for multiple topics by adding more `topic:` instances, and including the `mercy-preview` header. For example:\n\nIn this request, we're searching for repositories with the word `tetris` in the name, the description, or the README. We're limiting the results to only find repositories where the primary language is Assembly. We're sorting by stars in descending order, so that the most popular repositories appear first in the search results.", + "documentationUrl": "https://developer.github.com/v3/search/#search-repositories", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See \"[Searching for repositories](https://help.github.com/articles/searching-for-repositories/)\" for a detailed list of qualifiers.", + "in": "QUERY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "sort", + "description": "Sorts the results of your query by number of `stars`, `forks`, or `help-wanted-issues` or how recently the items were `updated`. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["stars", "forks", "help-wanted-issues", "updated"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "order", + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["desc", "asc"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, { "name": "per_page", "description": "Results per page (max 100)", @@ -43202,20 +35002,147 @@ "responses": [ { "code": 200, - "description": "Response if child teams exist", + "description": "response", "examples": [ { - "data": "[{\"id\":2,\"node_id\":\"MDQ6VGVhbTI=\",\"url\":\"https://api.github.com/teams/2\",\"name\":\"Original Roster\",\"slug\":\"original-roster\",\"description\":\"Started it all.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/2/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/2/repos\",\"parent\":{\"id\":1,\"node_id\":\"MDQ6VGVhbTE=\",\"url\":\"https://api.github.com/teams/1\",\"html_url\":\"https://api.github.com/teams/justice-league\",\"name\":\"Justice League\",\"slug\":\"justice-league\",\"description\":\"A great team.\",\"privacy\":\"closed\",\"permission\":\"admin\",\"members_url\":\"https://api.github.com/teams/1/members{/member}\",\"repositories_url\":\"https://api.github.com/teams/1/repos\"}}]" + "data": "{\"total_count\":40,\"incomplete_results\":false,\"items\":[{\"id\":3081286,\"node_id\":\"MDEwOlJlcG9zaXRvcnkzMDgxMjg2\",\"name\":\"Tetris\",\"full_name\":\"dtrupenn/Tetris\",\"owner\":{\"login\":\"dtrupenn\",\"id\":872147,\"node_id\":\"MDQ6VXNlcjg3MjE0Nw==\",\"avatar_url\":\"https://secure.gravatar.com/avatar/e7956084e75f239de85d3a31bc172ace?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/dtrupenn\",\"received_events_url\":\"https://api.github.com/users/dtrupenn/received_events\",\"type\":\"User\"},\"private\":false,\"html_url\":\"https://github.com/dtrupenn/Tetris\",\"description\":\"A C implementation of Tetris using Pennsim through LC4\",\"fork\":false,\"url\":\"https://api.github.com/repos/dtrupenn/Tetris\",\"created_at\":\"2012-01-01T00:31:50Z\",\"updated_at\":\"2013-01-05T17:58:47Z\",\"pushed_at\":\"2012-01-01T00:37:02Z\",\"homepage\":\"\",\"size\":524,\"stargazers_count\":1,\"watchers_count\":1,\"language\":\"Assembly\",\"forks_count\":0,\"open_issues_count\":0,\"master_branch\":\"master\",\"default_branch\":\"master\",\"score\":10.309712}]}" } ] } ], - "renamed": { - "before": { "scope": "teams", "id": "listChild" }, - "after": { "scope": "teams", "id": "listChildLegacy" }, - "date": "2020-01-16", - "note": "The path for \"List child teams\" changed from \"/teams/{team_id}*\" to \"/orgs/{org}/teams/{team_slug}*\"). The operation ID for the old path now has a \"-legacy\" suffix. The route with the new path has a \"-for-org\" suffix in the operation ID to avoid breaking changes" - } + "renamed": null + }, + { + "name": "Search topics", + "scope": "search", + "id": "topics", + "method": "GET", + "url": "/search/topics", + "isDeprecated": false, + "isLegacy": false, + "description": "Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://developer.github.com/v3/#pagination).\n\nWhen searching for topics, you can get text match metadata for the topic's **short\\_description**, **description**, **name**, or **display\\_name** field when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://developer.github.com/v3/search/#text-match-metadata).\n\nSee \"[Searching topics](https://help.github.com/articles/searching-topics/)\" for a detailed list of qualifiers.\n\nSuppose you want to search for topics related to Ruby that are featured on [https://github.com/topics](https://github.com/topics). Your query might look like this:\n\nIn this request, we're searching for topics with the keyword `ruby`, and we're limiting the results to find only topics that are featured. The topics that are the best match for the query appear first in the search results.\n\n**Note:** A search for featured Ruby topics only has 6 total results, so a [Link header](https://developer.github.com/v3/#link-header) indicating pagination is not included in the response.", + "documentationUrl": "https://developer.github.com/v3/search/#search-topics", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query).", + "in": "QUERY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "response", + "examples": [ + { + "data": "{\"total_count\":6,\"incomplete_results\":false,\"items\":[{\"name\":\"ruby\",\"display_name\":\"Ruby\",\"short_description\":\"Ruby is a scripting language designed for simplified object-oriented programming.\",\"description\":\"Ruby was developed by Yukihiro \\\"Matz\\\" Matsumoto in 1995 with the intent of having an easily readable programming language. It is integrated with the Rails framework to create dynamic web-applications. Ruby's syntax is similar to that of Perl and Python.\",\"created_by\":\"Yukihiro Matsumoto\",\"released\":\"December 21, 1995\",\"created_at\":\"2016-11-28T22:03:59Z\",\"updated_at\":\"2017-10-30T18:16:32Z\",\"featured\":true,\"curated\":true,\"score\":1750.5872},{\"name\":\"rails\",\"display_name\":\"Rails\",\"short_description\":\"Ruby on Rails (Rails) is a web application framework written in Ruby.\",\"description\":\"Ruby on Rails (Rails) is a web application framework written in Ruby. It is meant to help simplify the building of complex websites.\",\"created_by\":\"David Heinemeier Hansson\",\"released\":\"December 13 2005\",\"created_at\":\"2016-12-09T17:03:50Z\",\"updated_at\":\"2017-10-30T16:20:19Z\",\"featured\":true,\"curated\":true,\"score\":192.49863},{\"name\":\"python\",\"display_name\":\"Python\",\"short_description\":\"Python is a dynamically typed programming language.\",\"description\":\"Python is a dynamically typed programming language designed by Guido Van Rossum. Much like the programming language Ruby, Python was designed to be easily read by programmers. Because of its large following and many libraries, Python can be implemented and used to do anything from webpages to scientific research.\",\"created_by\":\"Guido van Rossum\",\"released\":\"February 20, 1991\",\"created_at\":\"2016-12-07T00:07:02Z\",\"updated_at\":\"2017-10-27T22:45:43Z\",\"featured\":true,\"curated\":true,\"score\":111.92691},{\"name\":\"jekyll\",\"display_name\":\"Jekyll\",\"short_description\":\"Jekyll is a simple, blog-aware static site generator.\",\"description\":\"Jekyll is a blog-aware, site generator written in Ruby. It takes raw text files, runs it through a renderer and produces a publishable static website.\",\"created_by\":\"Tom Preston-Werner\",\"released\":\"2008\",\"created_at\":\"2016-12-16T21:53:08Z\",\"updated_at\":\"2017-10-27T19:00:24Z\",\"featured\":true,\"curated\":true,\"score\":45.06729},{\"name\":\"sass\",\"display_name\":\"Sass\",\"short_description\":\"Sass is a stable extension to classic CSS.\",\"description\":\"Sass is a stylesheet language with a main implementation in Ruby. It is an extension of CSS that makes improvements to the old stylesheet format, such as being able to declare variables and using a cleaner nesting syntax.\",\"created_by\":\"Hampton Catlin, Natalie Weizenbaum, Chris Eppstein\",\"released\":\"November 28, 2006\",\"created_at\":\"2016-12-16T21:53:45Z\",\"updated_at\":\"2018-01-16T16:30:40Z\",\"featured\":true,\"curated\":true,\"score\":42.455986},{\"name\":\"homebrew\",\"display_name\":\"Homebrew\",\"short_description\":\"Homebrew is a package manager for macOS.\",\"description\":\"Homebrew is a package manager for Apple's macOS operating system. It simplifies the installation of software and is popular in the Ruby on Rails community.\",\"created_by\":\"Max Howell\",\"released\":\"2009\",\"created_at\":\"2016-12-17T20:30:44Z\",\"updated_at\":\"2018-02-06T16:14:56Z\",\"featured\":true,\"curated\":true,\"score\":19.194168}]}" + } + ] + } + ], + "renamed": null + }, + { + "name": "Search users", + "scope": "search", + "id": "users", + "method": "GET", + "url": "/search/users", + "isDeprecated": false, + "isLegacy": false, + "description": "Find users via various criteria. This method returns up to 100 results [per page](https://developer.github.com/v3/#pagination).\n\nWhen searching for users, you can get text match metadata for the issue **login**, **email**, and **name** fields when you pass the `text-match` media type. For more details about highlighting search results, see [Text match metadata](https://developer.github.com/v3/search/#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://developer.github.com/v3/search/#text-match-metadata).\n\nImagine you're looking for a list of popular users. You might try out this query:\n\nHere, we're looking at users with the name Tom. We're only interested in those with more than 42 repositories, and only if they have over 1,000 followers.", + "documentationUrl": "https://developer.github.com/v3/search/#search-users", + "previews": [], + "headers": [], + "parameters": [ + { + "name": "q", + "description": "The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See \"[Searching users](https://help.github.com/articles/searching-users/)\" for a detailed list of qualifiers.", + "in": "QUERY", + "type": "string", + "required": true, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "sort", + "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub. Default: [best match](https://developer.github.com/v3/search/#ranking-search-results)", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["followers", "repositories", "joined"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "order", + "description": "Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`.", + "in": "QUERY", + "type": "string", + "required": false, + "enum": ["desc", "asc"], + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "per_page", + "description": "Results per page (max 100)", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "QUERY", + "type": "integer", + "required": false, + "enum": null, + "allowNull": false, + "mapToData": null, + "validation": null, + "alias": null, + "deprecated": null + } + ], + "responses": [ + { + "code": 200, + "description": "response", + "examples": [ + { + "data": "{\"total_count\":12,\"incomplete_results\":false,\"items\":[{\"login\":\"mojombo\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://secure.gravatar.com/avatar/25c7c18223fb42a4c6ae1c8db6f50f9b?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/mojombo\",\"html_url\":\"https://github.com/mojombo\",\"followers_url\":\"https://api.github.com/users/mojombo/followers\",\"subscriptions_url\":\"https://api.github.com/users/mojombo/subscriptions\",\"organizations_url\":\"https://api.github.com/users/mojombo/orgs\",\"repos_url\":\"https://api.github.com/users/mojombo/repos\",\"received_events_url\":\"https://api.github.com/users/mojombo/received_events\",\"type\":\"User\",\"score\":105.47857}]}" + } + ] + } + ], + "renamed": null }, { "name": "Get the authenticated user", @@ -44029,7 +35956,8 @@ "headers": [ { "name": "accept", - "value": "application/vnd.github.machine-man-preview+json" + "value": "application/vnd.github.machine-man-preview+json", + "required": true } ], "parameters": [ @@ -44087,7 +36015,8 @@ "headers": [ { "name": "accept", - "value": "application/vnd.github.machine-man-preview+json" + "value": "application/vnd.github.machine-man-preview+json", + "required": true } ], "parameters": [ @@ -44158,7 +36087,8 @@ "headers": [ { "name": "accept", - "value": "application/vnd.github.machine-man-preview+json" + "value": "application/vnd.github.machine-man-preview+json", + "required": true } ], "parameters": [ @@ -44206,7 +36136,8 @@ "headers": [ { "name": "accept", - "value": "application/vnd.github.machine-man-preview+json" + "value": "application/vnd.github.machine-man-preview+json", + "required": true } ], "parameters": [ @@ -44892,7 +36823,8 @@ "headers": [ { "name": "accept", - "value": "application/vnd.github.wyandotte-preview+json" + "value": "application/vnd.github.wyandotte-preview+json", + "required": true } ], "parameters": [ @@ -44950,7 +36882,8 @@ "headers": [ { "name": "accept", - "value": "application/vnd.github.wyandotte-preview+json" + "value": "application/vnd.github.wyandotte-preview+json", + "required": true } ], "parameters": [ @@ -44995,7 +36928,8 @@ "headers": [ { "name": "accept", - "value": "application/vnd.github.wyandotte-preview+json" + "value": "application/vnd.github.wyandotte-preview+json", + "required": true } ], "parameters": [ @@ -45030,7 +36964,8 @@ "headers": [ { "name": "accept", - "value": "application/vnd.github.wyandotte-preview+json" + "value": "application/vnd.github.wyandotte-preview+json", + "required": true } ], "parameters": [ @@ -45065,7 +37000,8 @@ "headers": [ { "name": "accept", - "value": "application/vnd.github.wyandotte-preview+json" + "value": "application/vnd.github.wyandotte-preview+json", + "required": true } ], "parameters": [ @@ -45166,7 +37102,8 @@ "headers": [ { "name": "accept", - "value": "application/vnd.github.inertia-preview+json" + "value": "application/vnd.github.inertia-preview+json", + "required": true } ], "parameters": [ @@ -46198,7 +38135,8 @@ "headers": [ { "name": "accept", - "value": "application/vnd.github.wyandotte-preview+json" + "value": "application/vnd.github.wyandotte-preview+json", + "required": true } ], "parameters": [ @@ -46945,7 +38883,8 @@ "headers": [ { "name": "accept", - "value": "application/vnd.github.machine-man-preview+json" + "value": "application/vnd.github.machine-man-preview+json", + "required": true } ], "parameters": [ @@ -46976,56 +38915,6 @@ ], "renamed": null }, - { - "name": "Get a user installation", - "scope": "apps", - "id": "findUserInstallation", - "method": "GET", - "url": "/users/{username}/installation", - "isDeprecated": false, - "isLegacy": false, - "description": "Enables an authenticated GitHub App to find the user’s installation information.\n\nYou must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "documentationUrl": "https://developer.github.com/v3/apps/#get-a-user-installation", - "previews": [{ "name": "machine-man" }], - "headers": [ - { - "name": "accept", - "value": "application/vnd.github.machine-man-preview+json" - } - ], - "parameters": [ - { - "name": "username", - "description": "username parameter", - "in": "PATH", - "type": "string", - "required": true, - "enum": null, - "allowNull": false, - "mapToData": null, - "validation": null, - "alias": null, - "deprecated": null - } - ], - "responses": [ - { - "code": 200, - "description": "response", - "examples": [ - { - "data": "{\"id\":3,\"account\":{\"login\":\"octocat\",\"id\":1,\"node_id\":\"MDQ6VXNlcjE=\",\"avatar_url\":\"https://github.com/images/error/octocat_happy.gif\",\"gravatar_id\":\"\",\"url\":\"https://api.github.com/users/octocat\",\"html_url\":\"https://github.com/octocat\",\"followers_url\":\"https://api.github.com/users/octocat/followers\",\"following_url\":\"https://api.github.com/users/octocat/following{/other_user}\",\"gists_url\":\"https://api.github.com/users/octocat/gists{/gist_id}\",\"starred_url\":\"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\"subscriptions_url\":\"https://api.github.com/users/octocat/subscriptions\",\"organizations_url\":\"https://api.github.com/users/octocat/orgs\",\"repos_url\":\"https://api.github.com/users/octocat/repos\",\"events_url\":\"https://api.github.com/users/octocat/events{/privacy}\",\"received_events_url\":\"https://api.github.com/users/octocat/received_events\",\"type\":\"User\",\"site_admin\":false},\"repository_selection\":\"selected\",\"access_tokens_url\":\"https://api.github.com/installations/3/access_tokens\",\"repositories_url\":\"https://api.github.com/installation/repositories\",\"html_url\":\"https://github.com/organizations/github/settings/installations/3\",\"app_id\":2,\"target_id\":1,\"target_type\":\"User\",\"permissions\":{\"checks\":\"write\",\"metadata\":\"read\",\"contents\":\"read\"},\"events\":[\"label\"],\"created_at\":\"2018-02-22T20:51:14Z\",\"updated_at\":\"2018-02-22T20:51:14Z\",\"single_file_name\":null}" - } - ] - } - ], - "renamed": { - "before": { "scope": "apps", "id": "findUserInstallation" }, - "after": { "scope": "apps", "id": "getUserInstallation" }, - "date": "2019-04-10", - "note": "\"Find repository installation\" renamed to \"Get a repository installation\"" - } - }, { "name": "List public keys for a user", "scope": "users", @@ -47168,7 +39057,8 @@ "headers": [ { "name": "accept", - "value": "application/vnd.github.inertia-preview+json" + "value": "application/vnd.github.inertia-preview+json", + "required": true } ], "parameters": [ diff --git a/scripts/update-endpoints/types.js b/scripts/update-endpoints/types.js index 519527897..cc157abff 100644 --- a/scripts/update-endpoints/types.js +++ b/scripts/update-endpoints/types.js @@ -312,7 +312,7 @@ type EmptyParams = {};`, process.cwd(), "src", "generated", - "rest-endpoint-methods-types.ts" + "types.ts" ); writeFileSync(definitionFilePath, source, "utf8"); @@ -337,17 +337,16 @@ async function getRoutes() { method: endpoint.method, url, description: endpoint.description, - headers: endpoint.headers.reduce((result, header) => { - if (!result) { - result = {}; - } - result[header.name] = header.value; - return result; - }, undefined), deprecated: newRoutes[scope][idName] ? newRoutes[scope][idName].deprecated : undefined, params: endpoint.parameters.reduce((result, param) => { + // "origin" is a URL parameter only relevant for octokit.repos.uploadReleaseAsset() + // We remove it and set a default for `baseUrl`, which is a special default parameter + if (param.name === "origin") { + return result; + } + result[param.name] = { type: param.type, description: @@ -398,14 +397,32 @@ async function getRoutes() { : undefined }; - const previewHeaders = endpoint.previews - .map(preview => `application/vnd.github.${preview.name}-preview+json`) - .join(","); + // add required headers as parameters + const requiredHeaders = endpoint.headers.filter(header => { + // if value is set, we pass the header with its expected value automatically + if (header.value) { + return false; + } + + return header.required; + }); - if (previewHeaders) { - newRoutes[scope][idName].headers = { - accept: previewHeaders + if (requiredHeaders.length) { + newRoutes[scope][idName].params.headers = { + type: "object", + required: true }; + for (const header of requiredHeaders) { + // Content-Length header is set automatically + if (header.name === "content-length") { + continue; + } + + newRoutes[scope][idName].params[`headers.${header.name}`] = { + type: "string", + required: true + }; + } } if (endpoint.renamed) { @@ -430,220 +447,5 @@ async function getRoutes() { } }); - // temporary workaround to bring back obsolete `octokit.repos.getCommitRefSha()` method - newRoutes.repos.getCommitRefSha = { - deprecated: - '"Get the SHA-1 of a commit reference" will be removed. Use "Get a single commit" instead with media type format set to "sha" instead.', - method: "GET", - description: - "**Note:** To access this endpoint, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header:\n```\napplication/vnd.github.VERSION.sha\n```\nReturns the SHA-1 of the commit reference. You must have `read` access for the repository to get the SHA-1 of a commit reference. You can use this endpoint to check if a remote reference's SHA-1 is the same as your local reference's SHA-1 by providing the local SHA-1 reference as the ETag.", - params: { - owner: { - required: true, - type: "string" - }, - ref: { - required: true, - type: "string" - }, - repo: { - required: true, - type: "string" - } - }, - url: "/repos/:owner/:repo/commits/:ref" - }; - - // Temporary workarounds to bring back endpoints that got lost due to transition to OpenAPI spec of octokit/routes - // New API endpoints that will replace these are in the works, so that workaround can be removed soon - newRoutes.git.listRefs = { - method: "GET", - description: - "Returns an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. If there are no references to list, a `404` is returned.", - params: { - namespace: { - type: "string", - description: - "Filter by sub-namespace (reference prefix). Most commen examples would be `'heads/'` and `'tags/'` to retrieve branches or tags" - }, - owner: { - required: true, - type: "string" - }, - page: { - type: "integer" - }, - per_page: { - type: "integer" - }, - repo: { - required: true, - type: "string" - } - }, - url: "/repos/:owner/:repo/git/refs/:namespace" - }; - newRoutes.issues.updateLabel = { - method: "PATCH", - description: "", - params: { - color: { - type: "string", - description: - "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`." - }, - current_name: { - required: true, - type: "string" - }, - description: { - type: "string", - description: "A short description of the label." - }, - name: { - type: "string", - description: - 'The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see [emoji-cheat-sheet.com](http://emoji-cheat-sheet.com/).' - }, - owner: { - required: true, - type: "string" - }, - repo: { - required: true, - type: "string" - } - }, - url: "/repos/:owner/:repo/labels/:current_name", - responses: [ - { - id: 208045946, - node_id: "MDU6TGFiZWwyMDgwNDU5NDY=", - url: - "https://api.github.com/repos/octocat/Hello-World/labels/bug%20:bug:", - name: "bug :bug:", - description: "Small bug fix required", - color: "b01f26", - default: true - } - ] - }; - - newRoutes.pulls.createFromIssue = { - isDeprecated: true, - method: "POST", - description: "", - params: { - base: { required: true, type: "string" }, - draft: { type: "boolean" }, - head: { required: true, type: "string" }, - issue: { required: true, type: "integer" }, - maintainer_can_modify: { type: "boolean" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/pulls", - responses: newRoutes.pulls.create.responses - }; - - // workaround to bring back the simpler `octokit.repos.uploadReleaseAsset()` method - newRoutes.repos.uploadReleaseAsset = { - method: "POST", - description: `This endpoint makes use of [a Hypermedia relation](https://developer.github.com/v3/#hypermedia) to determine which URL to access. The endpoint you call to upload release assets is specific to your release. Use the \`upload_url\` returned in the response of the [Create a release endpoint](https://developer.github.com/v3/repos/releases/#create-a-release) to upload a release asset. - -You need to use an HTTP client which supports [SNI](http://en.wikipedia.org/wiki/Server_Name_Indication) to make calls to this endpoint. - -Most libraries will set the required \`Content-Length\` header automatically. Use the required \`Content-Type\` header to provide the media type of the asset. For a list of media types, see [Media Types](https://www.iana.org/assignments/media-types/media-types.xhtml). For example: - -\`application/zip\` - -GitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example, you'll still need to pass your authentication to be able to upload an asset.`, - params: { - data: { - mapTo: "data", - required: true, - type: "string | object" - }, - file: { - mapTo: "data", - deprecated: true, - type: "string | object", - alias: "data" - }, - headers: { - required: true, - type: "object" - }, - "headers.content-length": { - required: true, - type: "integer" - }, - "headers.content-type": { - required: true, - type: "string" - }, - label: { - type: "string", - description: `An alternate short description of the asset. Used in place of the filename. This should be set in a URI query parameter.` - }, - name: { - required: true, - type: "string", - description: `The file name of the asset. This should be set in a URI query parameter.` - }, - url: { - required: true, - type: "string", - description: - "The `upload_url` key returned from creating or getting a release" - } - }, - url: ":url", - responses: [ - { - value: { - url: - "https://api.github.com/repos/octocat/Hello-World/releases/assets/1", - browser_download_url: - "https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip", - id: 1, - node_id: "MDEyOlJlbGVhc2VBc3NldDE=", - name: "example.zip", - label: "short description", - state: "uploaded", - content_type: "application/zip", - size: 1024, - download_count: 42, - created_at: "2013-02-27T19:35:32Z", - updated_at: "2013-02-27T19:35:32Z", - uploader: { - login: "octocat", - id: 1, - node_id: "MDQ6VXNlcjE=", - avatar_url: "https://github.com/images/error/octocat_happy.gif", - gravatar_id: "", - url: "https://api.github.com/users/octocat", - html_url: "https://github.com/octocat", - followers_url: "https://api.github.com/users/octocat/followers", - following_url: - "https://api.github.com/users/octocat/following{/other_user}", - gists_url: "https://api.github.com/users/octocat/gists{/gist_id}", - starred_url: - "https://api.github.com/users/octocat/starred{/owner}{/repo}", - subscriptions_url: - "https://api.github.com/users/octocat/subscriptions", - organizations_url: "https://api.github.com/users/octocat/orgs", - repos_url: "https://api.github.com/users/octocat/repos", - events_url: "https://api.github.com/users/octocat/events{/privacy}", - received_events_url: - "https://api.github.com/users/octocat/received_events", - type: "User", - site_admin: false - } - } - } - ] - }; - return sortKeys(newRoutes, { deep: true }); } diff --git a/src/endpoints-to-methods.ts b/src/endpoints-to-methods.ts new file mode 100644 index 000000000..8dda542c9 --- /dev/null +++ b/src/endpoints-to-methods.ts @@ -0,0 +1,113 @@ +import { Octokit } from "@octokit/core"; +import { + EndpointOptions, + RequestParameters, + RequestMethod, + Route, + Url +} from "@octokit/types"; +import { EndpointsDefaultsAndDecorations, EndpointDecorations } from "./types"; +import { RestEndpointMethods } from "./generated/types"; + +type EndpointMethods = { + [methodName: string]: typeof Octokit.prototype.request; +}; + +export function endpointsToMethods( + octokit: Octokit, + endpointsMap: EndpointsDefaultsAndDecorations +) { + const newMethods = {} as { [key: string]: object }; + + for (const [scope, endpoints] of Object.entries(endpointsMap)) { + for (const [methodName, endpoint] of Object.entries(endpoints)) { + const [route, defaults, decorations] = endpoint; + const [method, url] = route.split(/ /) as [RequestMethod, Url]; + const endpointDefaults: EndpointOptions = Object.assign( + { method, url }, + defaults + ); + + if (!newMethods[scope]) { + newMethods[scope] = {}; + } + + const scopeMethods = newMethods[scope] as EndpointMethods; + + if (decorations) { + scopeMethods[methodName] = decorate( + octokit, + scope, + methodName, + endpointDefaults, + decorations + ); + continue; + } + + scopeMethods[methodName] = octokit.request.defaults(endpointDefaults); + } + } + + return newMethods as RestEndpointMethods; +} + +function decorate( + octokit: Octokit, + scope: string, + methodName: string, + defaults: EndpointOptions, + decorations: EndpointDecorations +) { + const requestWithDefaults = octokit.request.defaults(defaults); + + function withDecorations( + ...args: [Route, RequestParameters?] | [EndpointOptions] + ) { + // @ts-ignore https://github.com/microsoft/TypeScript/issues/25488 + let options = requestWithDefaults.endpoint.merge(...args); + + // There are currently no other decorations than `.mapToData` + /* istanbul ignore else */ + if (decorations.mapToData) { + options = Object.assign({}, options, { + data: options[decorations.mapToData], + [decorations.mapToData]: undefined + }); + return requestWithDefaults(options); + } + + // NOTE: there are currently no deprecations. But we keep the code + // below for future reference + // if (decorations.renamed) { + // const [newScope, newMethodName] = decorations.renamed; + // octokit.log.warn( + // `octokit.${scope}.${methodName}() has been renamed to octokit.${newScope}.${newMethodName}()` + // ); + // } + // if (decorations.deprecated) { + // octokit.log.warn(decorations.deprecated); + // } + // if (decorations.renamedParameters) { + // // @ts-ignore https://github.com/microsoft/TypeScript/issues/25488 + // const options = requestWithDefaults.endpoint.merge(...args); + // for (const [name, alias] of Object.entries( + // decorations.renamedParameters + // )) { + // if (name in options) { + // octokit.log.warn( + // `"${name}" parameter is deprecated for "octokit.${scope}.${methodName}()". Use "${alias}" instead` + // ); + // if (!(alias in options)) { + // options[alias] = options[name]; + // } + // delete options[name]; + // } + // } + // return requestWithDefaults(options); + // } + // @ts-ignore https://github.com/microsoft/TypeScript/issues/25488 + // return requestWithDefaults(...args); + } + return Object.assign(withDecorations, requestWithDefaults); +} diff --git a/src/generated/endpoints.ts b/src/generated/endpoints.ts index 289dbc06e..da8d51cb9 100644 --- a/src/generated/endpoints.ts +++ b/src/generated/endpoints.ts @@ -1,6758 +1,1143 @@ -export default { +import { EndpointsDefaultsAndDecorations } from "../types"; +const Endpoints: EndpointsDefaultsAndDecorations = { actions: { - cancelWorkflowRun: { - method: "POST", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" }, - run_id: { required: true, type: "integer" } - }, - url: "/repos/:owner/:repo/actions/runs/:run_id/cancel" - }, - createOrUpdateSecretForRepo: { - method: "PUT", - params: { - encrypted_value: { type: "string" }, - key_id: { type: "string" }, - name: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/actions/secrets/:name" - }, - createRegistrationToken: { - method: "POST", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/actions/runners/registration-token" - }, - createRemoveToken: { - method: "POST", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/actions/runners/remove-token" - }, - deleteArtifact: { - method: "DELETE", - params: { - artifact_id: { required: true, type: "integer" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/actions/artifacts/:artifact_id" - }, - deleteSecretFromRepo: { - method: "DELETE", - params: { - name: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/actions/secrets/:name" - }, - downloadArtifact: { - method: "GET", - params: { - archive_format: { required: true, type: "string" }, - artifact_id: { required: true, type: "integer" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/actions/artifacts/:artifact_id/:archive_format" - }, - getArtifact: { - method: "GET", - params: { - artifact_id: { required: true, type: "integer" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/actions/artifacts/:artifact_id" - }, - getPublicKey: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/actions/secrets/public-key" - }, - getSecret: { - method: "GET", - params: { - name: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/actions/secrets/:name" - }, - getSelfHostedRunner: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" }, - runner_id: { required: true, type: "integer" } - }, - url: "/repos/:owner/:repo/actions/runners/:runner_id" - }, - getWorkflow: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" }, - workflow_id: { required: true, type: "integer" } - }, - url: "/repos/:owner/:repo/actions/workflows/:workflow_id" - }, - getWorkflowJob: { - method: "GET", - params: { - job_id: { required: true, type: "integer" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/actions/jobs/:job_id" - }, - getWorkflowRun: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" }, - run_id: { required: true, type: "integer" } - }, - url: "/repos/:owner/:repo/actions/runs/:run_id" - }, - listDownloadsForSelfHostedRunnerApplication: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/actions/runners/downloads" - }, - listJobsForWorkflowRun: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - repo: { required: true, type: "string" }, - run_id: { required: true, type: "integer" } - }, - url: "/repos/:owner/:repo/actions/runs/:run_id/jobs" - }, - listRepoWorkflowRuns: { - method: "GET", - params: { - actor: { type: "string" }, - branch: { type: "string" }, - event: { type: "string" }, - owner: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - repo: { required: true, type: "string" }, - status: { enum: ["completed", "status", "conclusion"], type: "string" } - }, - url: "/repos/:owner/:repo/actions/runs" - }, - listRepoWorkflows: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/actions/workflows" - }, - listSecretsForRepo: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/actions/secrets" - }, - listSelfHostedRunnersForRepo: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/actions/runners" - }, - listWorkflowJobLogs: { - method: "GET", - params: { - job_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/actions/jobs/:job_id/logs" - }, - listWorkflowRunArtifacts: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - repo: { required: true, type: "string" }, - run_id: { required: true, type: "integer" } - }, - url: "/repos/:owner/:repo/actions/runs/:run_id/artifacts" - }, - listWorkflowRunLogs: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - repo: { required: true, type: "string" }, - run_id: { required: true, type: "integer" } - }, - url: "/repos/:owner/:repo/actions/runs/:run_id/logs" - }, - listWorkflowRuns: { - method: "GET", - params: { - actor: { type: "string" }, - branch: { type: "string" }, - event: { type: "string" }, - owner: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - repo: { required: true, type: "string" }, - status: { enum: ["completed", "status", "conclusion"], type: "string" }, - workflow_id: { required: true, type: "integer" } - }, - url: "/repos/:owner/:repo/actions/workflows/:workflow_id/runs" - }, - reRunWorkflow: { - method: "POST", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" }, - run_id: { required: true, type: "integer" } - }, - url: "/repos/:owner/:repo/actions/runs/:run_id/rerun" - }, - removeSelfHostedRunner: { - method: "DELETE", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" }, - runner_id: { required: true, type: "integer" } - }, - url: "/repos/:owner/:repo/actions/runners/:runner_id" - } + cancelWorkflowRun: [ + "POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel" + ], + createOrUpdateSecretForRepo: [ + "PUT /repos/{owner}/{repo}/actions/secrets/{name}" + ], + createRegistrationToken: [ + "POST /repos/{owner}/{repo}/actions/runners/registration-token" + ], + createRemoveToken: [ + "POST /repos/{owner}/{repo}/actions/runners/remove-token" + ], + deleteArtifact: [ + "DELETE /repos/{owner}/{repo}/actions/artifacts/{artifact_id}" + ], + deleteSecretFromRepo: [ + "DELETE /repos/{owner}/{repo}/actions/secrets/{name}" + ], + downloadArtifact: [ + "GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}" + ], + getArtifact: ["GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}"], + getPublicKey: ["GET /repos/{owner}/{repo}/actions/secrets/public-key"], + getSecret: ["GET /repos/{owner}/{repo}/actions/secrets/{name}"], + getSelfHostedRunner: [ + "GET /repos/{owner}/{repo}/actions/runners/{runner_id}" + ], + getWorkflow: ["GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}"], + getWorkflowJob: ["GET /repos/{owner}/{repo}/actions/jobs/{job_id}"], + getWorkflowRun: ["GET /repos/{owner}/{repo}/actions/runs/{run_id}"], + listDownloadsForSelfHostedRunnerApplication: [ + "GET /repos/{owner}/{repo}/actions/runners/downloads" + ], + listJobsForWorkflowRun: [ + "GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs" + ], + listRepoWorkflowRuns: ["GET /repos/{owner}/{repo}/actions/runs"], + listRepoWorkflows: ["GET /repos/{owner}/{repo}/actions/workflows"], + listSecretsForRepo: ["GET /repos/{owner}/{repo}/actions/secrets"], + listSelfHostedRunnersForRepo: ["GET /repos/{owner}/{repo}/actions/runners"], + listWorkflowJobLogs: [ + "GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs" + ], + listWorkflowRunArtifacts: [ + "GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts" + ], + listWorkflowRunLogs: [ + "GET /repos/{owner}/{repo}/actions/runs/{run_id}/logs" + ], + listWorkflowRuns: [ + "GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs" + ], + reRunWorkflow: ["POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun"], + removeSelfHostedRunner: [ + "DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}" + ] }, 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" - } + checkStarringRepo: ["GET /user/starred/{owner}/{repo}"], + deleteRepoSubscription: ["DELETE /repos/{owner}/{repo}/subscription"], + deleteThreadSubscription: [ + "DELETE /notifications/threads/{thread_id}/subscription" + ], + getRepoSubscription: ["GET /repos/{owner}/{repo}/subscription"], + getThread: ["GET /notifications/threads/{thread_id}"], + getThreadSubscription: [ + "GET /notifications/threads/{thread_id}/subscription" + ], + listEventsForOrg: ["GET /users/{username}/events/orgs/{org}"], + listEventsForUser: ["GET /users/{username}/events"], + listFeeds: ["GET /feeds"], + listNotifications: ["GET /notifications"], + listNotificationsForRepo: ["GET /repos/{owner}/{repo}/notifications"], + listPublicEvents: ["GET /events"], + listPublicEventsForOrg: ["GET /orgs/{org}/events"], + listPublicEventsForRepoNetwork: ["GET /networks/{owner}/{repo}/events"], + listPublicEventsForUser: ["GET /users/{username}/events/public"], + listReceivedEventsForUser: ["GET /users/{username}/received_events"], + listReceivedPublicEventsForUser: [ + "GET /users/{username}/received_events/public" + ], + listRepoEvents: ["GET /repos/{owner}/{repo}/events"], + listReposStarredByAuthenticatedUser: ["GET /user/starred"], + listReposStarredByUser: ["GET /users/{username}/starred"], + listReposWatchedByUser: ["GET /users/{username}/subscriptions"], + listStargazersForRepo: ["GET /repos/{owner}/{repo}/stargazers"], + listWatchedReposForAuthenticatedUser: ["GET /user/subscriptions"], + listWatchersForRepo: ["GET /repos/{owner}/{repo}/subscribers"], + markAsRead: ["PUT /notifications"], + markNotificationsAsReadForRepo: ["PUT /repos/{owner}/{repo}/notifications"], + markThreadAsRead: ["PATCH /notifications/threads/{thread_id}"], + setRepoSubscription: ["PUT /repos/{owner}/{repo}/subscription"], + setThreadSubscription: [ + "PUT /notifications/threads/{thread_id}/subscription" + ], + starRepo: ["PUT /user/starred/{owner}/{repo}"], + unstarRepo: ["DELETE /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" } }, - url: "/marketplace_listing/accounts/:account_id" - }, - checkAccountIsAssociatedWithAnyStubbed: { - method: "GET", - params: { account_id: { required: true, type: "integer" } }, - url: "/marketplace_listing/stubbed/accounts/:account_id" - }, - checkAuthorization: { - deprecated: - "octokit.apps.checkAuthorization() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#check-an-authorization", - 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.apps.resetAuthorization() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#reset-an-authorization", - 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.apps.revokeAuthorizationForApplication() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#revoke-an-authorization-for-an-application", - 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.apps.revokeGrantForApplication() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#revoke-a-grant-for-an-application", - method: "DELETE", - params: { - access_token: { required: true, type: "string" }, - client_id: { required: true, type: "string" } - }, - url: "/applications/:client_id/grants/:access_token" - }, - revokeInstallationToken: { - headers: { accept: "application/vnd.github.gambit-preview+json" }, - method: "DELETE", - params: {}, - url: "/installation/token" - } + addRepoToInstallation: [ + "PUT /user/installations/{installation_id}/repositories/{repository_id}", + { mediaType: { previews: ["machine-man"] } } + ], + checkAccountIsAssociatedWithAny: [ + "GET /marketplace_listing/accounts/{account_id}" + ], + checkAccountIsAssociatedWithAnyStubbed: [ + "GET /marketplace_listing/stubbed/accounts/{account_id}" + ], + checkToken: [ + "POST /applications/{client_id}/token", + { mediaType: { previews: ["doctor-strange"] } } + ], + createContentAttachment: [ + "POST /content_references/{content_reference_id}/attachments", + { mediaType: { previews: ["corsair"] } } + ], + createFromManifest: [ + "POST /app-manifests/{code}/conversions", + { mediaType: { previews: ["fury"] } } + ], + createInstallationToken: [ + "POST /app/installations/{installation_id}/access_tokens", + { mediaType: { previews: ["machine-man"] } } + ], + deleteAuthorization: [ + "DELETE /applications/{client_id}/grant", + { mediaType: { previews: ["doctor-strange"] } } + ], + deleteInstallation: [ + "DELETE /app/installations/{installation_id}", + { mediaType: { previews: ["gambit", "machine-man"] } } + ], + deleteToken: [ + "DELETE /applications/{client_id}/token", + { mediaType: { previews: ["doctor-strange"] } } + ], + getAuthenticated: [ + "GET /app", + { mediaType: { previews: ["machine-man"] } } + ], + getBySlug: [ + "GET /apps/{app_slug}", + { mediaType: { previews: ["machine-man"] } } + ], + getInstallation: [ + "GET /app/installations/{installation_id}", + { mediaType: { previews: ["machine-man"] } } + ], + getOrgInstallation: [ + "GET /orgs/{org}/installation", + { mediaType: { previews: ["machine-man"] } } + ], + getRepoInstallation: [ + "GET /repos/{owner}/{repo}/installation", + { mediaType: { previews: ["machine-man"] } } + ], + getUserInstallation: [ + "GET /users/{username}/installation", + { mediaType: { previews: ["machine-man"] } } + ], + listAccountsUserOrOrgOnPlan: [ + "GET /marketplace_listing/plans/{plan_id}/accounts" + ], + listAccountsUserOrOrgOnPlanStubbed: [ + "GET /marketplace_listing/stubbed/plans/{plan_id}/accounts" + ], + listInstallationReposForAuthenticatedUser: [ + "GET /user/installations/{installation_id}/repositories", + { mediaType: { previews: ["machine-man"] } } + ], + listInstallations: [ + "GET /app/installations", + { mediaType: { previews: ["machine-man"] } } + ], + listInstallationsForAuthenticatedUser: [ + "GET /user/installations", + { mediaType: { previews: ["machine-man"] } } + ], + listMarketplacePurchasesForAuthenticatedUser: [ + "GET /user/marketplace_purchases" + ], + listMarketplacePurchasesForAuthenticatedUserStubbed: [ + "GET /user/marketplace_purchases/stubbed" + ], + listPlans: ["GET /marketplace_listing/plans"], + listPlansStubbed: ["GET /marketplace_listing/stubbed/plans"], + listRepos: [ + "GET /installation/repositories", + { mediaType: { previews: ["machine-man"] } } + ], + removeRepoFromInstallation: [ + "DELETE /user/installations/{installation_id}/repositories/{repository_id}", + { mediaType: { previews: ["machine-man"] } } + ], + resetToken: [ + "PATCH /applications/{client_id}/token", + { mediaType: { previews: ["doctor-strange"] } } + ], + revokeInstallationToken: [ + "DELETE /installation/token", + { mediaType: { previews: ["gambit"] } } + ] }, 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" - } + create: [ + "POST /repos/{owner}/{repo}/check-runs", + { mediaType: { previews: ["antiope"] } } + ], + createSuite: [ + "POST /repos/{owner}/{repo}/check-suites", + { mediaType: { previews: ["antiope"] } } + ], + get: [ + "GET /repos/{owner}/{repo}/check-runs/{check_run_id}", + { mediaType: { previews: ["antiope"] } } + ], + getSuite: [ + "GET /repos/{owner}/{repo}/check-suites/{check_suite_id}", + { mediaType: { previews: ["antiope"] } } + ], + listAnnotations: [ + "GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations", + { mediaType: { previews: ["antiope"] } } + ], + listForRef: [ + "GET /repos/{owner}/{repo}/commits/{ref}/check-runs", + { mediaType: { previews: ["antiope"] } } + ], + listForSuite: [ + "GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", + { mediaType: { previews: ["antiope"] } } + ], + listSuitesForRef: [ + "GET /repos/{owner}/{repo}/commits/{ref}/check-suites", + { mediaType: { previews: ["antiope"] } } + ], + rerequestSuite: [ + "POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest", + { mediaType: { previews: ["antiope"] } } + ], + setSuitesPreferences: [ + "PATCH /repos/{owner}/{repo}/check-suites/preferences", + { mediaType: { previews: ["antiope"] } } + ], + update: [ + "PATCH /repos/{owner}/{repo}/check-runs/{check_run_id}", + { mediaType: { previews: ["antiope"] } } + ] }, 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" - } + getConductCode: [ + "GET /codes_of_conduct/{key}", + { mediaType: { previews: ["scarlet-witch"] } } + ], + getForRepo: [ + "GET /repos/{owner}/{repo}/community/code_of_conduct", + { mediaType: { previews: ["scarlet-witch"] } } + ], + listConductCodes: [ + "GET /codes_of_conduct", + { mediaType: { previews: ["scarlet-witch"] } } + ] }, - emojis: { get: { method: "GET", params: {}, url: "/emojis" } }, + emojis: { get: ["GET /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" - } + checkIsStarred: ["GET /gists/{gist_id}/star"], + create: ["POST /gists"], + createComment: ["POST /gists/{gist_id}/comments"], + delete: ["DELETE /gists/{gist_id}"], + deleteComment: ["DELETE /gists/{gist_id}/comments/{comment_id}"], + fork: ["POST /gists/{gist_id}/forks"], + get: ["GET /gists/{gist_id}"], + getComment: ["GET /gists/{gist_id}/comments/{comment_id}"], + getRevision: ["GET /gists/{gist_id}/{sha}"], + list: ["GET /gists"], + listComments: ["GET /gists/{gist_id}/comments"], + listCommits: ["GET /gists/{gist_id}/commits"], + listForks: ["GET /gists/{gist_id}/forks"], + listPublic: ["GET /gists/public"], + listPublicForUser: ["GET /users/{username}/gists"], + listStarred: ["GET /gists/starred"], + star: ["PUT /gists/{gist_id}/star"], + unstar: ["DELETE /gists/{gist_id}/star"], + update: ["PATCH /gists/{gist_id}"], + updateComment: ["PATCH /gists/{gist_id}/comments/{comment_id}"] }, git: { - createBlob: { - 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" - } + createBlob: ["POST /repos/{owner}/{repo}/git/blobs"], + createCommit: ["POST /repos/{owner}/{repo}/git/commits"], + createRef: ["POST /repos/{owner}/{repo}/git/refs"], + createTag: ["POST /repos/{owner}/{repo}/git/tags"], + createTree: ["POST /repos/{owner}/{repo}/git/trees"], + deleteRef: ["DELETE /repos/{owner}/{repo}/git/refs/{ref}"], + getBlob: ["GET /repos/{owner}/{repo}/git/blobs/{file_sha}"], + getCommit: ["GET /repos/{owner}/{repo}/git/commits/{commit_sha}"], + getRef: ["GET /repos/{owner}/{repo}/git/ref/{ref}"], + getTag: ["GET /repos/{owner}/{repo}/git/tags/{tag_sha}"], + getTree: ["GET /repos/{owner}/{repo}/git/trees/{tree_sha}"], + listMatchingRefs: ["GET /repos/{owner}/{repo}/git/matching-refs/{ref}"], + updateRef: ["PATCH /repos/{owner}/{repo}/git/refs/{ref}"] }, gitignore: { - getTemplate: { - method: "GET", - params: { name: { required: true, type: "string" } }, - url: "/gitignore/templates/:name" - }, - listTemplates: { method: "GET", params: {}, url: "/gitignore/templates" } + getTemplate: ["GET /gitignore/templates/{name}"], + listTemplates: ["GET /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" - } + addOrUpdateRestrictionsForOrg: [ + "PUT /orgs/{org}/interaction-limits", + { mediaType: { previews: ["sombra"] } } + ], + addOrUpdateRestrictionsForRepo: [ + "PUT /repos/{owner}/{repo}/interaction-limits", + { mediaType: { previews: ["sombra"] } } + ], + getRestrictionsForOrg: [ + "GET /orgs/{org}/interaction-limits", + { mediaType: { previews: ["sombra"] } } + ], + getRestrictionsForRepo: [ + "GET /repos/{owner}/{repo}/interaction-limits", + { mediaType: { previews: ["sombra"] } } + ], + removeRestrictionsForOrg: [ + "DELETE /orgs/{org}/interaction-limits", + { mediaType: { previews: ["sombra"] } } + ], + removeRestrictionsForRepo: [ + "DELETE /repos/{owner}/{repo}/interaction-limits", + { mediaType: { previews: ["sombra"] } } + ] }, 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" }, - 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" - } + addAssignees: [ + "POST /repos/{owner}/{repo}/issues/{issue_number}/assignees" + ], + addLabels: ["POST /repos/{owner}/{repo}/issues/{issue_number}/labels"], + checkAssignee: ["GET /repos/{owner}/{repo}/assignees/{assignee}"], + create: ["POST /repos/{owner}/{repo}/issues"], + createComment: [ + "POST /repos/{owner}/{repo}/issues/{issue_number}/comments" + ], + createLabel: ["POST /repos/{owner}/{repo}/labels"], + createMilestone: ["POST /repos/{owner}/{repo}/milestones"], + deleteComment: [ + "DELETE /repos/{owner}/{repo}/issues/comments/{comment_id}" + ], + deleteLabel: ["DELETE /repos/{owner}/{repo}/labels/{name}"], + deleteMilestone: [ + "DELETE /repos/{owner}/{repo}/milestones/{milestone_number}" + ], + get: ["GET /repos/{owner}/{repo}/issues/{issue_number}"], + getComment: ["GET /repos/{owner}/{repo}/issues/comments/{comment_id}"], + getEvent: ["GET /repos/{owner}/{repo}/issues/events/{event_id}"], + getLabel: ["GET /repos/{owner}/{repo}/labels/{name}"], + getMilestone: ["GET /repos/{owner}/{repo}/milestones/{milestone_number}"], + list: ["GET /issues"], + listAssignees: ["GET /repos/{owner}/{repo}/assignees"], + listComments: ["GET /repos/{owner}/{repo}/issues/{issue_number}/comments"], + listCommentsForRepo: ["GET /repos/{owner}/{repo}/issues/comments"], + listEvents: ["GET /repos/{owner}/{repo}/issues/{issue_number}/events"], + listEventsForRepo: ["GET /repos/{owner}/{repo}/issues/events"], + listEventsForTimeline: [ + "GET /repos/{owner}/{repo}/issues/{issue_number}/timeline", + { mediaType: { previews: ["mockingbird"] } } + ], + listForAuthenticatedUser: ["GET /user/issues"], + listForOrg: ["GET /orgs/{org}/issues"], + listForRepo: ["GET /repos/{owner}/{repo}/issues"], + listLabelsForMilestone: [ + "GET /repos/{owner}/{repo}/milestones/{milestone_number}/labels" + ], + listLabelsForRepo: ["GET /repos/{owner}/{repo}/labels"], + listLabelsOnIssue: [ + "GET /repos/{owner}/{repo}/issues/{issue_number}/labels" + ], + listMilestonesForRepo: ["GET /repos/{owner}/{repo}/milestones"], + lock: ["PUT /repos/{owner}/{repo}/issues/{issue_number}/lock"], + removeAssignees: [ + "DELETE /repos/{owner}/{repo}/issues/{issue_number}/assignees" + ], + removeLabel: [ + "DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels/{name}" + ], + removeLabels: ["DELETE /repos/{owner}/{repo}/issues/{issue_number}/labels"], + replaceLabels: ["PUT /repos/{owner}/{repo}/issues/{issue_number}/labels"], + unlock: ["DELETE /repos/{owner}/{repo}/issues/{issue_number}/lock"], + update: ["PATCH /repos/{owner}/{repo}/issues/{issue_number}"], + updateComment: ["PATCH /repos/{owner}/{repo}/issues/comments/{comment_id}"], + updateLabel: ["PATCH /repos/{owner}/{repo}/labels/{name}"], + updateMilestone: [ + "PATCH /repos/{owner}/{repo}/milestones/{milestone_number}" + ] }, licenses: { - get: { - 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" } + get: ["GET /licenses/{license}"], + getForRepo: ["GET /repos/{owner}/{repo}/license"], + listCommonlyUsed: ["GET /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" - } + render: ["POST /markdown"], + renderRaw: [ + "POST /markdown/raw", + { headers: { "content-type": "text/plain; charset=utf-8" } } + ] }, - meta: { get: { method: "GET", params: {}, url: "/meta" } }, + meta: { get: ["GET /meta"] }, migrations: { - cancelImport: { - 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" - }, - downloadArchiveForOrg: { - 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" - }, - 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: { - deprecated: - "octokit.migrations.getArchiveForOrg() has been renamed to octokit.migrations.downloadArchiveForOrg() (2020-01-27)", - 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: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" }, - since: { type: "string" } - }, - url: "/repos/:owner/:repo/import/authors" - }, - getImportProgress: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/import" - }, - getLargeFiles: { - 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" - }, - listReposForOrg: { - headers: { accept: "application/vnd.github.wyandotte-preview+json" }, - method: "GET", - params: { - migration_id: { required: true, type: "integer" }, - org: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" } - }, - url: "/orgs/:org/migrations/:migration_id/repositories" - }, - listReposForUser: { - headers: { accept: "application/vnd.github.wyandotte-preview+json" }, - method: "GET", - params: { - migration_id: { required: true, type: "integer" }, - page: { type: "integer" }, - per_page: { type: "integer" } - }, - url: "/user/:migration_id/repositories" - }, - mapCommitAuthor: { - 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: { - 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: { - 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: { - 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" - } + cancelImport: ["DELETE /repos/{owner}/{repo}/import"], + deleteArchiveForAuthenticatedUser: [ + "DELETE /user/migrations/{migration_id}/archive", + { mediaType: { previews: ["wyandotte"] } } + ], + deleteArchiveForOrg: [ + "DELETE /orgs/{org}/migrations/{migration_id}/archive", + { mediaType: { previews: ["wyandotte"] } } + ], + downloadArchiveForOrg: [ + "GET /orgs/{org}/migrations/{migration_id}/archive", + { mediaType: { previews: ["wyandotte"] } } + ], + getArchiveForAuthenticatedUser: [ + "GET /user/migrations/{migration_id}/archive", + { mediaType: { previews: ["wyandotte"] } } + ], + getCommitAuthors: ["GET /repos/{owner}/{repo}/import/authors"], + getImportProgress: ["GET /repos/{owner}/{repo}/import"], + getLargeFiles: ["GET /repos/{owner}/{repo}/import/large_files"], + getStatusForAuthenticatedUser: [ + "GET /user/migrations/{migration_id}", + { mediaType: { previews: ["wyandotte"] } } + ], + getStatusForOrg: [ + "GET /orgs/{org}/migrations/{migration_id}", + { mediaType: { previews: ["wyandotte"] } } + ], + listForAuthenticatedUser: [ + "GET /user/migrations", + { mediaType: { previews: ["wyandotte"] } } + ], + listForOrg: [ + "GET /orgs/{org}/migrations", + { mediaType: { previews: ["wyandotte"] } } + ], + listReposForOrg: [ + "GET /orgs/{org}/migrations/{migration_id}/repositories", + { mediaType: { previews: ["wyandotte"] } } + ], + listReposForUser: [ + "GET /user/{migration_id}/repositories", + { mediaType: { previews: ["wyandotte"] } } + ], + mapCommitAuthor: ["PATCH /repos/{owner}/{repo}/import/authors/{author_id}"], + setLfsPreference: ["PATCH /repos/{owner}/{repo}/import/lfs"], + startForAuthenticatedUser: ["POST /user/migrations"], + startForOrg: ["POST /orgs/{org}/migrations"], + startImport: ["PUT /repos/{owner}/{repo}/import"], + unlockRepoForAuthenticatedUser: [ + "DELETE /user/migrations/{migration_id}/repos/{repo_name}/lock", + { mediaType: { previews: ["wyandotte"] } } + ], + unlockRepoForOrg: [ + "DELETE /orgs/{org}/migrations/{migration_id}/repos/{repo_name}/lock", + { mediaType: { previews: ["wyandotte"] } } + ], + updateImport: ["PATCH /repos/{owner}/{repo}/import"] }, 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: "integer" } - }, - 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: true, type: "string" }, - username: { required: true, type: "string" } - }, - url: "/orgs/:org/memberships/:username" - }, - removeOutsideCollaborator: { - method: "DELETE", - params: { - org: { required: true, type: "string" }, - username: { required: true, type: "string" } - }, - url: "/orgs/:org/outside_collaborators/:username" - }, - unblockUser: { - method: "DELETE", - params: { - org: { required: true, type: "string" }, - username: { required: true, type: "string" } - }, - url: "/orgs/:org/blocks/:username" - }, - update: { - method: "PATCH", - params: { - billing_email: { type: "string" }, - company: { type: "string" }, - default_repository_permission: { - enum: ["read", "write", "admin", "none"], - type: "string" - }, - description: { type: "string" }, - email: { type: "string" }, - has_organization_projects: { type: "boolean" }, - has_repository_projects: { type: "boolean" }, - location: { type: "string" }, - members_allowed_repository_creation_type: { - enum: ["all", "private", "none"], - type: "string" - }, - members_can_create_internal_repositories: { type: "boolean" }, - members_can_create_private_repositories: { type: "boolean" }, - members_can_create_public_repositories: { type: "boolean" }, - members_can_create_repositories: { type: "boolean" }, - name: { type: "string" }, - org: { required: true, type: "string" } - }, - url: "/orgs/:org" - }, - updateHook: { - method: "PATCH", - params: { - active: { type: "boolean" }, - config: { type: "object" }, - "config.content_type": { type: "string" }, - "config.insecure_ssl": { type: "string" }, - "config.secret": { type: "string" }, - "config.url": { required: true, type: "string" }, - events: { type: "string[]" }, - hook_id: { required: true, type: "integer" }, - org: { required: true, type: "string" } - }, - url: "/orgs/:org/hooks/:hook_id" - }, - updateMembership: { - method: "PATCH", - params: { - org: { required: true, type: "string" }, - state: { enum: ["active"], required: true, type: "string" } - }, - url: "/user/memberships/orgs/:org" - } + addOrUpdateMembership: ["PUT /orgs/{org}/memberships/{username}"], + blockUser: ["PUT /orgs/{org}/blocks/{username}"], + checkBlockedUser: ["GET /orgs/{org}/blocks/{username}"], + checkMembership: ["GET /orgs/{org}/members/{username}"], + checkPublicMembership: ["GET /orgs/{org}/public_members/{username}"], + concealMembership: ["DELETE /orgs/{org}/public_members/{username}"], + convertMemberToOutsideCollaborator: [ + "PUT /orgs/{org}/outside_collaborators/{username}" + ], + createHook: ["POST /orgs/{org}/hooks"], + createInvitation: ["POST /orgs/{org}/invitations"], + deleteHook: ["DELETE /orgs/{org}/hooks/{hook_id}"], + get: ["GET /orgs/{org}"], + getHook: ["GET /orgs/{org}/hooks/{hook_id}"], + getMembership: ["GET /orgs/{org}/memberships/{username}"], + getMembershipForAuthenticatedUser: ["GET /user/memberships/orgs/{org}"], + list: ["GET /organizations"], + listBlockedUsers: ["GET /orgs/{org}/blocks"], + listForAuthenticatedUser: ["GET /user/orgs"], + listForUser: ["GET /users/{username}/orgs"], + listHooks: ["GET /orgs/{org}/hooks"], + listInstallations: [ + "GET /orgs/{org}/installations", + { mediaType: { previews: ["machine-man"] } } + ], + listInvitationTeams: ["GET /orgs/{org}/invitations/{invitation_id}/teams"], + listMembers: ["GET /orgs/{org}/members"], + listMemberships: ["GET /user/memberships/orgs"], + listOutsideCollaborators: ["GET /orgs/{org}/outside_collaborators"], + listPendingInvitations: ["GET /orgs/{org}/invitations"], + listPublicMembers: ["GET /orgs/{org}/public_members"], + pingHook: ["POST /orgs/{org}/hooks/{hook_id}/pings"], + publicizeMembership: ["PUT /orgs/{org}/public_members/{username}"], + removeMember: ["DELETE /orgs/{org}/members/{username}"], + removeMembership: ["DELETE /orgs/{org}/memberships/{username}"], + removeOutsideCollaborator: [ + "DELETE /orgs/{org}/outside_collaborators/{username}" + ], + unblockUser: ["DELETE /orgs/{org}/blocks/{username}"], + update: ["PATCH /orgs/{org}"], + updateHook: ["PATCH /orgs/{org}/hooks/{hook_id}"], + updateMembership: ["PATCH /user/memberships/orgs/{org}"] }, projects: { - addCollaborator: { - headers: { accept: "application/vnd.github.inertia-preview+json" }, - method: "PUT", - params: { - permission: { enum: ["read", "write", "admin"], type: "string" }, - project_id: { required: true, type: "integer" }, - username: { required: true, type: "string" } - }, - url: "/projects/:project_id/collaborators/:username" - }, - createCard: { - headers: { accept: "application/vnd.github.inertia-preview+json" }, - method: "POST", - params: { - column_id: { required: true, type: "integer" }, - content_id: { type: "integer" }, - content_type: { type: "string" }, - note: { type: "string" } - }, - url: "/projects/columns/:column_id/cards" - }, - createColumn: { - headers: { accept: "application/vnd.github.inertia-preview+json" }, - method: "POST", - params: { - name: { required: true, type: "string" }, - project_id: { required: true, type: "integer" } - }, - url: "/projects/:project_id/columns" - }, - createForAuthenticatedUser: { - headers: { accept: "application/vnd.github.inertia-preview+json" }, - method: "POST", - params: { - body: { type: "string" }, - name: { required: true, type: "string" } - }, - url: "/user/projects" - }, - createForOrg: { - headers: { accept: "application/vnd.github.inertia-preview+json" }, - method: "POST", - params: { - body: { type: "string" }, - name: { required: true, type: "string" }, - org: { required: true, type: "string" } - }, - url: "/orgs/:org/projects" - }, - createForRepo: { - headers: { accept: "application/vnd.github.inertia-preview+json" }, - method: "POST", - params: { - body: { type: "string" }, - name: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/projects" - }, - delete: { - headers: { accept: "application/vnd.github.inertia-preview+json" }, - method: "DELETE", - params: { project_id: { required: true, type: "integer" } }, - url: "/projects/:project_id" - }, - deleteCard: { - headers: { accept: "application/vnd.github.inertia-preview+json" }, - method: "DELETE", - params: { card_id: { required: true, type: "integer" } }, - url: "/projects/columns/cards/:card_id" - }, - deleteColumn: { - headers: { accept: "application/vnd.github.inertia-preview+json" }, - method: "DELETE", - params: { column_id: { required: true, type: "integer" } }, - url: "/projects/columns/:column_id" - }, - get: { - headers: { accept: "application/vnd.github.inertia-preview+json" }, - method: "GET", - params: { project_id: { required: true, type: "integer" } }, - url: "/projects/:project_id" - }, - getCard: { - headers: { accept: "application/vnd.github.inertia-preview+json" }, - method: "GET", - params: { card_id: { required: true, type: "integer" } }, - url: "/projects/columns/cards/:card_id" - }, - getColumn: { - headers: { accept: "application/vnd.github.inertia-preview+json" }, - method: "GET", - params: { column_id: { required: true, type: "integer" } }, - url: "/projects/columns/:column_id" - }, - listCards: { - headers: { accept: "application/vnd.github.inertia-preview+json" }, - method: "GET", - params: { - archived_state: { - enum: ["all", "archived", "not_archived"], - type: "string" - }, - column_id: { required: true, type: "integer" }, - page: { type: "integer" }, - per_page: { type: "integer" } - }, - url: "/projects/columns/:column_id/cards" - }, - listCollaborators: { - headers: { accept: "application/vnd.github.inertia-preview+json" }, - method: "GET", - params: { - affiliation: { enum: ["outside", "direct", "all"], type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - project_id: { required: true, type: "integer" } - }, - url: "/projects/:project_id/collaborators" - }, - listColumns: { - headers: { accept: "application/vnd.github.inertia-preview+json" }, - method: "GET", - params: { - page: { type: "integer" }, - per_page: { type: "integer" }, - project_id: { required: true, type: "integer" } - }, - url: "/projects/:project_id/columns" - }, - listForOrg: { - headers: { accept: "application/vnd.github.inertia-preview+json" }, - method: "GET", - params: { - org: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - state: { enum: ["open", "closed", "all"], type: "string" } - }, - url: "/orgs/:org/projects" - }, - listForRepo: { - headers: { accept: "application/vnd.github.inertia-preview+json" }, - method: "GET", - params: { - owner: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - repo: { required: true, type: "string" }, - state: { enum: ["open", "closed", "all"], type: "string" } - }, - url: "/repos/:owner/:repo/projects" - }, - listForUser: { - headers: { accept: "application/vnd.github.inertia-preview+json" }, - method: "GET", - params: { - page: { type: "integer" }, - per_page: { type: "integer" }, - state: { enum: ["open", "closed", "all"], type: "string" }, - username: { required: true, type: "string" } - }, - url: "/users/:username/projects" - }, - moveCard: { - headers: { accept: "application/vnd.github.inertia-preview+json" }, - method: "POST", - params: { - card_id: { required: true, type: "integer" }, - column_id: { type: "integer" }, - position: { - required: true, - type: "string", - validation: "^(top|bottom|after:\\d+)$" - } - }, - url: "/projects/columns/cards/:card_id/moves" - }, - moveColumn: { - headers: { accept: "application/vnd.github.inertia-preview+json" }, - method: "POST", - params: { - column_id: { required: true, type: "integer" }, - position: { - required: true, - type: "string", - validation: "^(first|last|after:\\d+)$" - } - }, - url: "/projects/columns/:column_id/moves" - }, - removeCollaborator: { - headers: { accept: "application/vnd.github.inertia-preview+json" }, - method: "DELETE", - params: { - project_id: { required: true, type: "integer" }, - username: { required: true, type: "string" } - }, - url: "/projects/:project_id/collaborators/:username" - }, - reviewUserPermissionLevel: { - headers: { accept: "application/vnd.github.inertia-preview+json" }, - method: "GET", - params: { - project_id: { required: true, type: "integer" }, - username: { required: true, type: "string" } - }, - url: "/projects/:project_id/collaborators/:username/permission" - }, - update: { - headers: { accept: "application/vnd.github.inertia-preview+json" }, - method: "PATCH", - params: { - body: { type: "string" }, - name: { type: "string" }, - organization_permission: { type: "string" }, - private: { type: "boolean" }, - project_id: { required: true, type: "integer" }, - state: { enum: ["open", "closed"], type: "string" } - }, - url: "/projects/:project_id" - }, - updateCard: { - headers: { accept: "application/vnd.github.inertia-preview+json" }, - method: "PATCH", - params: { - archived: { type: "boolean" }, - card_id: { required: true, type: "integer" }, - note: { type: "string" } - }, - url: "/projects/columns/cards/:card_id" - }, - updateColumn: { - headers: { accept: "application/vnd.github.inertia-preview+json" }, - method: "PATCH", - params: { - column_id: { required: true, type: "integer" }, - name: { required: true, type: "string" } - }, - url: "/projects/columns/:column_id" - } + addCollaborator: [ + "PUT /projects/{project_id}/collaborators/{username}", + { mediaType: { previews: ["inertia"] } } + ], + createCard: [ + "POST /projects/columns/{column_id}/cards", + { mediaType: { previews: ["inertia"] } } + ], + createColumn: [ + "POST /projects/{project_id}/columns", + { mediaType: { previews: ["inertia"] } } + ], + createForAuthenticatedUser: [ + "POST /user/projects", + { mediaType: { previews: ["inertia"] } } + ], + createForOrg: [ + "POST /orgs/{org}/projects", + { mediaType: { previews: ["inertia"] } } + ], + createForRepo: [ + "POST /repos/{owner}/{repo}/projects", + { mediaType: { previews: ["inertia"] } } + ], + delete: [ + "DELETE /projects/{project_id}", + { mediaType: { previews: ["inertia"] } } + ], + deleteCard: [ + "DELETE /projects/columns/cards/{card_id}", + { mediaType: { previews: ["inertia"] } } + ], + deleteColumn: [ + "DELETE /projects/columns/{column_id}", + { mediaType: { previews: ["inertia"] } } + ], + get: [ + "GET /projects/{project_id}", + { mediaType: { previews: ["inertia"] } } + ], + getCard: [ + "GET /projects/columns/cards/{card_id}", + { mediaType: { previews: ["inertia"] } } + ], + getColumn: [ + "GET /projects/columns/{column_id}", + { mediaType: { previews: ["inertia"] } } + ], + listCards: [ + "GET /projects/columns/{column_id}/cards", + { mediaType: { previews: ["inertia"] } } + ], + listCollaborators: [ + "GET /projects/{project_id}/collaborators", + { mediaType: { previews: ["inertia"] } } + ], + listColumns: [ + "GET /projects/{project_id}/columns", + { mediaType: { previews: ["inertia"] } } + ], + listForOrg: [ + "GET /orgs/{org}/projects", + { mediaType: { previews: ["inertia"] } } + ], + listForRepo: [ + "GET /repos/{owner}/{repo}/projects", + { mediaType: { previews: ["inertia"] } } + ], + listForUser: [ + "GET /users/{username}/projects", + { mediaType: { previews: ["inertia"] } } + ], + moveCard: [ + "POST /projects/columns/cards/{card_id}/moves", + { mediaType: { previews: ["inertia"] } } + ], + moveColumn: [ + "POST /projects/columns/{column_id}/moves", + { mediaType: { previews: ["inertia"] } } + ], + removeCollaborator: [ + "DELETE /projects/{project_id}/collaborators/{username}", + { mediaType: { previews: ["inertia"] } } + ], + reviewUserPermissionLevel: [ + "GET /projects/{project_id}/collaborators/{username}/permission", + { mediaType: { previews: ["inertia"] } } + ], + update: [ + "PATCH /projects/{project_id}", + { mediaType: { previews: ["inertia"] } } + ], + updateCard: [ + "PATCH /projects/columns/cards/{card_id}", + { mediaType: { previews: ["inertia"] } } + ], + updateColumn: [ + "PATCH /projects/columns/{column_id}", + { mediaType: { previews: ["inertia"] } } + ] }, pulls: { - checkIfMerged: { - method: "GET", - params: { - number: { alias: "pull_number", deprecated: true, type: "integer" }, - owner: { required: true, type: "string" }, - pull_number: { required: true, type: "integer" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/pulls/:pull_number/merge" - }, - create: { - method: "POST", - params: { - base: { required: true, type: "string" }, - body: { type: "string" }, - draft: { type: "boolean" }, - head: { required: true, type: "string" }, - maintainer_can_modify: { type: "boolean" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" }, - title: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/pulls" - }, - createComment: { - method: "POST", - params: { - body: { required: true, type: "string" }, - commit_id: { required: true, type: "string" }, - in_reply_to: { - deprecated: true, - description: - "The comment ID to reply to. **Note**: This must be the ID of a top-level comment, not a reply to that comment. Replies to replies are not supported.", - type: "integer" - }, - line: { type: "integer" }, - number: { alias: "pull_number", deprecated: true, type: "integer" }, - owner: { required: true, type: "string" }, - path: { required: true, type: "string" }, - position: { type: "integer" }, - pull_number: { required: true, type: "integer" }, - repo: { required: true, type: "string" }, - side: { enum: ["LEFT", "RIGHT"], type: "string" }, - start_line: { type: "integer" }, - start_side: { enum: ["LEFT", "RIGHT", "side"], type: "string" } - }, - url: "/repos/:owner/:repo/pulls/:pull_number/comments" - }, - createCommentReply: { - deprecated: - "octokit.pulls.createCommentReply() has been renamed to octokit.pulls.createComment() (2019-09-09)", - method: "POST", - params: { - body: { required: true, type: "string" }, - commit_id: { required: true, type: "string" }, - in_reply_to: { - deprecated: true, - description: - "The comment ID to reply to. **Note**: This must be the ID of a top-level comment, not a reply to that comment. Replies to replies are not supported.", - type: "integer" - }, - line: { type: "integer" }, - number: { alias: "pull_number", deprecated: true, type: "integer" }, - owner: { required: true, type: "string" }, - path: { required: true, type: "string" }, - position: { type: "integer" }, - pull_number: { required: true, type: "integer" }, - repo: { required: true, type: "string" }, - side: { enum: ["LEFT", "RIGHT"], type: "string" }, - start_line: { type: "integer" }, - start_side: { enum: ["LEFT", "RIGHT", "side"], type: "string" } - }, - url: "/repos/:owner/:repo/pulls/:pull_number/comments" - }, - createFromIssue: { - deprecated: - "octokit.pulls.createFromIssue() is deprecated, see https://developer.github.com/v3/pulls/#create-a-pull-request", - method: "POST", - params: { - base: { required: true, type: "string" }, - draft: { type: "boolean" }, - head: { required: true, type: "string" }, - issue: { required: true, type: "integer" }, - maintainer_can_modify: { type: "boolean" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/pulls" - }, - createReview: { - method: "POST", - params: { - body: { type: "string" }, - comments: { type: "object[]" }, - "comments[].body": { required: true, type: "string" }, - "comments[].path": { required: true, type: "string" }, - "comments[].position": { required: true, type: "integer" }, - commit_id: { type: "string" }, - event: { - enum: ["APPROVE", "REQUEST_CHANGES", "COMMENT"], - type: "string" - }, - number: { alias: "pull_number", deprecated: true, type: "integer" }, - owner: { required: true, type: "string" }, - pull_number: { required: true, type: "integer" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/pulls/:pull_number/reviews" - }, - createReviewCommentReply: { - method: "POST", - params: { - body: { required: true, type: "string" }, - comment_id: { required: true, type: "integer" }, - owner: { required: true, type: "string" }, - pull_number: { required: true, type: "integer" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/pulls/:pull_number/comments/:comment_id/replies" - }, - createReviewRequest: { - method: "POST", - params: { - number: { alias: "pull_number", deprecated: true, type: "integer" }, - owner: { required: true, type: "string" }, - pull_number: { required: true, type: "integer" }, - repo: { required: true, type: "string" }, - reviewers: { type: "string[]" }, - team_reviewers: { type: "string[]" } - }, - url: "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers" - }, - deleteComment: { - method: "DELETE", - params: { - comment_id: { required: true, type: "integer" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/pulls/comments/:comment_id" - }, - deletePendingReview: { - method: "DELETE", - params: { - number: { alias: "pull_number", deprecated: true, type: "integer" }, - owner: { required: true, type: "string" }, - pull_number: { required: true, type: "integer" }, - repo: { required: true, type: "string" }, - review_id: { required: true, type: "integer" } - }, - url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id" - }, - deleteReviewRequest: { - method: "DELETE", - params: { - number: { alias: "pull_number", deprecated: true, type: "integer" }, - owner: { required: true, type: "string" }, - pull_number: { required: true, type: "integer" }, - repo: { required: true, type: "string" }, - reviewers: { type: "string[]" }, - team_reviewers: { type: "string[]" } - }, - url: "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers" - }, - dismissReview: { - method: "PUT", - params: { - message: { required: true, type: "string" }, - number: { alias: "pull_number", deprecated: true, type: "integer" }, - owner: { required: true, type: "string" }, - pull_number: { required: true, type: "integer" }, - repo: { required: true, type: "string" }, - review_id: { required: true, type: "integer" } - }, - url: - "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/dismissals" - }, - get: { - method: "GET", - params: { - number: { alias: "pull_number", deprecated: true, type: "integer" }, - owner: { required: true, type: "string" }, - pull_number: { required: true, type: "integer" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/pulls/:pull_number" - }, - getComment: { - method: "GET", - params: { - comment_id: { required: true, type: "integer" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/pulls/comments/:comment_id" - }, - getCommentsForReview: { - method: "GET", - params: { - number: { alias: "pull_number", deprecated: true, type: "integer" }, - owner: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - pull_number: { required: true, type: "integer" }, - repo: { required: true, type: "string" }, - review_id: { required: true, type: "integer" } - }, - url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/comments" - }, - getReview: { - method: "GET", - params: { - number: { alias: "pull_number", deprecated: true, type: "integer" }, - owner: { required: true, type: "string" }, - pull_number: { required: true, type: "integer" }, - repo: { required: true, type: "string" }, - review_id: { required: true, type: "integer" } - }, - url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id" - }, - list: { - method: "GET", - params: { - base: { type: "string" }, - direction: { enum: ["asc", "desc"], type: "string" }, - head: { type: "string" }, - owner: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - repo: { required: true, type: "string" }, - sort: { - enum: ["created", "updated", "popularity", "long-running"], - type: "string" - }, - state: { enum: ["open", "closed", "all"], type: "string" } - }, - url: "/repos/:owner/:repo/pulls" - }, - listComments: { - method: "GET", - params: { - direction: { enum: ["asc", "desc"], type: "string" }, - number: { alias: "pull_number", deprecated: true, type: "integer" }, - owner: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - pull_number: { required: true, type: "integer" }, - repo: { required: true, type: "string" }, - since: { type: "string" }, - sort: { enum: ["created", "updated"], type: "string" } - }, - url: "/repos/:owner/:repo/pulls/:pull_number/comments" - }, - listCommentsForRepo: { - 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" }, - since: { type: "string" }, - sort: { enum: ["created", "updated"], type: "string" } - }, - url: "/repos/:owner/:repo/pulls/comments" - }, - listCommits: { - method: "GET", - params: { - number: { alias: "pull_number", deprecated: true, type: "integer" }, - owner: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - pull_number: { required: true, type: "integer" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/pulls/:pull_number/commits" - }, - listFiles: { - method: "GET", - params: { - number: { alias: "pull_number", deprecated: true, type: "integer" }, - owner: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - pull_number: { required: true, type: "integer" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/pulls/:pull_number/files" - }, - listReviewRequests: { - method: "GET", - params: { - number: { alias: "pull_number", deprecated: true, type: "integer" }, - owner: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - pull_number: { required: true, type: "integer" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/pulls/:pull_number/requested_reviewers" - }, - listReviews: { - method: "GET", - params: { - number: { alias: "pull_number", deprecated: true, type: "integer" }, - owner: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - pull_number: { required: true, type: "integer" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/pulls/:pull_number/reviews" - }, - merge: { - method: "PUT", - params: { - commit_message: { type: "string" }, - commit_title: { type: "string" }, - merge_method: { enum: ["merge", "squash", "rebase"], type: "string" }, - number: { alias: "pull_number", deprecated: true, type: "integer" }, - owner: { required: true, type: "string" }, - pull_number: { required: true, type: "integer" }, - repo: { required: true, type: "string" }, - sha: { type: "string" } - }, - url: "/repos/:owner/:repo/pulls/:pull_number/merge" - }, - submitReview: { - method: "POST", - params: { - body: { type: "string" }, - event: { - enum: ["APPROVE", "REQUEST_CHANGES", "COMMENT"], - required: true, - type: "string" - }, - number: { alias: "pull_number", deprecated: true, type: "integer" }, - owner: { required: true, type: "string" }, - pull_number: { required: true, type: "integer" }, - repo: { required: true, type: "string" }, - review_id: { required: true, type: "integer" } - }, - url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id/events" - }, - update: { - method: "PATCH", - params: { - base: { type: "string" }, - body: { type: "string" }, - maintainer_can_modify: { type: "boolean" }, - number: { alias: "pull_number", deprecated: true, type: "integer" }, - owner: { required: true, type: "string" }, - pull_number: { required: true, type: "integer" }, - repo: { required: true, type: "string" }, - state: { enum: ["open", "closed"], type: "string" }, - title: { type: "string" } - }, - url: "/repos/:owner/:repo/pulls/:pull_number" - }, - updateBranch: { - headers: { accept: "application/vnd.github.lydian-preview+json" }, - method: "PUT", - params: { - expected_head_sha: { type: "string" }, - owner: { required: true, type: "string" }, - pull_number: { required: true, type: "integer" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/pulls/:pull_number/update-branch" - }, - 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/pulls/comments/:comment_id" - }, - updateReview: { - method: "PUT", - params: { - body: { required: true, type: "string" }, - number: { alias: "pull_number", deprecated: true, type: "integer" }, - owner: { required: true, type: "string" }, - pull_number: { required: true, type: "integer" }, - repo: { required: true, type: "string" }, - review_id: { required: true, type: "integer" } - }, - url: "/repos/:owner/:repo/pulls/:pull_number/reviews/:review_id" - } + checkIfMerged: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/merge"], + create: ["POST /repos/{owner}/{repo}/pulls"], + createComment: ["POST /repos/{owner}/{repo}/pulls/{pull_number}/comments"], + createReview: ["POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews"], + createReviewCommentReply: [ + "POST /repos/{owner}/{repo}/pulls/{pull_number}/comments/{comment_id}/replies" + ], + createReviewRequest: [ + "POST /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers" + ], + deleteComment: ["DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}"], + deletePendingReview: [ + "DELETE /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}" + ], + deleteReviewRequest: [ + "DELETE /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers" + ], + dismissReview: [ + "PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals" + ], + get: ["GET /repos/{owner}/{repo}/pulls/{pull_number}"], + getComment: ["GET /repos/{owner}/{repo}/pulls/comments/{comment_id}"], + getCommentsForReview: [ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments" + ], + getReview: [ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}" + ], + list: ["GET /repos/{owner}/{repo}/pulls"], + listComments: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/comments"], + listCommentsForRepo: ["GET /repos/{owner}/{repo}/pulls/comments"], + listCommits: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/commits"], + listFiles: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/files"], + listReviewRequests: [ + "GET /repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers" + ], + listReviews: ["GET /repos/{owner}/{repo}/pulls/{pull_number}/reviews"], + merge: ["PUT /repos/{owner}/{repo}/pulls/{pull_number}/merge"], + submitReview: [ + "POST /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events" + ], + update: ["PATCH /repos/{owner}/{repo}/pulls/{pull_number}"], + updateBranch: [ + "PUT /repos/{owner}/{repo}/pulls/{pull_number}/update-branch", + { mediaType: { previews: ["lydian"] } } + ], + updateComment: ["PATCH /repos/{owner}/{repo}/pulls/comments/{comment_id}"], + updateReview: [ + "PUT /repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}" + ] }, - rateLimit: { get: { method: "GET", params: {}, url: "/rate_limit" } }, + rateLimit: { get: ["GET /rate_limit"] }, reactions: { - createForCommitComment: { - headers: { accept: "application/vnd.github.squirrel-girl-preview+json" }, - method: "POST", - params: { - comment_id: { required: true, type: "integer" }, - content: { - enum: [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - required: true, - type: "string" - }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/comments/:comment_id/reactions" - }, - createForIssue: { - headers: { accept: "application/vnd.github.squirrel-girl-preview+json" }, - method: "POST", - params: { - content: { - enum: [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - 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/reactions" - }, - createForIssueComment: { - headers: { accept: "application/vnd.github.squirrel-girl-preview+json" }, - method: "POST", - params: { - comment_id: { required: true, type: "integer" }, - content: { - enum: [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - required: true, - type: "string" - }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/issues/comments/:comment_id/reactions" - }, - createForPullRequestReviewComment: { - headers: { accept: "application/vnd.github.squirrel-girl-preview+json" }, - method: "POST", - params: { - comment_id: { required: true, type: "integer" }, - content: { - enum: [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - required: true, - type: "string" - }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/pulls/comments/:comment_id/reactions" - }, - createForTeamDiscussion: { - deprecated: - "octokit.reactions.createForTeamDiscussion() has been renamed to octokit.reactions.createForTeamDiscussionLegacy() (2020-01-16)", - headers: { accept: "application/vnd.github.squirrel-girl-preview+json" }, - method: "POST", - params: { - content: { - enum: [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - required: true, - type: "string" - }, - discussion_number: { required: true, type: "integer" }, - team_id: { required: true, type: "integer" } - }, - url: "/teams/:team_id/discussions/:discussion_number/reactions" - }, - createForTeamDiscussionComment: { - deprecated: - "octokit.reactions.createForTeamDiscussionComment() has been renamed to octokit.reactions.createForTeamDiscussionCommentLegacy() (2020-01-16)", - headers: { accept: "application/vnd.github.squirrel-girl-preview+json" }, - method: "POST", - params: { - comment_number: { required: true, type: "integer" }, - content: { - enum: [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - required: true, - type: "string" - }, - discussion_number: { required: true, type: "integer" }, - team_id: { required: true, type: "integer" } - }, - url: - "/teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions" - }, - createForTeamDiscussionCommentInOrg: { - headers: { accept: "application/vnd.github.squirrel-girl-preview+json" }, - method: "POST", - params: { - comment_number: { required: true, type: "integer" }, - content: { - enum: [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - required: true, - type: "string" - }, - discussion_number: { required: true, type: "integer" }, - org: { required: true, type: "string" }, - team_slug: { required: true, type: "string" } - }, - url: - "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions" - }, - createForTeamDiscussionCommentLegacy: { - deprecated: - "octokit.reactions.createForTeamDiscussionCommentLegacy() is deprecated, see https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-comment-legacy", - headers: { accept: "application/vnd.github.squirrel-girl-preview+json" }, - method: "POST", - params: { - comment_number: { required: true, type: "integer" }, - content: { - enum: [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - required: true, - type: "string" - }, - discussion_number: { required: true, type: "integer" }, - team_id: { required: true, type: "integer" } - }, - url: - "/teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions" - }, - createForTeamDiscussionInOrg: { - headers: { accept: "application/vnd.github.squirrel-girl-preview+json" }, - method: "POST", - params: { - content: { - enum: [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - required: true, - type: "string" - }, - discussion_number: { required: true, type: "integer" }, - org: { required: true, type: "string" }, - team_slug: { required: true, type: "string" } - }, - url: - "/orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions" - }, - createForTeamDiscussionLegacy: { - deprecated: - "octokit.reactions.createForTeamDiscussionLegacy() is deprecated, see https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-legacy", - headers: { accept: "application/vnd.github.squirrel-girl-preview+json" }, - method: "POST", - params: { - content: { - enum: [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - required: true, - type: "string" - }, - discussion_number: { required: true, type: "integer" }, - team_id: { required: true, type: "integer" } - }, - url: "/teams/:team_id/discussions/:discussion_number/reactions" - }, - delete: { - headers: { accept: "application/vnd.github.squirrel-girl-preview+json" }, - method: "DELETE", - params: { reaction_id: { required: true, type: "integer" } }, - url: "/reactions/:reaction_id" - }, - listForCommitComment: { - headers: { accept: "application/vnd.github.squirrel-girl-preview+json" }, - method: "GET", - params: { - comment_id: { required: true, type: "integer" }, - content: { - enum: [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - type: "string" - }, - owner: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/comments/:comment_id/reactions" - }, - listForIssue: { - headers: { accept: "application/vnd.github.squirrel-girl-preview+json" }, - method: "GET", - params: { - content: { - enum: [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - type: "string" - }, - 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/reactions" - }, - listForIssueComment: { - headers: { accept: "application/vnd.github.squirrel-girl-preview+json" }, - method: "GET", - params: { - comment_id: { required: true, type: "integer" }, - content: { - enum: [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - type: "string" - }, - 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/reactions" - }, - listForPullRequestReviewComment: { - headers: { accept: "application/vnd.github.squirrel-girl-preview+json" }, - method: "GET", - params: { - comment_id: { required: true, type: "integer" }, - content: { - enum: [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - type: "string" - }, - owner: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/pulls/comments/:comment_id/reactions" - }, - listForTeamDiscussion: { - deprecated: - "octokit.reactions.listForTeamDiscussion() has been renamed to octokit.reactions.listForTeamDiscussionLegacy() (2020-01-16)", - headers: { accept: "application/vnd.github.squirrel-girl-preview+json" }, - method: "GET", - params: { - content: { - enum: [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - type: "string" - }, - discussion_number: { required: true, type: "integer" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - team_id: { required: true, type: "integer" } - }, - url: "/teams/:team_id/discussions/:discussion_number/reactions" - }, - listForTeamDiscussionComment: { - deprecated: - "octokit.reactions.listForTeamDiscussionComment() has been renamed to octokit.reactions.listForTeamDiscussionCommentLegacy() (2020-01-16)", - headers: { accept: "application/vnd.github.squirrel-girl-preview+json" }, - method: "GET", - params: { - comment_number: { required: true, type: "integer" }, - content: { - enum: [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - type: "string" - }, - discussion_number: { required: true, type: "integer" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - team_id: { required: true, type: "integer" } - }, - url: - "/teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions" - }, - listForTeamDiscussionCommentInOrg: { - headers: { accept: "application/vnd.github.squirrel-girl-preview+json" }, - method: "GET", - params: { - comment_number: { required: true, type: "integer" }, - content: { - enum: [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - type: "string" - }, - discussion_number: { required: true, type: "integer" }, - org: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - team_slug: { required: true, type: "string" } - }, - url: - "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number/reactions" - }, - listForTeamDiscussionCommentLegacy: { - deprecated: - "octokit.reactions.listForTeamDiscussionCommentLegacy() is deprecated, see https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-comment-legacy", - headers: { accept: "application/vnd.github.squirrel-girl-preview+json" }, - method: "GET", - params: { - comment_number: { required: true, type: "integer" }, - content: { - enum: [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - type: "string" - }, - discussion_number: { required: true, type: "integer" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - team_id: { required: true, type: "integer" } - }, - url: - "/teams/:team_id/discussions/:discussion_number/comments/:comment_number/reactions" - }, - listForTeamDiscussionInOrg: { - headers: { accept: "application/vnd.github.squirrel-girl-preview+json" }, - method: "GET", - params: { - content: { - enum: [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - type: "string" - }, - discussion_number: { required: true, type: "integer" }, - org: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - team_slug: { required: true, type: "string" } - }, - url: - "/orgs/:org/teams/:team_slug/discussions/:discussion_number/reactions" - }, - listForTeamDiscussionLegacy: { - deprecated: - "octokit.reactions.listForTeamDiscussionLegacy() is deprecated, see https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-legacy", - headers: { accept: "application/vnd.github.squirrel-girl-preview+json" }, - method: "GET", - params: { - content: { - enum: [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - type: "string" - }, - discussion_number: { required: true, type: "integer" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - team_id: { required: true, type: "integer" } - }, - url: "/teams/:team_id/discussions/:discussion_number/reactions" - } + createForCommitComment: [ + "POST /repos/{owner}/{repo}/comments/{comment_id}/reactions", + { mediaType: { previews: ["squirrel-girl"] } } + ], + createForIssue: [ + "POST /repos/{owner}/{repo}/issues/{issue_number}/reactions", + { mediaType: { previews: ["squirrel-girl"] } } + ], + createForIssueComment: [ + "POST /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", + { mediaType: { previews: ["squirrel-girl"] } } + ], + createForPullRequestReviewComment: [ + "POST /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", + { mediaType: { previews: ["squirrel-girl"] } } + ], + createForTeamDiscussionCommentInOrg: [ + "POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", + { mediaType: { previews: ["squirrel-girl"] } } + ], + createForTeamDiscussionInOrg: [ + "POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", + { mediaType: { previews: ["squirrel-girl"] } } + ], + delete: [ + "DELETE /reactions/{reaction_id}", + { mediaType: { previews: ["squirrel-girl"] } } + ], + listForCommitComment: [ + "GET /repos/{owner}/{repo}/comments/{comment_id}/reactions", + { mediaType: { previews: ["squirrel-girl"] } } + ], + listForIssue: [ + "GET /repos/{owner}/{repo}/issues/{issue_number}/reactions", + { mediaType: { previews: ["squirrel-girl"] } } + ], + listForIssueComment: [ + "GET /repos/{owner}/{repo}/issues/comments/{comment_id}/reactions", + { mediaType: { previews: ["squirrel-girl"] } } + ], + listForPullRequestReviewComment: [ + "GET /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions", + { mediaType: { previews: ["squirrel-girl"] } } + ], + listForTeamDiscussionCommentInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", + { mediaType: { previews: ["squirrel-girl"] } } + ], + listForTeamDiscussionInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", + { mediaType: { previews: ["squirrel-girl"] } } + ] }, repos: { - acceptInvitation: { - method: "PATCH", - params: { invitation_id: { required: true, type: "integer" } }, - url: "/user/repository_invitations/:invitation_id" - }, - addCollaborator: { - method: "PUT", - params: { - owner: { required: true, type: "string" }, - permission: { enum: ["pull", "push", "admin"], type: "string" }, - repo: { required: true, type: "string" }, - username: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/collaborators/:username" - }, - addDeployKey: { - method: "POST", - params: { - key: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - read_only: { type: "boolean" }, - repo: { required: true, type: "string" }, - title: { type: "string" } - }, - url: "/repos/:owner/:repo/keys" - }, - addProtectedBranchAdminEnforcement: { - method: "POST", - params: { - branch: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/branches/:branch/protection/enforce_admins" - }, - addProtectedBranchAppRestrictions: { - method: "POST", - params: { - apps: { mapTo: "data", required: true, type: "string[]" }, - branch: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps" - }, - addProtectedBranchRequiredSignatures: { - headers: { accept: "application/vnd.github.zzzax-preview+json" }, - method: "POST", - params: { - branch: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/branches/:branch/protection/required_signatures" - }, - addProtectedBranchRequiredStatusChecksContexts: { - method: "POST", - params: { - branch: { required: true, type: "string" }, - contexts: { mapTo: "data", required: true, type: "string[]" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: - "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts" - }, - addProtectedBranchTeamRestrictions: { - method: "POST", - params: { - branch: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" }, - teams: { mapTo: "data", required: true, type: "string[]" } - }, - url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams" - }, - addProtectedBranchUserRestrictions: { - method: "POST", - params: { - branch: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" }, - users: { mapTo: "data", required: true, type: "string[]" } - }, - url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/users" - }, - checkCollaborator: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" }, - username: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/collaborators/:username" - }, - checkVulnerabilityAlerts: { - headers: { accept: "application/vnd.github.dorian-preview+json" }, - method: "GET", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/vulnerability-alerts" - }, - compareCommits: { - method: "GET", - params: { - base: { required: true, type: "string" }, - head: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/compare/:base...:head" - }, - createCommitComment: { - method: "POST", - params: { - body: { required: true, type: "string" }, - commit_sha: { required: true, type: "string" }, - line: { type: "integer" }, - owner: { required: true, type: "string" }, - path: { type: "string" }, - position: { type: "integer" }, - repo: { required: true, type: "string" }, - sha: { alias: "commit_sha", deprecated: true, type: "string" } - }, - url: "/repos/:owner/:repo/commits/:commit_sha/comments" - }, - createDeployment: { - method: "POST", - params: { - auto_merge: { type: "boolean" }, - description: { type: "string" }, - environment: { type: "string" }, - owner: { required: true, type: "string" }, - payload: { type: "string" }, - production_environment: { type: "boolean" }, - ref: { required: true, type: "string" }, - repo: { required: true, type: "string" }, - required_contexts: { type: "string[]" }, - task: { type: "string" }, - transient_environment: { type: "boolean" } - }, - url: "/repos/:owner/:repo/deployments" - }, - createDeploymentStatus: { - method: "POST", - params: { - auto_inactive: { type: "boolean" }, - deployment_id: { required: true, type: "integer" }, - description: { type: "string" }, - environment: { enum: ["production", "staging", "qa"], type: "string" }, - environment_url: { type: "string" }, - log_url: { type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" }, - state: { - enum: [ - "error", - "failure", - "inactive", - "in_progress", - "queued", - "pending", - "success" - ], - required: true, - type: "string" - }, - target_url: { type: "string" } - }, - url: "/repos/:owner/:repo/deployments/:deployment_id/statuses" - }, - createDispatchEvent: { - method: "POST", - params: { - client_payload: { type: "object" }, - event_type: { type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/dispatches" - }, - createFile: { - deprecated: - "octokit.repos.createFile() has been renamed to octokit.repos.createOrUpdateFile() (2019-06-07)", - method: "PUT", - params: { - author: { type: "object" }, - "author.email": { required: true, type: "string" }, - "author.name": { required: true, type: "string" }, - branch: { type: "string" }, - committer: { type: "object" }, - "committer.email": { required: true, type: "string" }, - "committer.name": { required: true, type: "string" }, - content: { required: true, type: "string" }, - message: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - path: { required: true, type: "string" }, - repo: { required: true, type: "string" }, - sha: { type: "string" } - }, - url: "/repos/:owner/:repo/contents/:path" - }, - createForAuthenticatedUser: { - method: "POST", - params: { - allow_merge_commit: { type: "boolean" }, - allow_rebase_merge: { type: "boolean" }, - allow_squash_merge: { type: "boolean" }, - auto_init: { type: "boolean" }, - delete_branch_on_merge: { type: "boolean" }, - description: { type: "string" }, - gitignore_template: { type: "string" }, - has_issues: { type: "boolean" }, - has_projects: { type: "boolean" }, - has_wiki: { type: "boolean" }, - homepage: { type: "string" }, - is_template: { type: "boolean" }, - license_template: { type: "string" }, - name: { required: true, type: "string" }, - private: { type: "boolean" }, - team_id: { type: "integer" }, - visibility: { - enum: ["public", "private", "visibility", "internal"], - type: "string" - } - }, - url: "/user/repos" - }, - createFork: { - method: "POST", - params: { - organization: { type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/forks" - }, - 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: { type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/hooks" - }, - createInOrg: { - method: "POST", - params: { - allow_merge_commit: { type: "boolean" }, - allow_rebase_merge: { type: "boolean" }, - allow_squash_merge: { type: "boolean" }, - auto_init: { type: "boolean" }, - delete_branch_on_merge: { type: "boolean" }, - description: { type: "string" }, - gitignore_template: { type: "string" }, - has_issues: { type: "boolean" }, - has_projects: { type: "boolean" }, - has_wiki: { type: "boolean" }, - homepage: { type: "string" }, - is_template: { type: "boolean" }, - license_template: { type: "string" }, - name: { required: true, type: "string" }, - org: { required: true, type: "string" }, - private: { type: "boolean" }, - team_id: { type: "integer" }, - visibility: { - enum: ["public", "private", "visibility", "internal"], - type: "string" - } - }, - url: "/orgs/:org/repos" - }, - createOrUpdateFile: { - method: "PUT", - params: { - author: { type: "object" }, - "author.email": { required: true, type: "string" }, - "author.name": { required: true, type: "string" }, - branch: { type: "string" }, - committer: { type: "object" }, - "committer.email": { required: true, type: "string" }, - "committer.name": { required: true, type: "string" }, - content: { required: true, type: "string" }, - message: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - path: { required: true, type: "string" }, - repo: { required: true, type: "string" }, - sha: { type: "string" } - }, - url: "/repos/:owner/:repo/contents/:path" - }, - createRelease: { - method: "POST", - params: { - body: { type: "string" }, - draft: { type: "boolean" }, - name: { type: "string" }, - owner: { required: true, type: "string" }, - prerelease: { type: "boolean" }, - repo: { required: true, type: "string" }, - tag_name: { required: true, type: "string" }, - target_commitish: { type: "string" } - }, - url: "/repos/:owner/:repo/releases" - }, - createStatus: { - method: "POST", - params: { - context: { type: "string" }, - description: { type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" }, - sha: { required: true, type: "string" }, - state: { - enum: ["error", "failure", "pending", "success"], - required: true, - type: "string" - }, - target_url: { type: "string" } - }, - url: "/repos/:owner/:repo/statuses/:sha" - }, - createUsingTemplate: { - headers: { accept: "application/vnd.github.baptiste-preview+json" }, - method: "POST", - params: { - description: { type: "string" }, - name: { required: true, type: "string" }, - owner: { type: "string" }, - private: { type: "boolean" }, - template_owner: { required: true, type: "string" }, - template_repo: { required: true, type: "string" } - }, - url: "/repos/:template_owner/:template_repo/generate" - }, - declineInvitation: { - method: "DELETE", - params: { invitation_id: { required: true, type: "integer" } }, - url: "/user/repository_invitations/:invitation_id" - }, - delete: { - method: "DELETE", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo" - }, - deleteCommitComment: { - method: "DELETE", - params: { - comment_id: { required: true, type: "integer" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/comments/:comment_id" - }, - deleteDownload: { - method: "DELETE", - params: { - download_id: { required: true, type: "integer" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/downloads/:download_id" - }, - deleteFile: { - method: "DELETE", - params: { - author: { type: "object" }, - "author.email": { type: "string" }, - "author.name": { type: "string" }, - branch: { type: "string" }, - committer: { type: "object" }, - "committer.email": { type: "string" }, - "committer.name": { type: "string" }, - message: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - path: { required: true, type: "string" }, - repo: { required: true, type: "string" }, - sha: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/contents/:path" - }, - deleteHook: { - method: "DELETE", - params: { - hook_id: { required: true, type: "integer" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/hooks/:hook_id" - }, - deleteInvitation: { - method: "DELETE", - params: { - invitation_id: { required: true, type: "integer" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/invitations/:invitation_id" - }, - deleteRelease: { - method: "DELETE", - params: { - owner: { required: true, type: "string" }, - release_id: { required: true, type: "integer" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/releases/:release_id" - }, - deleteReleaseAsset: { - method: "DELETE", - params: { - asset_id: { required: true, type: "integer" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/releases/assets/:asset_id" - }, - disableAutomatedSecurityFixes: { - headers: { accept: "application/vnd.github.london-preview+json" }, - method: "DELETE", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/automated-security-fixes" - }, - disablePagesSite: { - headers: { accept: "application/vnd.github.switcheroo-preview+json" }, - method: "DELETE", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/pages" - }, - disableVulnerabilityAlerts: { - headers: { accept: "application/vnd.github.dorian-preview+json" }, - method: "DELETE", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/vulnerability-alerts" - }, - enableAutomatedSecurityFixes: { - headers: { accept: "application/vnd.github.london-preview+json" }, - method: "PUT", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/automated-security-fixes" - }, - enablePagesSite: { - headers: { accept: "application/vnd.github.switcheroo-preview+json" }, - method: "POST", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" }, - source: { type: "object" }, - "source.branch": { enum: ["master", "gh-pages"], type: "string" }, - "source.path": { type: "string" } - }, - url: "/repos/:owner/:repo/pages" - }, - enableVulnerabilityAlerts: { - headers: { accept: "application/vnd.github.dorian-preview+json" }, - method: "PUT", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/vulnerability-alerts" - }, - get: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo" - }, - getAppsWithAccessToProtectedBranch: { - method: "GET", - params: { - branch: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps" - }, - getArchiveLink: { - method: "GET", - params: { - archive_format: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - ref: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/:archive_format/:ref" - }, - getBranch: { - method: "GET", - params: { - branch: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/branches/:branch" - }, - getBranchProtection: { - method: "GET", - params: { - branch: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/branches/:branch/protection" - }, - getClones: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - per: { enum: ["day", "week"], type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/traffic/clones" - }, - getCodeFrequencyStats: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/stats/code_frequency" - }, - getCollaboratorPermissionLevel: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" }, - username: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/collaborators/:username/permission" - }, - getCombinedStatusForRef: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - ref: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/commits/:ref/status" - }, - getCommit: { - method: "GET", - params: { - commit_sha: { alias: "ref", deprecated: true, type: "string" }, - owner: { required: true, type: "string" }, - ref: { required: true, type: "string" }, - repo: { required: true, type: "string" }, - sha: { alias: "ref", deprecated: true, type: "string" } - }, - url: "/repos/:owner/:repo/commits/:ref" - }, - getCommitActivityStats: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/stats/commit_activity" - }, - getCommitComment: { - method: "GET", - params: { - comment_id: { required: true, type: "integer" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/comments/:comment_id" - }, - getCommitRefSha: { - deprecated: - "octokit.repos.getCommitRefSha() is deprecated, see https://developer.github.com/v3/repos/commits/#get-a-single-commit", - headers: { accept: "application/vnd.github.v3.sha" }, - method: "GET", - params: { - owner: { required: true, type: "string" }, - ref: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/commits/:ref" - }, - getContents: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - path: { required: true, type: "string" }, - ref: { type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/contents/:path" - }, - getContributorsStats: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/stats/contributors" - }, - getDeployKey: { - method: "GET", - params: { - key_id: { required: true, type: "integer" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/keys/:key_id" - }, - getDeployment: { - method: "GET", - params: { - deployment_id: { required: true, type: "integer" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/deployments/:deployment_id" - }, - getDeploymentStatus: { - method: "GET", - params: { - deployment_id: { required: true, type: "integer" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" }, - status_id: { required: true, type: "integer" } - }, - url: "/repos/:owner/:repo/deployments/:deployment_id/statuses/:status_id" - }, - getDownload: { - method: "GET", - params: { - download_id: { required: true, type: "integer" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/downloads/:download_id" - }, - getHook: { - method: "GET", - params: { - hook_id: { required: true, type: "integer" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/hooks/:hook_id" - }, - getLatestPagesBuild: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/pages/builds/latest" - }, - getLatestRelease: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/releases/latest" - }, - getPages: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/pages" - }, - getPagesBuild: { - method: "GET", - params: { - build_id: { required: true, type: "integer" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/pages/builds/:build_id" - }, - getParticipationStats: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/stats/participation" - }, - getProtectedBranchAdminEnforcement: { - method: "GET", - params: { - branch: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/branches/:branch/protection/enforce_admins" - }, - getProtectedBranchPullRequestReviewEnforcement: { - method: "GET", - params: { - branch: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: - "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews" - }, - getProtectedBranchRequiredSignatures: { - headers: { accept: "application/vnd.github.zzzax-preview+json" }, - method: "GET", - params: { - branch: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/branches/:branch/protection/required_signatures" - }, - getProtectedBranchRequiredStatusChecks: { - method: "GET", - params: { - branch: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: - "/repos/:owner/:repo/branches/:branch/protection/required_status_checks" - }, - getProtectedBranchRestrictions: { - method: "GET", - params: { - branch: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/branches/:branch/protection/restrictions" - }, - getPunchCardStats: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/stats/punch_card" - }, - getReadme: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - ref: { type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/readme" - }, - getRelease: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - release_id: { required: true, type: "integer" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/releases/:release_id" - }, - getReleaseAsset: { - method: "GET", - params: { - asset_id: { required: true, type: "integer" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/releases/assets/:asset_id" - }, - getReleaseByTag: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" }, - tag: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/releases/tags/:tag" - }, - getTeamsWithAccessToProtectedBranch: { - method: "GET", - params: { - branch: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams" - }, - getTopPaths: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/traffic/popular/paths" - }, - getTopReferrers: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/traffic/popular/referrers" - }, - getUsersWithAccessToProtectedBranch: { - method: "GET", - params: { - branch: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/users" - }, - getViews: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - per: { enum: ["day", "week"], type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/traffic/views" - }, - list: { - method: "GET", - params: { - affiliation: { type: "string" }, - direction: { enum: ["asc", "desc"], type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - sort: { - enum: ["created", "updated", "pushed", "full_name"], - type: "string" - }, - type: { - enum: ["all", "owner", "public", "private", "member"], - type: "string" - }, - visibility: { enum: ["all", "public", "private"], type: "string" } - }, - url: "/user/repos" - }, - listAppsWithAccessToProtectedBranch: { - deprecated: - "octokit.repos.listAppsWithAccessToProtectedBranch() has been renamed to octokit.repos.getAppsWithAccessToProtectedBranch() (2019-09-13)", - method: "GET", - params: { - branch: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps" - }, - listAssetsForRelease: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - release_id: { required: true, type: "integer" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/releases/:release_id/assets" - }, - listBranches: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - protected: { type: "boolean" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/branches" - }, - listBranchesForHeadCommit: { - headers: { accept: "application/vnd.github.groot-preview+json" }, - method: "GET", - params: { - commit_sha: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/commits/:commit_sha/branches-where-head" - }, - listCollaborators: { - method: "GET", - params: { - affiliation: { enum: ["outside", "direct", "all"], type: "string" }, - owner: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/collaborators" - }, - listCommentsForCommit: { - method: "GET", - params: { - commit_sha: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - ref: { alias: "commit_sha", deprecated: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/commits/:commit_sha/comments" - }, - listCommitComments: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/comments" - }, - listCommits: { - method: "GET", - params: { - author: { type: "string" }, - owner: { required: true, type: "string" }, - page: { type: "integer" }, - path: { type: "string" }, - per_page: { type: "integer" }, - repo: { required: true, type: "string" }, - sha: { type: "string" }, - since: { type: "string" }, - until: { type: "string" } - }, - url: "/repos/:owner/:repo/commits" - }, - listContributors: { - method: "GET", - params: { - anon: { type: "string" }, - owner: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/contributors" - }, - listDeployKeys: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/keys" - }, - listDeploymentStatuses: { - method: "GET", - params: { - deployment_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/deployments/:deployment_id/statuses" - }, - listDeployments: { - method: "GET", - params: { - environment: { type: "string" }, - owner: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - ref: { type: "string" }, - repo: { required: true, type: "string" }, - sha: { type: "string" }, - task: { type: "string" } - }, - url: "/repos/:owner/:repo/deployments" - }, - listDownloads: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/downloads" - }, - listForOrg: { - method: "GET", - params: { - direction: { enum: ["asc", "desc"], type: "string" }, - org: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - sort: { - enum: ["created", "updated", "pushed", "full_name"], - type: "string" - }, - type: { - enum: [ - "all", - "public", - "private", - "forks", - "sources", - "member", - "internal" - ], - type: "string" - } - }, - url: "/orgs/:org/repos" - }, - listForUser: { - method: "GET", - params: { - direction: { enum: ["asc", "desc"], type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - sort: { - enum: ["created", "updated", "pushed", "full_name"], - type: "string" - }, - type: { enum: ["all", "owner", "member"], type: "string" }, - username: { required: true, type: "string" } - }, - url: "/users/:username/repos" - }, - listForks: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - repo: { required: true, type: "string" }, - sort: { enum: ["newest", "oldest", "stargazers"], type: "string" } - }, - url: "/repos/:owner/:repo/forks" - }, - listHooks: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/hooks" - }, - listInvitations: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/invitations" - }, - listInvitationsForAuthenticatedUser: { - method: "GET", - params: { page: { type: "integer" }, per_page: { type: "integer" } }, - url: "/user/repository_invitations" - }, - listLanguages: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/languages" - }, - listPagesBuilds: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/pages/builds" - }, - listProtectedBranchRequiredStatusChecksContexts: { - method: "GET", - params: { - branch: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: - "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts" - }, - listProtectedBranchTeamRestrictions: { - deprecated: - "octokit.repos.listProtectedBranchTeamRestrictions() has been renamed to octokit.repos.getTeamsWithAccessToProtectedBranch() (2019-09-09)", - method: "GET", - params: { - branch: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams" - }, - listProtectedBranchUserRestrictions: { - deprecated: - "octokit.repos.listProtectedBranchUserRestrictions() has been renamed to octokit.repos.getUsersWithAccessToProtectedBranch() (2019-09-09)", - method: "GET", - params: { - branch: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/users" - }, - listPublic: { - method: "GET", - params: { - page: { type: "integer" }, - per_page: { type: "integer" }, - since: { type: "integer" } - }, - url: "/repositories" - }, - listPullRequestsAssociatedWithCommit: { - headers: { accept: "application/vnd.github.groot-preview+json" }, - method: "GET", - params: { - commit_sha: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/commits/:commit_sha/pulls" - }, - listReleases: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/releases" - }, - listStatusesForRef: { - 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/commits/:ref/statuses" - }, - listTags: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/tags" - }, - listTeams: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/teams" - }, - listTeamsWithAccessToProtectedBranch: { - deprecated: - "octokit.repos.listTeamsWithAccessToProtectedBranch() has been renamed to octokit.repos.getTeamsWithAccessToProtectedBranch() (2019-09-13)", - method: "GET", - params: { - branch: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams" - }, - listTopics: { - headers: { accept: "application/vnd.github.mercy-preview+json" }, - method: "GET", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/topics" - }, - listUsersWithAccessToProtectedBranch: { - deprecated: - "octokit.repos.listUsersWithAccessToProtectedBranch() has been renamed to octokit.repos.getUsersWithAccessToProtectedBranch() (2019-09-13)", - method: "GET", - params: { - branch: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/users" - }, - merge: { - method: "POST", - params: { - base: { required: true, type: "string" }, - commit_message: { type: "string" }, - head: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/merges" - }, - pingHook: { - method: "POST", - params: { - hook_id: { required: true, type: "integer" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/hooks/:hook_id/pings" - }, - removeBranchProtection: { - method: "DELETE", - params: { - branch: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/branches/:branch/protection" - }, - removeCollaborator: { - method: "DELETE", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" }, - username: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/collaborators/:username" - }, - removeDeployKey: { - method: "DELETE", - params: { - key_id: { required: true, type: "integer" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/keys/:key_id" - }, - removeProtectedBranchAdminEnforcement: { - method: "DELETE", - params: { - branch: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/branches/:branch/protection/enforce_admins" - }, - removeProtectedBranchAppRestrictions: { - method: "DELETE", - params: { - apps: { mapTo: "data", required: true, type: "string[]" }, - branch: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps" - }, - removeProtectedBranchPullRequestReviewEnforcement: { - method: "DELETE", - params: { - branch: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: - "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews" - }, - removeProtectedBranchRequiredSignatures: { - headers: { accept: "application/vnd.github.zzzax-preview+json" }, - method: "DELETE", - params: { - branch: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/branches/:branch/protection/required_signatures" - }, - removeProtectedBranchRequiredStatusChecks: { - method: "DELETE", - params: { - branch: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: - "/repos/:owner/:repo/branches/:branch/protection/required_status_checks" - }, - removeProtectedBranchRequiredStatusChecksContexts: { - method: "DELETE", - params: { - branch: { required: true, type: "string" }, - contexts: { mapTo: "data", required: true, type: "string[]" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: - "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts" - }, - removeProtectedBranchRestrictions: { - method: "DELETE", - params: { - branch: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/branches/:branch/protection/restrictions" - }, - removeProtectedBranchTeamRestrictions: { - method: "DELETE", - params: { - branch: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" }, - teams: { mapTo: "data", required: true, type: "string[]" } - }, - url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams" - }, - removeProtectedBranchUserRestrictions: { - method: "DELETE", - params: { - branch: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" }, - users: { mapTo: "data", required: true, type: "string[]" } - }, - url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/users" - }, - replaceProtectedBranchAppRestrictions: { - method: "PUT", - params: { - apps: { mapTo: "data", required: true, type: "string[]" }, - branch: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/apps" - }, - replaceProtectedBranchRequiredStatusChecksContexts: { - method: "PUT", - params: { - branch: { required: true, type: "string" }, - contexts: { mapTo: "data", required: true, type: "string[]" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: - "/repos/:owner/:repo/branches/:branch/protection/required_status_checks/contexts" - }, - replaceProtectedBranchTeamRestrictions: { - method: "PUT", - params: { - branch: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" }, - teams: { mapTo: "data", required: true, type: "string[]" } - }, - url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/teams" - }, - replaceProtectedBranchUserRestrictions: { - method: "PUT", - params: { - branch: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" }, - users: { mapTo: "data", required: true, type: "string[]" } - }, - url: "/repos/:owner/:repo/branches/:branch/protection/restrictions/users" - }, - replaceTopics: { - headers: { accept: "application/vnd.github.mercy-preview+json" }, - method: "PUT", - params: { - names: { required: true, type: "string[]" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/topics" - }, - requestPageBuild: { - method: "POST", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/pages/builds" - }, - retrieveCommunityProfileMetrics: { - method: "GET", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/community/profile" - }, - testPushHook: { - method: "POST", - params: { - hook_id: { required: true, type: "integer" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/hooks/:hook_id/tests" - }, - transfer: { - method: "POST", - params: { - new_owner: { type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" }, - team_ids: { type: "integer[]" } - }, - url: "/repos/:owner/:repo/transfer" - }, - update: { - method: "PATCH", - params: { - allow_merge_commit: { type: "boolean" }, - allow_rebase_merge: { type: "boolean" }, - allow_squash_merge: { type: "boolean" }, - archived: { type: "boolean" }, - default_branch: { type: "string" }, - delete_branch_on_merge: { type: "boolean" }, - description: { type: "string" }, - has_issues: { type: "boolean" }, - has_projects: { type: "boolean" }, - has_wiki: { type: "boolean" }, - homepage: { type: "string" }, - is_template: { type: "boolean" }, - name: { type: "string" }, - owner: { required: true, type: "string" }, - private: { type: "boolean" }, - repo: { required: true, type: "string" }, - visibility: { - enum: ["public", "private", "visibility", "internal"], - type: "string" - } - }, - url: "/repos/:owner/:repo" - }, - updateBranchProtection: { - method: "PUT", - params: { - allow_deletions: { type: "boolean" }, - allow_force_pushes: { allowNull: true, type: "boolean" }, - branch: { required: true, type: "string" }, - enforce_admins: { allowNull: true, required: true, type: "boolean" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" }, - required_linear_history: { type: "boolean" }, - required_pull_request_reviews: { - allowNull: true, - required: true, - type: "object" - }, - "required_pull_request_reviews.dismiss_stale_reviews": { - type: "boolean" - }, - "required_pull_request_reviews.dismissal_restrictions": { - type: "object" - }, - "required_pull_request_reviews.dismissal_restrictions.teams": { - type: "string[]" - }, - "required_pull_request_reviews.dismissal_restrictions.users": { - type: "string[]" - }, - "required_pull_request_reviews.require_code_owner_reviews": { - type: "boolean" - }, - "required_pull_request_reviews.required_approving_review_count": { - type: "integer" - }, - required_status_checks: { - allowNull: true, - required: true, - type: "object" - }, - "required_status_checks.contexts": { required: true, type: "string[]" }, - "required_status_checks.strict": { required: true, type: "boolean" }, - restrictions: { allowNull: true, required: true, type: "object" }, - "restrictions.apps": { type: "string[]" }, - "restrictions.teams": { required: true, type: "string[]" }, - "restrictions.users": { required: true, type: "string[]" } - }, - url: "/repos/:owner/:repo/branches/:branch/protection" - }, - updateCommitComment: { - 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/comments/:comment_id" - }, - updateFile: { - deprecated: - "octokit.repos.updateFile() has been renamed to octokit.repos.createOrUpdateFile() (2019-06-07)", - method: "PUT", - params: { - author: { type: "object" }, - "author.email": { required: true, type: "string" }, - "author.name": { required: true, type: "string" }, - branch: { type: "string" }, - committer: { type: "object" }, - "committer.email": { required: true, type: "string" }, - "committer.name": { required: true, type: "string" }, - content: { required: true, type: "string" }, - message: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - path: { required: true, type: "string" }, - repo: { required: true, type: "string" }, - sha: { type: "string" } - }, - url: "/repos/:owner/:repo/contents/:path" - }, - updateHook: { - method: "PATCH", - params: { - active: { type: "boolean" }, - add_events: { type: "string[]" }, - config: { type: "object" }, - "config.content_type": { type: "string" }, - "config.insecure_ssl": { type: "string" }, - "config.secret": { type: "string" }, - "config.url": { required: true, type: "string" }, - events: { type: "string[]" }, - hook_id: { required: true, type: "integer" }, - owner: { required: true, type: "string" }, - remove_events: { type: "string[]" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/hooks/:hook_id" - }, - updateInformationAboutPagesSite: { - method: "PUT", - params: { - cname: { type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" }, - source: { - enum: ['"gh-pages"', '"master"', '"master /docs"'], - type: "string" - } - }, - url: "/repos/:owner/:repo/pages" - }, - updateInvitation: { - method: "PATCH", - params: { - invitation_id: { required: true, type: "integer" }, - owner: { required: true, type: "string" }, - permissions: { enum: ["read", "write", "admin"], type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/invitations/:invitation_id" - }, - updateProtectedBranchPullRequestReviewEnforcement: { - method: "PATCH", - params: { - branch: { required: true, type: "string" }, - dismiss_stale_reviews: { type: "boolean" }, - dismissal_restrictions: { type: "object" }, - "dismissal_restrictions.teams": { type: "string[]" }, - "dismissal_restrictions.users": { type: "string[]" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" }, - require_code_owner_reviews: { type: "boolean" }, - required_approving_review_count: { type: "integer" } - }, - url: - "/repos/:owner/:repo/branches/:branch/protection/required_pull_request_reviews" - }, - updateProtectedBranchRequiredStatusChecks: { - method: "PATCH", - params: { - branch: { required: true, type: "string" }, - contexts: { type: "string[]" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" }, - strict: { type: "boolean" } - }, - url: - "/repos/:owner/:repo/branches/:branch/protection/required_status_checks" - }, - updateRelease: { - method: "PATCH", - params: { - body: { type: "string" }, - draft: { type: "boolean" }, - name: { type: "string" }, - owner: { required: true, type: "string" }, - prerelease: { type: "boolean" }, - release_id: { required: true, type: "integer" }, - repo: { required: true, type: "string" }, - tag_name: { type: "string" }, - target_commitish: { type: "string" } - }, - url: "/repos/:owner/:repo/releases/:release_id" - }, - updateReleaseAsset: { - method: "PATCH", - params: { - asset_id: { required: true, type: "integer" }, - label: { type: "string" }, - name: { type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" } - }, - url: "/repos/:owner/:repo/releases/assets/:asset_id" - }, - uploadReleaseAsset: { - method: "POST", - params: { - data: { mapTo: "data", required: true, type: "string | object" }, - file: { alias: "data", deprecated: true, type: "string | object" }, - headers: { required: true, type: "object" }, - "headers.content-length": { required: true, type: "integer" }, - "headers.content-type": { required: true, type: "string" }, - label: { type: "string" }, - name: { required: true, type: "string" }, - url: { required: true, type: "string" } - }, - url: ":url" - } + acceptInvitation: ["PATCH /user/repository_invitations/{invitation_id}"], + addCollaborator: ["PUT /repos/{owner}/{repo}/collaborators/{username}"], + addDeployKey: ["POST /repos/{owner}/{repo}/keys"], + addProtectedBranchAdminEnforcement: [ + "POST /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins" + ], + addProtectedBranchAppRestrictions: [ + "POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + {}, + { mapToData: "apps" } + ], + addProtectedBranchRequiredSignatures: [ + "POST /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", + { mediaType: { previews: ["zzzax"] } } + ], + addProtectedBranchRequiredStatusChecksContexts: [ + "POST /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + {}, + { mapToData: "contexts" } + ], + addProtectedBranchTeamRestrictions: [ + "POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + {}, + { mapToData: "teams" } + ], + addProtectedBranchUserRestrictions: [ + "POST /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + {}, + { mapToData: "users" } + ], + checkCollaborator: ["GET /repos/{owner}/{repo}/collaborators/{username}"], + checkVulnerabilityAlerts: [ + "GET /repos/{owner}/{repo}/vulnerability-alerts", + { mediaType: { previews: ["dorian"] } } + ], + compareCommits: ["GET /repos/{owner}/{repo}/compare/{base}...{head}"], + createCommitComment: [ + "POST /repos/{owner}/{repo}/commits/{commit_sha}/comments" + ], + createDeployment: ["POST /repos/{owner}/{repo}/deployments"], + createDeploymentStatus: [ + "POST /repos/{owner}/{repo}/deployments/{deployment_id}/statuses" + ], + createDispatchEvent: ["POST /repos/{owner}/{repo}/dispatches"], + createForAuthenticatedUser: ["POST /user/repos"], + createFork: ["POST /repos/{owner}/{repo}/forks"], + createHook: ["POST /repos/{owner}/{repo}/hooks"], + createInOrg: ["POST /orgs/{org}/repos"], + createOrUpdateFile: ["PUT /repos/{owner}/{repo}/contents/{path}"], + createRelease: ["POST /repos/{owner}/{repo}/releases"], + createStatus: ["POST /repos/{owner}/{repo}/statuses/{sha}"], + createUsingTemplate: [ + "POST /repos/{template_owner}/{template_repo}/generate", + { mediaType: { previews: ["baptiste"] } } + ], + declineInvitation: ["DELETE /user/repository_invitations/{invitation_id}"], + delete: ["DELETE /repos/{owner}/{repo}"], + deleteCommitComment: ["DELETE /repos/{owner}/{repo}/comments/{comment_id}"], + deleteDownload: ["DELETE /repos/{owner}/{repo}/downloads/{download_id}"], + deleteFile: ["DELETE /repos/{owner}/{repo}/contents/{path}"], + deleteHook: ["DELETE /repos/{owner}/{repo}/hooks/{hook_id}"], + deleteInvitation: [ + "DELETE /repos/{owner}/{repo}/invitations/{invitation_id}" + ], + deleteRelease: ["DELETE /repos/{owner}/{repo}/releases/{release_id}"], + deleteReleaseAsset: [ + "DELETE /repos/{owner}/{repo}/releases/assets/{asset_id}" + ], + disableAutomatedSecurityFixes: [ + "DELETE /repos/{owner}/{repo}/automated-security-fixes", + { mediaType: { previews: ["london"] } } + ], + disablePagesSite: [ + "DELETE /repos/{owner}/{repo}/pages", + { mediaType: { previews: ["switcheroo"] } } + ], + disableVulnerabilityAlerts: [ + "DELETE /repos/{owner}/{repo}/vulnerability-alerts", + { mediaType: { previews: ["dorian"] } } + ], + enableAutomatedSecurityFixes: [ + "PUT /repos/{owner}/{repo}/automated-security-fixes", + { mediaType: { previews: ["london"] } } + ], + enablePagesSite: [ + "POST /repos/{owner}/{repo}/pages", + { mediaType: { previews: ["switcheroo"] } } + ], + enableVulnerabilityAlerts: [ + "PUT /repos/{owner}/{repo}/vulnerability-alerts", + { mediaType: { previews: ["dorian"] } } + ], + get: ["GET /repos/{owner}/{repo}"], + getAppsWithAccessToProtectedBranch: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps" + ], + getArchiveLink: ["GET /repos/{owner}/{repo}/{archive_format}/{ref}"], + getBranch: ["GET /repos/{owner}/{repo}/branches/{branch}"], + getBranchProtection: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection" + ], + getClones: ["GET /repos/{owner}/{repo}/traffic/clones"], + getCodeFrequencyStats: ["GET /repos/{owner}/{repo}/stats/code_frequency"], + getCollaboratorPermissionLevel: [ + "GET /repos/{owner}/{repo}/collaborators/{username}/permission" + ], + getCombinedStatusForRef: ["GET /repos/{owner}/{repo}/commits/{ref}/status"], + getCommit: ["GET /repos/{owner}/{repo}/commits/{ref}"], + getCommitActivityStats: ["GET /repos/{owner}/{repo}/stats/commit_activity"], + getCommitComment: ["GET /repos/{owner}/{repo}/comments/{comment_id}"], + getContents: ["GET /repos/{owner}/{repo}/contents/{path}"], + getContributorsStats: ["GET /repos/{owner}/{repo}/stats/contributors"], + getDeployKey: ["GET /repos/{owner}/{repo}/keys/{key_id}"], + getDeployment: ["GET /repos/{owner}/{repo}/deployments/{deployment_id}"], + getDeploymentStatus: [ + "GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}" + ], + getDownload: ["GET /repos/{owner}/{repo}/downloads/{download_id}"], + getHook: ["GET /repos/{owner}/{repo}/hooks/{hook_id}"], + getLatestPagesBuild: ["GET /repos/{owner}/{repo}/pages/builds/latest"], + getLatestRelease: ["GET /repos/{owner}/{repo}/releases/latest"], + getPages: ["GET /repos/{owner}/{repo}/pages"], + getPagesBuild: ["GET /repos/{owner}/{repo}/pages/builds/{build_id}"], + getParticipationStats: ["GET /repos/{owner}/{repo}/stats/participation"], + getProtectedBranchAdminEnforcement: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins" + ], + getProtectedBranchPullRequestReviewEnforcement: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews" + ], + getProtectedBranchRequiredSignatures: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", + { mediaType: { previews: ["zzzax"] } } + ], + getProtectedBranchRequiredStatusChecks: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks" + ], + getProtectedBranchRestrictions: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions" + ], + getPunchCardStats: ["GET /repos/{owner}/{repo}/stats/punch_card"], + getReadme: ["GET /repos/{owner}/{repo}/readme"], + getRelease: ["GET /repos/{owner}/{repo}/releases/{release_id}"], + getReleaseAsset: ["GET /repos/{owner}/{repo}/releases/assets/{asset_id}"], + getReleaseByTag: ["GET /repos/{owner}/{repo}/releases/tags/{tag}"], + getTeamsWithAccessToProtectedBranch: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams" + ], + getTopPaths: ["GET /repos/{owner}/{repo}/traffic/popular/paths"], + getTopReferrers: ["GET /repos/{owner}/{repo}/traffic/popular/referrers"], + getUsersWithAccessToProtectedBranch: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users" + ], + getViews: ["GET /repos/{owner}/{repo}/traffic/views"], + list: ["GET /user/repos"], + listAssetsForRelease: [ + "GET /repos/{owner}/{repo}/releases/{release_id}/assets" + ], + listBranches: ["GET /repos/{owner}/{repo}/branches"], + listBranchesForHeadCommit: [ + "GET /repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head", + { mediaType: { previews: ["groot"] } } + ], + listCollaborators: ["GET /repos/{owner}/{repo}/collaborators"], + listCommentsForCommit: [ + "GET /repos/{owner}/{repo}/commits/{commit_sha}/comments" + ], + listCommitComments: ["GET /repos/{owner}/{repo}/comments"], + listCommits: ["GET /repos/{owner}/{repo}/commits"], + listContributors: ["GET /repos/{owner}/{repo}/contributors"], + listDeployKeys: ["GET /repos/{owner}/{repo}/keys"], + listDeploymentStatuses: [ + "GET /repos/{owner}/{repo}/deployments/{deployment_id}/statuses" + ], + listDeployments: ["GET /repos/{owner}/{repo}/deployments"], + listDownloads: ["GET /repos/{owner}/{repo}/downloads"], + listForOrg: ["GET /orgs/{org}/repos"], + listForUser: ["GET /users/{username}/repos"], + listForks: ["GET /repos/{owner}/{repo}/forks"], + listHooks: ["GET /repos/{owner}/{repo}/hooks"], + listInvitations: ["GET /repos/{owner}/{repo}/invitations"], + listInvitationsForAuthenticatedUser: ["GET /user/repository_invitations"], + listLanguages: ["GET /repos/{owner}/{repo}/languages"], + listPagesBuilds: ["GET /repos/{owner}/{repo}/pages/builds"], + listProtectedBranchRequiredStatusChecksContexts: [ + "GET /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts" + ], + listPublic: ["GET /repositories"], + listPullRequestsAssociatedWithCommit: [ + "GET /repos/{owner}/{repo}/commits/{commit_sha}/pulls", + { mediaType: { previews: ["groot"] } } + ], + listReleases: ["GET /repos/{owner}/{repo}/releases"], + listStatusesForRef: ["GET /repos/{owner}/{repo}/commits/{ref}/statuses"], + listTags: ["GET /repos/{owner}/{repo}/tags"], + listTeams: ["GET /repos/{owner}/{repo}/teams"], + listTopics: [ + "GET /repos/{owner}/{repo}/topics", + { mediaType: { previews: ["mercy"] } } + ], + merge: ["POST /repos/{owner}/{repo}/merges"], + pingHook: ["POST /repos/{owner}/{repo}/hooks/{hook_id}/pings"], + removeBranchProtection: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection" + ], + removeCollaborator: [ + "DELETE /repos/{owner}/{repo}/collaborators/{username}" + ], + removeDeployKey: ["DELETE /repos/{owner}/{repo}/keys/{key_id}"], + removeProtectedBranchAdminEnforcement: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins" + ], + removeProtectedBranchAppRestrictions: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + {}, + { mapToData: "apps" } + ], + removeProtectedBranchPullRequestReviewEnforcement: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews" + ], + removeProtectedBranchRequiredSignatures: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures", + { mediaType: { previews: ["zzzax"] } } + ], + removeProtectedBranchRequiredStatusChecks: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks" + ], + removeProtectedBranchRequiredStatusChecksContexts: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + {}, + { mapToData: "contexts" } + ], + removeProtectedBranchRestrictions: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions" + ], + removeProtectedBranchTeamRestrictions: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + {}, + { mapToData: "teams" } + ], + removeProtectedBranchUserRestrictions: [ + "DELETE /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + {}, + { mapToData: "users" } + ], + replaceProtectedBranchAppRestrictions: [ + "PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/apps", + {}, + { mapToData: "apps" } + ], + replaceProtectedBranchRequiredStatusChecksContexts: [ + "PUT /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts", + {}, + { mapToData: "contexts" } + ], + replaceProtectedBranchTeamRestrictions: [ + "PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams", + {}, + { mapToData: "teams" } + ], + replaceProtectedBranchUserRestrictions: [ + "PUT /repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users", + {}, + { mapToData: "users" } + ], + replaceTopics: [ + "PUT /repos/{owner}/{repo}/topics", + { mediaType: { previews: ["mercy"] } } + ], + requestPageBuild: ["POST /repos/{owner}/{repo}/pages/builds"], + retrieveCommunityProfileMetrics: [ + "GET /repos/{owner}/{repo}/community/profile" + ], + testPushHook: ["POST /repos/{owner}/{repo}/hooks/{hook_id}/tests"], + transfer: ["POST /repos/{owner}/{repo}/transfer"], + update: ["PATCH /repos/{owner}/{repo}"], + updateBranchProtection: [ + "PUT /repos/{owner}/{repo}/branches/{branch}/protection" + ], + updateCommitComment: ["PATCH /repos/{owner}/{repo}/comments/{comment_id}"], + updateHook: ["PATCH /repos/{owner}/{repo}/hooks/{hook_id}"], + updateInformationAboutPagesSite: ["PUT /repos/{owner}/{repo}/pages"], + updateInvitation: [ + "PATCH /repos/{owner}/{repo}/invitations/{invitation_id}" + ], + updateProtectedBranchPullRequestReviewEnforcement: [ + "PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews" + ], + updateProtectedBranchRequiredStatusChecks: [ + "PATCH /repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks" + ], + updateRelease: ["PATCH /repos/{owner}/{repo}/releases/{release_id}"], + updateReleaseAsset: [ + "PATCH /repos/{owner}/{repo}/releases/assets/{asset_id}" + ], + uploadReleaseAsset: [ + "POST /repos/{owner}/{repo}/releases/{release_id}/assets{?name,label}", + { baseUrl: "https://uploads.github.com" } + ] }, search: { - code: { - method: "GET", - params: { - order: { enum: ["desc", "asc"], type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - q: { required: true, type: "string" }, - sort: { enum: ["indexed"], type: "string" } - }, - url: "/search/code" - }, - commits: { - headers: { accept: "application/vnd.github.cloak-preview+json" }, - method: "GET", - params: { - order: { enum: ["desc", "asc"], type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - q: { required: true, type: "string" }, - sort: { enum: ["author-date", "committer-date"], type: "string" } - }, - url: "/search/commits" - }, - issues: { - deprecated: - "octokit.search.issues() has been renamed to octokit.search.issuesAndPullRequests() (2018-12-27)", - method: "GET", - params: { - order: { enum: ["desc", "asc"], type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - q: { required: true, type: "string" }, - sort: { - enum: [ - "comments", - "reactions", - "reactions-+1", - "reactions--1", - "reactions-smile", - "reactions-thinking_face", - "reactions-heart", - "reactions-tada", - "interactions", - "created", - "updated" - ], - type: "string" - } - }, - url: "/search/issues" - }, - issuesAndPullRequests: { - method: "GET", - params: { - order: { enum: ["desc", "asc"], type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - q: { required: true, type: "string" }, - sort: { - enum: [ - "comments", - "reactions", - "reactions-+1", - "reactions--1", - "reactions-smile", - "reactions-thinking_face", - "reactions-heart", - "reactions-tada", - "interactions", - "created", - "updated" - ], - type: "string" - } - }, - url: "/search/issues" - }, - labels: { - method: "GET", - params: { - order: { enum: ["desc", "asc"], type: "string" }, - q: { required: true, type: "string" }, - repository_id: { required: true, type: "integer" }, - sort: { enum: ["created", "updated"], type: "string" } - }, - url: "/search/labels" - }, - repos: { - method: "GET", - params: { - order: { enum: ["desc", "asc"], type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - q: { required: true, type: "string" }, - sort: { - enum: ["stars", "forks", "help-wanted-issues", "updated"], - type: "string" - } - }, - url: "/search/repositories" - }, - topics: { - method: "GET", - params: { q: { required: true, type: "string" } }, - url: "/search/topics" - }, - users: { - method: "GET", - params: { - order: { enum: ["desc", "asc"], type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - q: { required: true, type: "string" }, - sort: { enum: ["followers", "repositories", "joined"], type: "string" } - }, - url: "/search/users" - } + code: ["GET /search/code"], + commits: ["GET /search/commits", { mediaType: { previews: ["cloak"] } }], + issuesAndPullRequests: ["GET /search/issues"], + labels: ["GET /search/labels"], + repos: ["GET /search/repositories"], + topics: ["GET /search/topics"], + users: ["GET /search/users"] }, teams: { - addMember: { - deprecated: - "octokit.teams.addMember() has been renamed to octokit.teams.addMemberLegacy() (2020-01-16)", - method: "PUT", - params: { - team_id: { required: true, type: "integer" }, - username: { required: true, type: "string" } - }, - url: "/teams/:team_id/members/:username" - }, - addMemberLegacy: { - deprecated: - "octokit.teams.addMemberLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#add-team-member-legacy", - method: "PUT", - params: { - team_id: { required: true, type: "integer" }, - username: { required: true, type: "string" } - }, - url: "/teams/:team_id/members/:username" - }, - addOrUpdateMembership: { - deprecated: - "octokit.teams.addOrUpdateMembership() has been renamed to octokit.teams.addOrUpdateMembershipLegacy() (2020-01-16)", - method: "PUT", - params: { - role: { enum: ["member", "maintainer"], type: "string" }, - team_id: { required: true, type: "integer" }, - username: { required: true, type: "string" } - }, - url: "/teams/:team_id/memberships/:username" - }, - addOrUpdateMembershipInOrg: { - method: "PUT", - params: { - org: { required: true, type: "string" }, - role: { enum: ["member", "maintainer"], type: "string" }, - team_slug: { required: true, type: "string" }, - username: { required: true, type: "string" } - }, - url: "/orgs/:org/teams/:team_slug/memberships/:username" - }, - addOrUpdateMembershipLegacy: { - deprecated: - "octokit.teams.addOrUpdateMembershipLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#add-or-update-team-membership-legacy", - method: "PUT", - params: { - role: { enum: ["member", "maintainer"], type: "string" }, - team_id: { required: true, type: "integer" }, - username: { required: true, type: "string" } - }, - url: "/teams/:team_id/memberships/:username" - }, - addOrUpdateProject: { - deprecated: - "octokit.teams.addOrUpdateProject() has been renamed to octokit.teams.addOrUpdateProjectLegacy() (2020-01-16)", - headers: { accept: "application/vnd.github.inertia-preview+json" }, - method: "PUT", - params: { - permission: { enum: ["read", "write", "admin"], type: "string" }, - project_id: { required: true, type: "integer" }, - team_id: { required: true, type: "integer" } - }, - url: "/teams/:team_id/projects/:project_id" - }, - addOrUpdateProjectInOrg: { - headers: { accept: "application/vnd.github.inertia-preview+json" }, - method: "PUT", - params: { - org: { required: true, type: "string" }, - permission: { enum: ["read", "write", "admin"], type: "string" }, - project_id: { required: true, type: "integer" }, - team_slug: { required: true, type: "string" } - }, - url: "/orgs/:org/teams/:team_slug/projects/:project_id" - }, - addOrUpdateProjectLegacy: { - deprecated: - "octokit.teams.addOrUpdateProjectLegacy() is deprecated, see https://developer.github.com/v3/teams/#add-or-update-team-project-legacy", - headers: { accept: "application/vnd.github.inertia-preview+json" }, - method: "PUT", - params: { - permission: { enum: ["read", "write", "admin"], type: "string" }, - project_id: { required: true, type: "integer" }, - team_id: { required: true, type: "integer" } - }, - url: "/teams/:team_id/projects/:project_id" - }, - addOrUpdateRepo: { - deprecated: - "octokit.teams.addOrUpdateRepo() has been renamed to octokit.teams.addOrUpdateRepoLegacy() (2020-01-16)", - method: "PUT", - params: { - owner: { required: true, type: "string" }, - permission: { enum: ["pull", "push", "admin"], type: "string" }, - repo: { required: true, type: "string" }, - team_id: { required: true, type: "integer" } - }, - url: "/teams/:team_id/repos/:owner/:repo" - }, - addOrUpdateRepoInOrg: { - method: "PUT", - params: { - org: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - permission: { enum: ["pull", "push", "admin"], type: "string" }, - repo: { required: true, type: "string" }, - team_slug: { required: true, type: "string" } - }, - url: "/orgs/:org/teams/:team_slug/repos/:owner/:repo" - }, - addOrUpdateRepoLegacy: { - deprecated: - "octokit.teams.addOrUpdateRepoLegacy() is deprecated, see https://developer.github.com/v3/teams/#add-or-update-team-repository-legacy", - method: "PUT", - params: { - owner: { required: true, type: "string" }, - permission: { enum: ["pull", "push", "admin"], type: "string" }, - repo: { required: true, type: "string" }, - team_id: { required: true, type: "integer" } - }, - url: "/teams/:team_id/repos/:owner/:repo" - }, - checkManagesRepo: { - deprecated: - "octokit.teams.checkManagesRepo() has been renamed to octokit.teams.checkManagesRepoLegacy() (2020-01-16)", - method: "GET", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" }, - team_id: { required: true, type: "integer" } - }, - url: "/teams/:team_id/repos/:owner/:repo" - }, - checkManagesRepoInOrg: { - method: "GET", - params: { - org: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" }, - team_slug: { required: true, type: "string" } - }, - url: "/orgs/:org/teams/:team_slug/repos/:owner/:repo" - }, - checkManagesRepoLegacy: { - deprecated: - "octokit.teams.checkManagesRepoLegacy() is deprecated, see https://developer.github.com/v3/teams/#check-if-a-team-manages-a-repository-legacy", - method: "GET", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" }, - team_id: { required: true, type: "integer" } - }, - url: "/teams/:team_id/repos/:owner/:repo" - }, - create: { - method: "POST", - params: { - description: { type: "string" }, - maintainers: { type: "string[]" }, - name: { required: true, type: "string" }, - org: { required: true, type: "string" }, - parent_team_id: { type: "integer" }, - permission: { enum: ["pull", "push", "admin"], type: "string" }, - privacy: { enum: ["secret", "closed"], type: "string" }, - repo_names: { type: "string[]" } - }, - url: "/orgs/:org/teams" - }, - createDiscussion: { - deprecated: - "octokit.teams.createDiscussion() has been renamed to octokit.teams.createDiscussionLegacy() (2020-01-16)", - method: "POST", - params: { - body: { required: true, type: "string" }, - private: { type: "boolean" }, - team_id: { required: true, type: "integer" }, - title: { required: true, type: "string" } - }, - url: "/teams/:team_id/discussions" - }, - createDiscussionComment: { - deprecated: - "octokit.teams.createDiscussionComment() has been renamed to octokit.teams.createDiscussionCommentLegacy() (2020-01-16)", - method: "POST", - params: { - body: { required: true, type: "string" }, - discussion_number: { required: true, type: "integer" }, - team_id: { required: true, type: "integer" } - }, - url: "/teams/:team_id/discussions/:discussion_number/comments" - }, - createDiscussionCommentInOrg: { - method: "POST", - params: { - body: { required: true, type: "string" }, - discussion_number: { required: true, type: "integer" }, - org: { required: true, type: "string" }, - team_slug: { required: true, type: "string" } - }, - url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments" - }, - createDiscussionCommentLegacy: { - deprecated: - "octokit.teams.createDiscussionCommentLegacy() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#create-a-comment-legacy", - method: "POST", - params: { - body: { required: true, type: "string" }, - discussion_number: { required: true, type: "integer" }, - team_id: { required: true, type: "integer" } - }, - url: "/teams/:team_id/discussions/:discussion_number/comments" - }, - createDiscussionInOrg: { - method: "POST", - params: { - body: { required: true, type: "string" }, - org: { required: true, type: "string" }, - private: { type: "boolean" }, - team_slug: { required: true, type: "string" }, - title: { required: true, type: "string" } - }, - url: "/orgs/:org/teams/:team_slug/discussions" - }, - createDiscussionLegacy: { - deprecated: - "octokit.teams.createDiscussionLegacy() is deprecated, see https://developer.github.com/v3/teams/discussions/#create-a-discussion-legacy", - method: "POST", - params: { - body: { required: true, type: "string" }, - private: { type: "boolean" }, - team_id: { required: true, type: "integer" }, - title: { required: true, type: "string" } - }, - url: "/teams/:team_id/discussions" - }, - delete: { - deprecated: - "octokit.teams.delete() has been renamed to octokit.teams.deleteLegacy() (2020-01-16)", - method: "DELETE", - params: { team_id: { required: true, type: "integer" } }, - url: "/teams/:team_id" - }, - deleteDiscussion: { - deprecated: - "octokit.teams.deleteDiscussion() has been renamed to octokit.teams.deleteDiscussionLegacy() (2020-01-16)", - method: "DELETE", - params: { - discussion_number: { required: true, type: "integer" }, - team_id: { required: true, type: "integer" } - }, - url: "/teams/:team_id/discussions/:discussion_number" - }, - deleteDiscussionComment: { - deprecated: - "octokit.teams.deleteDiscussionComment() has been renamed to octokit.teams.deleteDiscussionCommentLegacy() (2020-01-16)", - method: "DELETE", - params: { - comment_number: { required: true, type: "integer" }, - discussion_number: { required: true, type: "integer" }, - team_id: { required: true, type: "integer" } - }, - url: - "/teams/:team_id/discussions/:discussion_number/comments/:comment_number" - }, - deleteDiscussionCommentInOrg: { - method: "DELETE", - params: { - comment_number: { required: true, type: "integer" }, - discussion_number: { required: true, type: "integer" }, - org: { required: true, type: "string" }, - team_slug: { required: true, type: "string" } - }, - url: - "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number" - }, - deleteDiscussionCommentLegacy: { - deprecated: - "octokit.teams.deleteDiscussionCommentLegacy() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#delete-a-comment-legacy", - method: "DELETE", - params: { - comment_number: { required: true, type: "integer" }, - discussion_number: { required: true, type: "integer" }, - team_id: { required: true, type: "integer" } - }, - url: - "/teams/:team_id/discussions/:discussion_number/comments/:comment_number" - }, - deleteDiscussionInOrg: { - method: "DELETE", - params: { - discussion_number: { required: true, type: "integer" }, - org: { required: true, type: "string" }, - team_slug: { required: true, type: "string" } - }, - url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number" - }, - deleteDiscussionLegacy: { - deprecated: - "octokit.teams.deleteDiscussionLegacy() is deprecated, see https://developer.github.com/v3/teams/discussions/#delete-a-discussion-legacy", - method: "DELETE", - params: { - discussion_number: { required: true, type: "integer" }, - team_id: { required: true, type: "integer" } - }, - url: "/teams/:team_id/discussions/:discussion_number" - }, - deleteInOrg: { - method: "DELETE", - params: { - org: { required: true, type: "string" }, - team_slug: { required: true, type: "string" } - }, - url: "/orgs/:org/teams/:team_slug" - }, - deleteLegacy: { - deprecated: - "octokit.teams.deleteLegacy() is deprecated, see https://developer.github.com/v3/teams/#delete-team-legacy", - method: "DELETE", - params: { team_id: { required: true, type: "integer" } }, - url: "/teams/:team_id" - }, - get: { - deprecated: - "octokit.teams.get() has been renamed to octokit.teams.getLegacy() (2020-01-16)", - method: "GET", - params: { team_id: { required: true, type: "integer" } }, - url: "/teams/:team_id" - }, - getByName: { - method: "GET", - params: { - org: { required: true, type: "string" }, - team_slug: { required: true, type: "string" } - }, - url: "/orgs/:org/teams/:team_slug" - }, - getDiscussion: { - deprecated: - "octokit.teams.getDiscussion() has been renamed to octokit.teams.getDiscussionLegacy() (2020-01-16)", - method: "GET", - params: { - discussion_number: { required: true, type: "integer" }, - team_id: { required: true, type: "integer" } - }, - url: "/teams/:team_id/discussions/:discussion_number" - }, - getDiscussionComment: { - deprecated: - "octokit.teams.getDiscussionComment() has been renamed to octokit.teams.getDiscussionCommentLegacy() (2020-01-16)", - method: "GET", - params: { - comment_number: { required: true, type: "integer" }, - discussion_number: { required: true, type: "integer" }, - team_id: { required: true, type: "integer" } - }, - url: - "/teams/:team_id/discussions/:discussion_number/comments/:comment_number" - }, - getDiscussionCommentInOrg: { - method: "GET", - params: { - comment_number: { required: true, type: "integer" }, - discussion_number: { required: true, type: "integer" }, - org: { required: true, type: "string" }, - team_slug: { required: true, type: "string" } - }, - url: - "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number" - }, - getDiscussionCommentLegacy: { - deprecated: - "octokit.teams.getDiscussionCommentLegacy() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#get-a-single-comment-legacy", - method: "GET", - params: { - comment_number: { required: true, type: "integer" }, - discussion_number: { required: true, type: "integer" }, - team_id: { required: true, type: "integer" } - }, - url: - "/teams/:team_id/discussions/:discussion_number/comments/:comment_number" - }, - getDiscussionInOrg: { - method: "GET", - params: { - discussion_number: { required: true, type: "integer" }, - org: { required: true, type: "string" }, - team_slug: { required: true, type: "string" } - }, - url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number" - }, - getDiscussionLegacy: { - deprecated: - "octokit.teams.getDiscussionLegacy() is deprecated, see https://developer.github.com/v3/teams/discussions/#get-a-single-discussion-legacy", - method: "GET", - params: { - discussion_number: { required: true, type: "integer" }, - team_id: { required: true, type: "integer" } - }, - url: "/teams/:team_id/discussions/:discussion_number" - }, - getLegacy: { - deprecated: - "octokit.teams.getLegacy() is deprecated, see https://developer.github.com/v3/teams/#get-team-legacy", - method: "GET", - params: { team_id: { required: true, type: "integer" } }, - url: "/teams/:team_id" - }, - getMember: { - deprecated: - "octokit.teams.getMember() has been renamed to octokit.teams.getMemberLegacy() (2020-01-16)", - method: "GET", - params: { - team_id: { required: true, type: "integer" }, - username: { required: true, type: "string" } - }, - url: "/teams/:team_id/members/:username" - }, - getMemberLegacy: { - deprecated: - "octokit.teams.getMemberLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#get-team-member-legacy", - method: "GET", - params: { - team_id: { required: true, type: "integer" }, - username: { required: true, type: "string" } - }, - url: "/teams/:team_id/members/:username" - }, - getMembership: { - deprecated: - "octokit.teams.getMembership() has been renamed to octokit.teams.getMembershipLegacy() (2020-01-16)", - method: "GET", - params: { - team_id: { required: true, type: "integer" }, - username: { required: true, type: "string" } - }, - url: "/teams/:team_id/memberships/:username" - }, - getMembershipInOrg: { - method: "GET", - params: { - org: { required: true, type: "string" }, - team_slug: { required: true, type: "string" }, - username: { required: true, type: "string" } - }, - url: "/orgs/:org/teams/:team_slug/memberships/:username" - }, - getMembershipLegacy: { - deprecated: - "octokit.teams.getMembershipLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#get-team-membership-legacy", - method: "GET", - params: { - team_id: { required: true, type: "integer" }, - username: { required: true, type: "string" } - }, - url: "/teams/:team_id/memberships/:username" - }, - list: { - method: "GET", - params: { - org: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" } - }, - url: "/orgs/:org/teams" - }, - listChild: { - deprecated: - "octokit.teams.listChild() has been renamed to octokit.teams.listChildLegacy() (2020-01-16)", - method: "GET", - params: { - page: { type: "integer" }, - per_page: { type: "integer" }, - team_id: { required: true, type: "integer" } - }, - url: "/teams/:team_id/teams" - }, - listChildInOrg: { - method: "GET", - params: { - org: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - team_slug: { required: true, type: "string" } - }, - url: "/orgs/:org/teams/:team_slug/teams" - }, - listChildLegacy: { - deprecated: - "octokit.teams.listChildLegacy() is deprecated, see https://developer.github.com/v3/teams/#list-child-teams-legacy", - method: "GET", - params: { - page: { type: "integer" }, - per_page: { type: "integer" }, - team_id: { required: true, type: "integer" } - }, - url: "/teams/:team_id/teams" - }, - listDiscussionComments: { - deprecated: - "octokit.teams.listDiscussionComments() has been renamed to octokit.teams.listDiscussionCommentsLegacy() (2020-01-16)", - method: "GET", - params: { - direction: { enum: ["asc", "desc"], type: "string" }, - discussion_number: { required: true, type: "integer" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - team_id: { required: true, type: "integer" } - }, - url: "/teams/:team_id/discussions/:discussion_number/comments" - }, - listDiscussionCommentsInOrg: { - method: "GET", - params: { - direction: { enum: ["asc", "desc"], type: "string" }, - discussion_number: { required: true, type: "integer" }, - org: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - team_slug: { required: true, type: "string" } - }, - url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments" - }, - listDiscussionCommentsLegacy: { - deprecated: - "octokit.teams.listDiscussionCommentsLegacy() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#list-comments-legacy", - method: "GET", - params: { - direction: { enum: ["asc", "desc"], type: "string" }, - discussion_number: { required: true, type: "integer" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - team_id: { required: true, type: "integer" } - }, - url: "/teams/:team_id/discussions/:discussion_number/comments" - }, - listDiscussions: { - deprecated: - "octokit.teams.listDiscussions() has been renamed to octokit.teams.listDiscussionsLegacy() (2020-01-16)", - method: "GET", - params: { - direction: { enum: ["asc", "desc"], type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - team_id: { required: true, type: "integer" } - }, - url: "/teams/:team_id/discussions" - }, - listDiscussionsInOrg: { - method: "GET", - params: { - direction: { enum: ["asc", "desc"], type: "string" }, - org: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - team_slug: { required: true, type: "string" } - }, - url: "/orgs/:org/teams/:team_slug/discussions" - }, - listDiscussionsLegacy: { - deprecated: - "octokit.teams.listDiscussionsLegacy() is deprecated, see https://developer.github.com/v3/teams/discussions/#list-discussions-legacy", - method: "GET", - params: { - direction: { enum: ["asc", "desc"], type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - team_id: { required: true, type: "integer" } - }, - url: "/teams/:team_id/discussions" - }, - listForAuthenticatedUser: { - method: "GET", - params: { page: { type: "integer" }, per_page: { type: "integer" } }, - url: "/user/teams" - }, - listMembers: { - deprecated: - "octokit.teams.listMembers() has been renamed to octokit.teams.listMembersLegacy() (2020-01-16)", - method: "GET", - params: { - page: { type: "integer" }, - per_page: { type: "integer" }, - role: { enum: ["member", "maintainer", "all"], type: "string" }, - team_id: { required: true, type: "integer" } - }, - url: "/teams/:team_id/members" - }, - listMembersInOrg: { - method: "GET", - params: { - org: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - role: { enum: ["member", "maintainer", "all"], type: "string" }, - team_slug: { required: true, type: "string" } - }, - url: "/orgs/:org/teams/:team_slug/members" - }, - listMembersLegacy: { - deprecated: - "octokit.teams.listMembersLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#list-team-members-legacy", - method: "GET", - params: { - page: { type: "integer" }, - per_page: { type: "integer" }, - role: { enum: ["member", "maintainer", "all"], type: "string" }, - team_id: { required: true, type: "integer" } - }, - url: "/teams/:team_id/members" - }, - listPendingInvitations: { - deprecated: - "octokit.teams.listPendingInvitations() has been renamed to octokit.teams.listPendingInvitationsLegacy() (2020-01-16)", - method: "GET", - params: { - page: { type: "integer" }, - per_page: { type: "integer" }, - team_id: { required: true, type: "integer" } - }, - url: "/teams/:team_id/invitations" - }, - listPendingInvitationsInOrg: { - method: "GET", - params: { - org: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - team_slug: { required: true, type: "string" } - }, - url: "/orgs/:org/teams/:team_slug/invitations" - }, - listPendingInvitationsLegacy: { - deprecated: - "octokit.teams.listPendingInvitationsLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#list-pending-team-invitations-legacy", - method: "GET", - params: { - page: { type: "integer" }, - per_page: { type: "integer" }, - team_id: { required: true, type: "integer" } - }, - url: "/teams/:team_id/invitations" - }, - listProjects: { - deprecated: - "octokit.teams.listProjects() has been renamed to octokit.teams.listProjectsLegacy() (2020-01-16)", - headers: { accept: "application/vnd.github.inertia-preview+json" }, - method: "GET", - params: { - page: { type: "integer" }, - per_page: { type: "integer" }, - team_id: { required: true, type: "integer" } - }, - url: "/teams/:team_id/projects" - }, - listProjectsInOrg: { - headers: { accept: "application/vnd.github.inertia-preview+json" }, - method: "GET", - params: { - org: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - team_slug: { required: true, type: "string" } - }, - url: "/orgs/:org/teams/:team_slug/projects" - }, - listProjectsLegacy: { - deprecated: - "octokit.teams.listProjectsLegacy() is deprecated, see https://developer.github.com/v3/teams/#list-team-projects-legacy", - headers: { accept: "application/vnd.github.inertia-preview+json" }, - method: "GET", - params: { - page: { type: "integer" }, - per_page: { type: "integer" }, - team_id: { required: true, type: "integer" } - }, - url: "/teams/:team_id/projects" - }, - listRepos: { - deprecated: - "octokit.teams.listRepos() has been renamed to octokit.teams.listReposLegacy() (2020-01-16)", - method: "GET", - params: { - page: { type: "integer" }, - per_page: { type: "integer" }, - team_id: { required: true, type: "integer" } - }, - url: "/teams/:team_id/repos" - }, - listReposInOrg: { - method: "GET", - params: { - org: { required: true, type: "string" }, - page: { type: "integer" }, - per_page: { type: "integer" }, - team_slug: { required: true, type: "string" } - }, - url: "/orgs/:org/teams/:team_slug/repos" - }, - listReposLegacy: { - deprecated: - "octokit.teams.listReposLegacy() is deprecated, see https://developer.github.com/v3/teams/#list-team-repos-legacy", - method: "GET", - params: { - page: { type: "integer" }, - per_page: { type: "integer" }, - team_id: { required: true, type: "integer" } - }, - url: "/teams/:team_id/repos" - }, - removeMember: { - deprecated: - "octokit.teams.removeMember() has been renamed to octokit.teams.removeMemberLegacy() (2020-01-16)", - method: "DELETE", - params: { - team_id: { required: true, type: "integer" }, - username: { required: true, type: "string" } - }, - url: "/teams/:team_id/members/:username" - }, - removeMemberLegacy: { - deprecated: - "octokit.teams.removeMemberLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#remove-team-member-legacy", - method: "DELETE", - params: { - team_id: { required: true, type: "integer" }, - username: { required: true, type: "string" } - }, - url: "/teams/:team_id/members/:username" - }, - removeMembership: { - deprecated: - "octokit.teams.removeMembership() has been renamed to octokit.teams.removeMembershipLegacy() (2020-01-16)", - method: "DELETE", - params: { - team_id: { required: true, type: "integer" }, - username: { required: true, type: "string" } - }, - url: "/teams/:team_id/memberships/:username" - }, - removeMembershipInOrg: { - method: "DELETE", - params: { - org: { required: true, type: "string" }, - team_slug: { required: true, type: "string" }, - username: { required: true, type: "string" } - }, - url: "/orgs/:org/teams/:team_slug/memberships/:username" - }, - removeMembershipLegacy: { - deprecated: - "octokit.teams.removeMembershipLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#remove-team-membership-legacy", - method: "DELETE", - params: { - team_id: { required: true, type: "integer" }, - username: { required: true, type: "string" } - }, - url: "/teams/:team_id/memberships/:username" - }, - removeProject: { - deprecated: - "octokit.teams.removeProject() has been renamed to octokit.teams.removeProjectLegacy() (2020-01-16)", - method: "DELETE", - params: { - project_id: { required: true, type: "integer" }, - team_id: { required: true, type: "integer" } - }, - url: "/teams/:team_id/projects/:project_id" - }, - removeProjectInOrg: { - method: "DELETE", - params: { - org: { required: true, type: "string" }, - project_id: { required: true, type: "integer" }, - team_slug: { required: true, type: "string" } - }, - url: "/orgs/:org/teams/:team_slug/projects/:project_id" - }, - removeProjectLegacy: { - deprecated: - "octokit.teams.removeProjectLegacy() is deprecated, see https://developer.github.com/v3/teams/#remove-team-project-legacy", - method: "DELETE", - params: { - project_id: { required: true, type: "integer" }, - team_id: { required: true, type: "integer" } - }, - url: "/teams/:team_id/projects/:project_id" - }, - removeRepo: { - deprecated: - "octokit.teams.removeRepo() has been renamed to octokit.teams.removeRepoLegacy() (2020-01-16)", - method: "DELETE", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" }, - team_id: { required: true, type: "integer" } - }, - url: "/teams/:team_id/repos/:owner/:repo" - }, - removeRepoInOrg: { - method: "DELETE", - params: { - org: { required: true, type: "string" }, - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" }, - team_slug: { required: true, type: "string" } - }, - url: "/orgs/:org/teams/:team_slug/repos/:owner/:repo" - }, - removeRepoLegacy: { - deprecated: - "octokit.teams.removeRepoLegacy() is deprecated, see https://developer.github.com/v3/teams/#remove-team-repository-legacy", - method: "DELETE", - params: { - owner: { required: true, type: "string" }, - repo: { required: true, type: "string" }, - team_id: { required: true, type: "integer" } - }, - url: "/teams/:team_id/repos/:owner/:repo" - }, - reviewProject: { - deprecated: - "octokit.teams.reviewProject() has been renamed to octokit.teams.reviewProjectLegacy() (2020-01-16)", - headers: { accept: "application/vnd.github.inertia-preview+json" }, - method: "GET", - params: { - project_id: { required: true, type: "integer" }, - team_id: { required: true, type: "integer" } - }, - url: "/teams/:team_id/projects/:project_id" - }, - reviewProjectInOrg: { - headers: { accept: "application/vnd.github.inertia-preview+json" }, - method: "GET", - params: { - org: { required: true, type: "string" }, - project_id: { required: true, type: "integer" }, - team_slug: { required: true, type: "string" } - }, - url: "/orgs/:org/teams/:team_slug/projects/:project_id" - }, - reviewProjectLegacy: { - deprecated: - "octokit.teams.reviewProjectLegacy() is deprecated, see https://developer.github.com/v3/teams/#review-a-team-project-legacy", - headers: { accept: "application/vnd.github.inertia-preview+json" }, - method: "GET", - params: { - project_id: { required: true, type: "integer" }, - team_id: { required: true, type: "integer" } - }, - url: "/teams/:team_id/projects/:project_id" - }, - update: { - deprecated: - "octokit.teams.update() has been renamed to octokit.teams.updateLegacy() (2020-01-16)", - method: "PATCH", - params: { - description: { type: "string" }, - name: { required: true, type: "string" }, - parent_team_id: { type: "integer" }, - permission: { enum: ["pull", "push", "admin"], type: "string" }, - privacy: { enum: ["secret", "closed"], type: "string" }, - team_id: { required: true, type: "integer" } - }, - url: "/teams/:team_id" - }, - updateDiscussion: { - deprecated: - "octokit.teams.updateDiscussion() has been renamed to octokit.teams.updateDiscussionLegacy() (2020-01-16)", - method: "PATCH", - params: { - body: { type: "string" }, - discussion_number: { required: true, type: "integer" }, - team_id: { required: true, type: "integer" }, - title: { type: "string" } - }, - url: "/teams/:team_id/discussions/:discussion_number" - }, - updateDiscussionComment: { - deprecated: - "octokit.teams.updateDiscussionComment() has been renamed to octokit.teams.updateDiscussionCommentLegacy() (2020-01-16)", - method: "PATCH", - params: { - body: { required: true, type: "string" }, - comment_number: { required: true, type: "integer" }, - discussion_number: { required: true, type: "integer" }, - team_id: { required: true, type: "integer" } - }, - url: - "/teams/:team_id/discussions/:discussion_number/comments/:comment_number" - }, - updateDiscussionCommentInOrg: { - method: "PATCH", - params: { - body: { required: true, type: "string" }, - comment_number: { required: true, type: "integer" }, - discussion_number: { required: true, type: "integer" }, - org: { required: true, type: "string" }, - team_slug: { required: true, type: "string" } - }, - url: - "/orgs/:org/teams/:team_slug/discussions/:discussion_number/comments/:comment_number" - }, - updateDiscussionCommentLegacy: { - deprecated: - "octokit.teams.updateDiscussionCommentLegacy() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#edit-a-comment-legacy", - method: "PATCH", - params: { - body: { required: true, type: "string" }, - comment_number: { required: true, type: "integer" }, - discussion_number: { required: true, type: "integer" }, - team_id: { required: true, type: "integer" } - }, - url: - "/teams/:team_id/discussions/:discussion_number/comments/:comment_number" - }, - updateDiscussionInOrg: { - method: "PATCH", - params: { - body: { type: "string" }, - discussion_number: { required: true, type: "integer" }, - org: { required: true, type: "string" }, - team_slug: { required: true, type: "string" }, - title: { type: "string" } - }, - url: "/orgs/:org/teams/:team_slug/discussions/:discussion_number" - }, - updateDiscussionLegacy: { - deprecated: - "octokit.teams.updateDiscussionLegacy() is deprecated, see https://developer.github.com/v3/teams/discussions/#edit-a-discussion-legacy", - method: "PATCH", - params: { - body: { type: "string" }, - discussion_number: { required: true, type: "integer" }, - team_id: { required: true, type: "integer" }, - title: { type: "string" } - }, - url: "/teams/:team_id/discussions/:discussion_number" - }, - updateInOrg: { - method: "PATCH", - params: { - description: { type: "string" }, - name: { required: true, type: "string" }, - org: { required: true, type: "string" }, - parent_team_id: { type: "integer" }, - permission: { enum: ["pull", "push", "admin"], type: "string" }, - privacy: { enum: ["secret", "closed"], type: "string" }, - team_slug: { required: true, type: "string" } - }, - url: "/orgs/:org/teams/:team_slug" - }, - updateLegacy: { - deprecated: - "octokit.teams.updateLegacy() is deprecated, see https://developer.github.com/v3/teams/#edit-team-legacy", - method: "PATCH", - params: { - description: { type: "string" }, - name: { required: true, type: "string" }, - parent_team_id: { type: "integer" }, - permission: { enum: ["pull", "push", "admin"], type: "string" }, - privacy: { enum: ["secret", "closed"], type: "string" }, - team_id: { required: true, type: "integer" } - }, - url: "/teams/:team_id" - } + addOrUpdateMembershipInOrg: [ + "PUT /orgs/{org}/teams/{team_slug}/memberships/{username}" + ], + addOrUpdateProjectInOrg: [ + "PUT /orgs/{org}/teams/{team_slug}/projects/{project_id}", + { mediaType: { previews: ["inertia"] } } + ], + addOrUpdateRepoInOrg: [ + "PUT /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}" + ], + checkManagesRepoInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}" + ], + create: ["POST /orgs/{org}/teams"], + createDiscussionCommentInOrg: [ + "POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments" + ], + createDiscussionInOrg: ["POST /orgs/{org}/teams/{team_slug}/discussions"], + deleteDiscussionCommentInOrg: [ + "DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}" + ], + deleteDiscussionInOrg: [ + "DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}" + ], + deleteInOrg: ["DELETE /orgs/{org}/teams/{team_slug}"], + getByName: ["GET /orgs/{org}/teams/{team_slug}"], + getDiscussionCommentInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}" + ], + getDiscussionInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}" + ], + getMembershipInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/memberships/{username}" + ], + list: ["GET /orgs/{org}/teams"], + listChildInOrg: ["GET /orgs/{org}/teams/{team_slug}/teams"], + listDiscussionCommentsInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments" + ], + listDiscussionsInOrg: ["GET /orgs/{org}/teams/{team_slug}/discussions"], + listForAuthenticatedUser: ["GET /user/teams"], + listMembersInOrg: ["GET /orgs/{org}/teams/{team_slug}/members"], + listPendingInvitationsInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/invitations" + ], + listProjectsInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/projects", + { mediaType: { previews: ["inertia"] } } + ], + listReposInOrg: ["GET /orgs/{org}/teams/{team_slug}/repos"], + removeMembershipInOrg: [ + "DELETE /orgs/{org}/teams/{team_slug}/memberships/{username}" + ], + removeProjectInOrg: [ + "DELETE /orgs/{org}/teams/{team_slug}/projects/{project_id}" + ], + removeRepoInOrg: [ + "DELETE /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}" + ], + reviewProjectInOrg: [ + "GET /orgs/{org}/teams/{team_slug}/projects/{project_id}", + { mediaType: { previews: ["inertia"] } } + ], + updateDiscussionCommentInOrg: [ + "PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}" + ], + updateDiscussionInOrg: [ + "PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}" + ], + updateInOrg: ["PATCH /orgs/{org}/teams/{team_slug}"] }, users: { - addEmails: { - method: "POST", - params: { emails: { required: true, type: "string[]" } }, - url: "/user/emails" - }, - block: { - method: "PUT", - params: { username: { required: true, type: "string" } }, - url: "/user/blocks/:username" - }, - checkBlocked: { - method: "GET", - params: { username: { required: true, type: "string" } }, - url: "/user/blocks/:username" - }, - checkFollowing: { - method: "GET", - params: { username: { required: true, type: "string" } }, - url: "/user/following/:username" - }, - checkFollowingForUser: { - method: "GET", - params: { - target_user: { required: true, type: "string" }, - username: { required: true, type: "string" } - }, - url: "/users/:username/following/:target_user" - }, - createGpgKey: { - method: "POST", - params: { armored_public_key: { type: "string" } }, - url: "/user/gpg_keys" - }, - createPublicKey: { - method: "POST", - params: { key: { type: "string" }, title: { type: "string" } }, - url: "/user/keys" - }, - deleteEmails: { - method: "DELETE", - params: { emails: { required: true, type: "string[]" } }, - url: "/user/emails" - }, - deleteGpgKey: { - method: "DELETE", - params: { gpg_key_id: { required: true, type: "integer" } }, - url: "/user/gpg_keys/:gpg_key_id" - }, - deletePublicKey: { - method: "DELETE", - params: { key_id: { required: true, type: "integer" } }, - url: "/user/keys/:key_id" - }, - follow: { - method: "PUT", - params: { username: { required: true, type: "string" } }, - url: "/user/following/:username" - }, - getAuthenticated: { method: "GET", params: {}, url: "/user" }, - getByUsername: { - method: "GET", - params: { username: { required: true, type: "string" } }, - url: "/users/:username" - }, - getContextForUser: { - method: "GET", - params: { - subject_id: { type: "string" }, - subject_type: { - enum: ["organization", "repository", "issue", "pull_request"], - type: "string" - }, - username: { required: true, type: "string" } - }, - url: "/users/:username/hovercard" - }, - getGpgKey: { - method: "GET", - params: { gpg_key_id: { required: true, type: "integer" } }, - url: "/user/gpg_keys/:gpg_key_id" - }, - getPublicKey: { - method: "GET", - params: { key_id: { required: true, type: "integer" } }, - url: "/user/keys/:key_id" - }, - list: { - method: "GET", - params: { - page: { type: "integer" }, - per_page: { type: "integer" }, - since: { type: "string" } - }, - url: "/users" - }, - listBlocked: { method: "GET", params: {}, url: "/user/blocks" }, - listEmails: { - method: "GET", - params: { page: { type: "integer" }, per_page: { type: "integer" } }, - url: "/user/emails" - }, - listFollowersForAuthenticatedUser: { - method: "GET", - params: { page: { type: "integer" }, per_page: { type: "integer" } }, - url: "/user/followers" - }, - listFollowersForUser: { - method: "GET", - params: { - page: { type: "integer" }, - per_page: { type: "integer" }, - username: { required: true, type: "string" } - }, - url: "/users/:username/followers" - }, - listFollowingForAuthenticatedUser: { - method: "GET", - params: { page: { type: "integer" }, per_page: { type: "integer" } }, - url: "/user/following" - }, - listFollowingForUser: { - method: "GET", - params: { - page: { type: "integer" }, - per_page: { type: "integer" }, - username: { required: true, type: "string" } - }, - url: "/users/:username/following" - }, - listGpgKeys: { - method: "GET", - params: { page: { type: "integer" }, per_page: { type: "integer" } }, - url: "/user/gpg_keys" - }, - listGpgKeysForUser: { - method: "GET", - params: { - page: { type: "integer" }, - per_page: { type: "integer" }, - username: { required: true, type: "string" } - }, - url: "/users/:username/gpg_keys" - }, - listPublicEmails: { - method: "GET", - params: { page: { type: "integer" }, per_page: { type: "integer" } }, - url: "/user/public_emails" - }, - listPublicKeys: { - method: "GET", - params: { page: { type: "integer" }, per_page: { type: "integer" } }, - url: "/user/keys" - }, - listPublicKeysForUser: { - method: "GET", - params: { - page: { type: "integer" }, - per_page: { type: "integer" }, - username: { required: true, type: "string" } - }, - url: "/users/:username/keys" - }, - togglePrimaryEmailVisibility: { - method: "PATCH", - params: { - email: { required: true, type: "string" }, - visibility: { required: true, type: "string" } - }, - url: "/user/email/visibility" - }, - unblock: { - method: "DELETE", - params: { username: { required: true, type: "string" } }, - url: "/user/blocks/:username" - }, - unfollow: { - method: "DELETE", - params: { username: { required: true, type: "string" } }, - url: "/user/following/:username" - }, - updateAuthenticated: { - method: "PATCH", - params: { - bio: { type: "string" }, - blog: { type: "string" }, - company: { type: "string" }, - email: { type: "string" }, - hireable: { type: "boolean" }, - location: { type: "string" }, - name: { type: "string" } - }, - url: "/user" - } + addEmails: ["POST /user/emails"], + block: ["PUT /user/blocks/{username}"], + checkBlocked: ["GET /user/blocks/{username}"], + checkFollowing: ["GET /user/following/{username}"], + checkFollowingForUser: ["GET /users/{username}/following/{target_user}"], + createGpgKey: ["POST /user/gpg_keys"], + createPublicKey: ["POST /user/keys"], + deleteEmails: ["DELETE /user/emails"], + deleteGpgKey: ["DELETE /user/gpg_keys/{gpg_key_id}"], + deletePublicKey: ["DELETE /user/keys/{key_id}"], + follow: ["PUT /user/following/{username}"], + getAuthenticated: ["GET /user"], + getByUsername: ["GET /users/{username}"], + getContextForUser: ["GET /users/{username}/hovercard"], + getGpgKey: ["GET /user/gpg_keys/{gpg_key_id}"], + getPublicKey: ["GET /user/keys/{key_id}"], + list: ["GET /users"], + listBlocked: ["GET /user/blocks"], + listEmails: ["GET /user/emails"], + listFollowersForAuthenticatedUser: ["GET /user/followers"], + listFollowersForUser: ["GET /users/{username}/followers"], + listFollowingForAuthenticatedUser: ["GET /user/following"], + listFollowingForUser: ["GET /users/{username}/following"], + listGpgKeys: ["GET /user/gpg_keys"], + listGpgKeysForUser: ["GET /users/{username}/gpg_keys"], + listPublicEmails: ["GET /user/public_emails"], + listPublicKeys: ["GET /user/keys"], + listPublicKeysForUser: ["GET /users/{username}/keys"], + togglePrimaryEmailVisibility: ["PATCH /user/email/visibility"], + unblock: ["DELETE /user/blocks/{username}"], + unfollow: ["DELETE /user/following/{username}"], + updateAuthenticated: ["PATCH /user"] } }; + +export default Endpoints; diff --git a/src/generated/rest-endpoint-methods-types.ts b/src/generated/types.ts similarity index 78% rename from src/generated/rest-endpoint-methods-types.ts rename to src/generated/types.ts index e8280f079..bebbb97ca 100644 --- a/src/generated/rest-endpoint-methods-types.ts +++ b/src/generated/types.ts @@ -417,54 +417,6 @@ type UsersAddEmailsResponseItem = { verified: boolean; visibility: string | null; }; -type TeamsUpdateLegacyResponseOrganization = { - avatar_url: string; - blog: string; - company: string; - created_at: string; - description: string; - email: string; - events_url: string; - followers: number; - following: number; - has_organization_projects: boolean; - has_repository_projects: boolean; - hooks_url: string; - html_url: string; - id: number; - is_verified: boolean; - issues_url: string; - location: string; - login: string; - members_url: string; - name: string; - node_id: string; - public_gists: number; - public_members_url: string; - public_repos: number; - repos_url: string; - type: string; - url: string; -}; -type TeamsUpdateLegacyResponse = { - created_at: string; - description: string; - html_url: string; - id: number; - members_count: number; - members_url: string; - name: string; - node_id: string; - organization: TeamsUpdateLegacyResponseOrganization; - parent: null; - permission: string; - privacy: string; - repos_count: number; - repositories_url: string; - slug: string; - updated_at: string; - url: string; -}; type TeamsUpdateInOrgResponseOrganization = { avatar_url: string; blog: string; @@ -513,7 +465,7 @@ type TeamsUpdateInOrgResponse = { updated_at: string; url: string; }; -type TeamsUpdateDiscussionLegacyResponseReactions = { +type TeamsUpdateDiscussionInOrgResponseReactions = { "+1": number; "-1": number; confused: number; @@ -523,7 +475,7 @@ type TeamsUpdateDiscussionLegacyResponseReactions = { total_count: number; url: string; }; -type TeamsUpdateDiscussionLegacyResponseAuthor = { +type TeamsUpdateDiscussionInOrgResponseAuthor = { avatar_url: string; events_url: string; followers_url: string; @@ -543,8 +495,8 @@ type TeamsUpdateDiscussionLegacyResponseAuthor = { type: string; url: string; }; -type TeamsUpdateDiscussionLegacyResponse = { - author: TeamsUpdateDiscussionLegacyResponseAuthor; +type TeamsUpdateDiscussionInOrgResponse = { + author: TeamsUpdateDiscussionInOrgResponseAuthor; body: string; body_html: string; body_version: string; @@ -557,13 +509,13 @@ type TeamsUpdateDiscussionLegacyResponse = { number: number; pinned: boolean; private: boolean; - reactions: TeamsUpdateDiscussionLegacyResponseReactions; + reactions: TeamsUpdateDiscussionInOrgResponseReactions; team_url: string; title: string; updated_at: string; url: string; }; -type TeamsUpdateDiscussionInOrgResponseReactions = { +type TeamsUpdateDiscussionCommentInOrgResponseReactions = { "+1": number; "-1": number; confused: number; @@ -573,7 +525,7 @@ type TeamsUpdateDiscussionInOrgResponseReactions = { total_count: number; url: string; }; -type TeamsUpdateDiscussionInOrgResponseAuthor = { +type TeamsUpdateDiscussionCommentInOrgResponseAuthor = { avatar_url: string; events_url: string; followers_url: string; @@ -593,37 +545,27 @@ type TeamsUpdateDiscussionInOrgResponseAuthor = { type: string; url: string; }; -type TeamsUpdateDiscussionInOrgResponse = { - author: TeamsUpdateDiscussionInOrgResponseAuthor; +type TeamsUpdateDiscussionCommentInOrgResponse = { + author: TeamsUpdateDiscussionCommentInOrgResponseAuthor; body: string; body_html: string; body_version: string; - comments_count: number; - comments_url: string; created_at: string; + discussion_url: string; html_url: string; last_edited_at: string; node_id: string; number: number; - pinned: boolean; - private: boolean; - reactions: TeamsUpdateDiscussionInOrgResponseReactions; - team_url: string; - title: string; + reactions: TeamsUpdateDiscussionCommentInOrgResponseReactions; updated_at: string; url: string; }; -type TeamsUpdateDiscussionCommentLegacyResponseReactions = { - "+1": number; - "-1": number; - confused: number; - heart: number; - hooray: number; - laugh: number; - total_count: number; - url: string; +type TeamsReviewProjectInOrgResponsePermissions = { + admin: boolean; + read: boolean; + write: boolean; }; -type TeamsUpdateDiscussionCommentLegacyResponseAuthor = { +type TeamsReviewProjectInOrgResponseCreator = { avatar_url: string; events_url: string; followers_url: string; @@ -643,32 +585,30 @@ type TeamsUpdateDiscussionCommentLegacyResponseAuthor = { type: string; url: string; }; -type TeamsUpdateDiscussionCommentLegacyResponse = { - author: TeamsUpdateDiscussionCommentLegacyResponseAuthor; +type TeamsReviewProjectInOrgResponse = { body: string; - body_html: string; - body_version: string; + columns_url: string; created_at: string; - discussion_url: string; + creator: TeamsReviewProjectInOrgResponseCreator; html_url: string; - last_edited_at: string; + id: number; + name: string; node_id: string; number: number; - reactions: TeamsUpdateDiscussionCommentLegacyResponseReactions; + organization_permission: string; + owner_url: string; + permissions: TeamsReviewProjectInOrgResponsePermissions; + private: boolean; + state: string; updated_at: string; url: string; }; -type TeamsUpdateDiscussionCommentInOrgResponseReactions = { - "+1": number; - "-1": number; - confused: number; - heart: number; - hooray: number; - laugh: number; - total_count: number; - url: string; +type TeamsListReposInOrgResponseItemPermissions = { + admin: boolean; + pull: boolean; + push: boolean; }; -type TeamsUpdateDiscussionCommentInOrgResponseAuthor = { +type TeamsListReposInOrgResponseItemOwner = { avatar_url: string; events_url: string; followers_url: string; @@ -688,32 +628,99 @@ type TeamsUpdateDiscussionCommentInOrgResponseAuthor = { type: string; url: string; }; -type TeamsUpdateDiscussionCommentInOrgResponse = { - author: TeamsUpdateDiscussionCommentInOrgResponseAuthor; - body: string; - body_html: string; - body_version: string; +type TeamsListReposInOrgResponseItemLicense = { + key: string; + name: string; + node_id: string; + spdx_id: string; + url: string; +}; +type TeamsListReposInOrgResponseItem = { + archive_url: string; + archived: boolean; + assignees_url: string; + blobs_url: string; + branches_url: string; + clone_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; created_at: string; - discussion_url: string; + default_branch: string; + deployments_url: string; + description: string; + disabled: boolean; + downloads_url: string; + events_url: string; + fork: boolean; + forks_count: number; + forks_url: string; + full_name: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + has_downloads: boolean; + has_issues: boolean; + has_pages: boolean; + has_projects: boolean; + has_wiki: boolean; + homepage: string; + hooks_url: string; html_url: string; - last_edited_at: string; + id: number; + is_template: boolean; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + language: null; + languages_url: string; + license: TeamsListReposInOrgResponseItemLicense; + merges_url: string; + milestones_url: string; + mirror_url: string; + name: string; + network_count: number; node_id: string; - number: number; - reactions: TeamsUpdateDiscussionCommentInOrgResponseReactions; + notifications_url: string; + open_issues_count: number; + owner: TeamsListReposInOrgResponseItemOwner; + permissions: TeamsListReposInOrgResponseItemPermissions; + private: boolean; + pulls_url: string; + pushed_at: string; + releases_url: string; + size: number; + ssh_url: string; + stargazers_count: number; + stargazers_url: string; + statuses_url: string; + subscribers_count: number; + subscribers_url: string; + subscription_url: string; + svn_url: string; + tags_url: string; + teams_url: string; + temp_clone_token: string; + template_repository: null; + topics: Array; + trees_url: string; updated_at: string; url: string; + visibility: string; + watchers_count: number; }; -type TeamsUpdateDiscussionCommentResponseReactions = { - "+1": number; - "-1": number; - confused: number; - heart: number; - hooray: number; - laugh: number; - total_count: number; - url: string; +type TeamsListProjectsInOrgResponseItemPermissions = { + admin: boolean; + read: boolean; + write: boolean; }; -type TeamsUpdateDiscussionCommentResponseAuthor = { +type TeamsListProjectsInOrgResponseItemCreator = { avatar_url: string; events_url: string; followers_url: string; @@ -733,32 +740,25 @@ type TeamsUpdateDiscussionCommentResponseAuthor = { type: string; url: string; }; -type TeamsUpdateDiscussionCommentResponse = { - author: TeamsUpdateDiscussionCommentResponseAuthor; +type TeamsListProjectsInOrgResponseItem = { body: string; - body_html: string; - body_version: string; + columns_url: string; created_at: string; - discussion_url: string; + creator: TeamsListProjectsInOrgResponseItemCreator; html_url: string; - last_edited_at: string; + id: number; + name: string; node_id: string; number: number; - reactions: TeamsUpdateDiscussionCommentResponseReactions; + organization_permission: string; + owner_url: string; + permissions: TeamsListProjectsInOrgResponseItemPermissions; + private: boolean; + state: string; updated_at: string; url: string; }; -type TeamsUpdateDiscussionResponseReactions = { - "+1": number; - "-1": number; - confused: number; - heart: number; - hooray: number; - laugh: number; - total_count: number; - url: string; -}; -type TeamsUpdateDiscussionResponseAuthor = { +type TeamsListPendingInvitationsInOrgResponseItemInviter = { avatar_url: string; events_url: string; followers_url: string; @@ -778,27 +778,37 @@ type TeamsUpdateDiscussionResponseAuthor = { type: string; url: string; }; -type TeamsUpdateDiscussionResponse = { - author: TeamsUpdateDiscussionResponseAuthor; - body: string; - body_html: string; - body_version: string; - comments_count: number; - comments_url: string; +type TeamsListPendingInvitationsInOrgResponseItem = { created_at: string; + email: string; + id: number; + invitation_team_url: string; + inviter: TeamsListPendingInvitationsInOrgResponseItemInviter; + login: string; + role: string; + team_count: number; +}; +type TeamsListMembersInOrgResponseItem = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; html_url: string; - last_edited_at: string; + id: number; + login: string; node_id: string; - number: number; - pinned: boolean; - private: boolean; - reactions: TeamsUpdateDiscussionResponseReactions; - team_url: string; - title: string; - updated_at: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; url: string; }; -type TeamsUpdateResponseOrganization = { +type TeamsListForAuthenticatedUserResponseItemOrganization = { avatar_url: string; blog: string; company: string; @@ -827,7 +837,7 @@ type TeamsUpdateResponseOrganization = { type: string; url: string; }; -type TeamsUpdateResponse = { +type TeamsListForAuthenticatedUserResponseItem = { created_at: string; description: string; html_url: string; @@ -836,7 +846,7 @@ type TeamsUpdateResponse = { members_url: string; name: string; node_id: string; - organization: TeamsUpdateResponseOrganization; + organization: TeamsListForAuthenticatedUserResponseItemOrganization; parent: null; permission: string; privacy: string; @@ -846,12 +856,17 @@ type TeamsUpdateResponse = { updated_at: string; url: string; }; -type TeamsReviewProjectLegacyResponsePermissions = { - admin: boolean; - read: boolean; - write: boolean; +type TeamsListDiscussionsInOrgResponseItemReactions = { + "+1": number; + "-1": number; + confused: number; + heart: number; + hooray: number; + laugh: number; + total_count: number; + url: string; }; -type TeamsReviewProjectLegacyResponseCreator = { +type TeamsListDiscussionsInOrgResponseItemAuthor = { avatar_url: string; events_url: string; followers_url: string; @@ -871,30 +886,37 @@ type TeamsReviewProjectLegacyResponseCreator = { type: string; url: string; }; -type TeamsReviewProjectLegacyResponse = { +type TeamsListDiscussionsInOrgResponseItem = { + author: TeamsListDiscussionsInOrgResponseItemAuthor; body: string; - columns_url: string; + body_html: string; + body_version: string; + comments_count: number; + comments_url: string; created_at: string; - creator: TeamsReviewProjectLegacyResponseCreator; html_url: string; - id: number; - name: string; + last_edited_at: null; node_id: string; number: number; - organization_permission: string; - owner_url: string; - permissions: TeamsReviewProjectLegacyResponsePermissions; + pinned: boolean; private: boolean; - state: string; + reactions: TeamsListDiscussionsInOrgResponseItemReactions; + team_url: string; + title: string; updated_at: string; url: string; }; -type TeamsReviewProjectInOrgResponsePermissions = { - admin: boolean; - read: boolean; - write: boolean; +type TeamsListDiscussionCommentsInOrgResponseItemReactions = { + "+1": number; + "-1": number; + confused: number; + heart: number; + hooray: number; + laugh: number; + total_count: number; + url: string; }; -type TeamsReviewProjectInOrgResponseCreator = { +type TeamsListDiscussionCommentsInOrgResponseItemAuthor = { avatar_url: string; events_url: string; followers_url: string; @@ -914,30 +936,77 @@ type TeamsReviewProjectInOrgResponseCreator = { type: string; url: string; }; -type TeamsReviewProjectInOrgResponse = { +type TeamsListDiscussionCommentsInOrgResponseItem = { + author: TeamsListDiscussionCommentsInOrgResponseItemAuthor; body: string; - columns_url: string; + body_html: string; + body_version: string; created_at: string; - creator: TeamsReviewProjectInOrgResponseCreator; + discussion_url: string; + html_url: string; + last_edited_at: null; + node_id: string; + number: number; + reactions: TeamsListDiscussionCommentsInOrgResponseItemReactions; + updated_at: string; + url: string; +}; +type TeamsListChildInOrgResponseItemParent = { + description: string; html_url: string; id: number; + members_url: string; name: string; node_id: string; - number: number; - organization_permission: string; - owner_url: string; - permissions: TeamsReviewProjectInOrgResponsePermissions; - private: boolean; + permission: string; + privacy: string; + repositories_url: string; + slug: string; + url: string; +}; +type TeamsListChildInOrgResponseItem = { + description: string; + id: number; + members_url: string; + name: string; + node_id: string; + parent: TeamsListChildInOrgResponseItemParent; + permission: string; + privacy: string; + repositories_url: string; + slug: string; + url: string; +}; +type TeamsListResponseItem = { + description: string; + html_url: string; + id: number; + members_url: string; + name: string; + node_id: string; + parent: null; + permission: string; + privacy: string; + repositories_url: string; + slug: string; + url: string; +}; +type TeamsGetMembershipInOrgResponse = { + role: string; state: string; - updated_at: string; url: string; }; -type TeamsReviewProjectResponsePermissions = { - admin: boolean; - read: boolean; - write: boolean; +type TeamsGetDiscussionInOrgResponseReactions = { + "+1": number; + "-1": number; + confused: number; + heart: number; + hooray: number; + laugh: number; + total_count: number; + url: string; }; -type TeamsReviewProjectResponseCreator = { +type TeamsGetDiscussionInOrgResponseAuthor = { avatar_url: string; events_url: string; followers_url: string; @@ -957,30 +1026,37 @@ type TeamsReviewProjectResponseCreator = { type: string; url: string; }; -type TeamsReviewProjectResponse = { +type TeamsGetDiscussionInOrgResponse = { + author: TeamsGetDiscussionInOrgResponseAuthor; body: string; - columns_url: string; + body_html: string; + body_version: string; + comments_count: number; + comments_url: string; created_at: string; - creator: TeamsReviewProjectResponseCreator; html_url: string; - id: number; - name: string; + last_edited_at: null; node_id: string; number: number; - organization_permission: string; - owner_url: string; - permissions: TeamsReviewProjectResponsePermissions; + pinned: boolean; private: boolean; - state: string; + reactions: TeamsGetDiscussionInOrgResponseReactions; + team_url: string; + title: string; updated_at: string; url: string; }; -type TeamsListReposLegacyResponseItemPermissions = { - admin: boolean; - pull: boolean; - push: boolean; +type TeamsGetDiscussionCommentInOrgResponseReactions = { + "+1": number; + "-1": number; + confused: number; + heart: number; + hooray: number; + laugh: number; + total_count: number; + url: string; }; -type TeamsListReposLegacyResponseItemOwner = { +type TeamsGetDiscussionCommentInOrgResponseAuthor = { avatar_url: string; events_url: string; followers_url: string; @@ -1000,99 +1076,80 @@ type TeamsListReposLegacyResponseItemOwner = { type: string; url: string; }; -type TeamsListReposLegacyResponseItemLicense = { - key: string; - name: string; +type TeamsGetDiscussionCommentInOrgResponse = { + author: TeamsGetDiscussionCommentInOrgResponseAuthor; + body: string; + body_html: string; + body_version: string; + created_at: string; + discussion_url: string; + html_url: string; + last_edited_at: null; node_id: string; - spdx_id: string; + number: number; + reactions: TeamsGetDiscussionCommentInOrgResponseReactions; + updated_at: string; url: string; }; -type TeamsListReposLegacyResponseItem = { - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; +type TeamsGetByNameResponseOrganization = { + avatar_url: string; + blog: string; + company: string; created_at: string; - default_branch: string; - deployments_url: string; description: string; - disabled: boolean; - downloads_url: string; + email: string; events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; + followers: number; + following: number; + has_organization_projects: boolean; + has_repository_projects: boolean; hooks_url: string; html_url: string; id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; + is_verified: boolean; issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - license: TeamsListReposLegacyResponseItemLicense; - merges_url: string; - milestones_url: string; - mirror_url: string; + location: string; + login: string; + members_url: string; name: string; - network_count: number; node_id: string; - notifications_url: string; - open_issues_count: number; - owner: TeamsListReposLegacyResponseItemOwner; - permissions: TeamsListReposLegacyResponseItemPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - temp_clone_token: string; - template_repository: null; - topics: Array; - trees_url: string; + public_gists: number; + public_members_url: string; + public_repos: number; + repos_url: string; + type: string; + url: string; +}; +type TeamsGetByNameResponse = { + created_at: string; + description: string; + html_url: string; + id: number; + members_count: number; + members_url: string; + name: string; + node_id: string; + organization: TeamsGetByNameResponseOrganization; + parent: null; + permission: string; + privacy: string; + repos_count: number; + repositories_url: string; + slug: string; updated_at: string; url: string; - visibility: string; - watchers_count: number; }; -type TeamsListReposInOrgResponseItemPermissions = { - admin: boolean; - pull: boolean; - push: boolean; +type TeamsCreateDiscussionInOrgResponseReactions = { + "+1": number; + "-1": number; + confused: number; + heart: number; + hooray: number; + laugh: number; + total_count: number; + url: string; }; -type TeamsListReposInOrgResponseItemOwner = { +type TeamsCreateDiscussionInOrgResponseAuthor = { avatar_url: string; events_url: string; followers_url: string; @@ -1112,99 +1169,125 @@ type TeamsListReposInOrgResponseItemOwner = { type: string; url: string; }; -type TeamsListReposInOrgResponseItemLicense = { - key: string; - name: string; +type TeamsCreateDiscussionInOrgResponse = { + author: TeamsCreateDiscussionInOrgResponseAuthor; + body: string; + body_html: string; + body_version: string; + comments_count: number; + comments_url: string; + created_at: string; + html_url: string; + last_edited_at: null; node_id: string; - spdx_id: string; + number: number; + pinned: boolean; + private: boolean; + reactions: TeamsCreateDiscussionInOrgResponseReactions; + team_url: string; + title: string; + updated_at: string; url: string; }; -type TeamsListReposInOrgResponseItem = { - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; +type TeamsCreateDiscussionCommentInOrgResponseReactions = { + "+1": number; + "-1": number; + confused: number; + heart: number; + hooray: number; + laugh: number; + total_count: number; + url: string; +}; +type TeamsCreateDiscussionCommentInOrgResponseAuthor = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; +}; +type TeamsCreateDiscussionCommentInOrgResponse = { + author: TeamsCreateDiscussionCommentInOrgResponseAuthor; + body: string; + body_html: string; + body_version: string; + created_at: string; + discussion_url: string; + html_url: string; + last_edited_at: null; + node_id: string; + number: number; + reactions: TeamsCreateDiscussionCommentInOrgResponseReactions; + updated_at: string; + url: string; +}; +type TeamsCreateResponseOrganization = { + avatar_url: string; + blog: string; + company: string; created_at: string; - default_branch: string; - deployments_url: string; description: string; - disabled: boolean; - downloads_url: string; + email: string; events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; + followers: number; + following: number; + has_organization_projects: boolean; + has_repository_projects: boolean; hooks_url: string; html_url: string; id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; + is_verified: boolean; issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - license: TeamsListReposInOrgResponseItemLicense; - merges_url: string; - milestones_url: string; - mirror_url: string; + location: string; + login: string; + members_url: string; name: string; - network_count: number; node_id: string; - notifications_url: string; - open_issues_count: number; - owner: TeamsListReposInOrgResponseItemOwner; - permissions: TeamsListReposInOrgResponseItemPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - temp_clone_token: string; - template_repository: null; - topics: Array; - trees_url: string; + public_gists: number; + public_members_url: string; + public_repos: number; + repos_url: string; + type: string; + url: string; +}; +type TeamsCreateResponse = { + created_at: string; + description: string; + html_url: string; + id: number; + members_count: number; + members_url: string; + name: string; + node_id: string; + organization: TeamsCreateResponseOrganization; + parent: null; + permission: string; + privacy: string; + repos_count: number; + repositories_url: string; + slug: string; updated_at: string; url: string; - visibility: string; - watchers_count: number; }; -type TeamsListReposResponseItemPermissions = { +type TeamsCheckManagesRepoInOrgResponsePermissions = { admin: boolean; pull: boolean; push: boolean; }; -type TeamsListReposResponseItemOwner = { +type TeamsCheckManagesRepoInOrgResponseOwner = { avatar_url: string; events_url: string; followers_url: string; @@ -1224,14 +1307,10 @@ type TeamsListReposResponseItemOwner = { type: string; url: string; }; -type TeamsListReposResponseItemLicense = { - key: string; - name: string; - node_id: string; - spdx_id: string; - url: string; -}; -type TeamsListReposResponseItem = { +type TeamsCheckManagesRepoInOrgResponse = { + allow_merge_commit: boolean; + allow_rebase_merge: boolean; + allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; @@ -1276,7 +1355,6 @@ type TeamsListReposResponseItem = { labels_url: string; language: null; languages_url: string; - license: TeamsListReposResponseItemLicense; merges_url: string; milestones_url: string; mirror_url: string; @@ -1285,8 +1363,8 @@ type TeamsListReposResponseItem = { node_id: string; notifications_url: string; open_issues_count: number; - owner: TeamsListReposResponseItemOwner; - permissions: TeamsListReposResponseItemPermissions; + owner: TeamsCheckManagesRepoInOrgResponseOwner; + permissions: TeamsCheckManagesRepoInOrgResponsePermissions; private: boolean; pulls_url: string; pushed_at: string; @@ -1311,17 +1389,18 @@ type TeamsListReposResponseItem = { visibility: string; watchers_count: number; }; -type TeamsListProjectsLegacyResponseItemPermissions = { - admin: boolean; - read: boolean; - write: boolean; +type TeamsAddOrUpdateProjectInOrgResponse = { + documentation_url: string; + message: string; }; -type TeamsListProjectsLegacyResponseItemCreator = { +type TeamsAddOrUpdateMembershipInOrgResponse = { + role: string; + state: string; + url: string; +}; +type SearchUsersResponseItemsItem = { avatar_url: string; - events_url: string; followers_url: string; - following_url: string; - gists_url: string; gravatar_id: string; html_url: string; id: number; @@ -1330,79 +1409,90 @@ type TeamsListProjectsLegacyResponseItemCreator = { organizations_url: string; received_events_url: string; repos_url: string; - site_admin: boolean; - starred_url: string; + score: number; subscriptions_url: string; type: string; url: string; }; -type TeamsListProjectsLegacyResponseItem = { - body: string; - columns_url: string; +type SearchUsersResponse = { + incomplete_results: boolean; + items: Array; + total_count: number; +}; +type SearchTopicsResponseItemsItem = { created_at: string; - creator: TeamsListProjectsLegacyResponseItemCreator; - html_url: string; - id: number; + created_by: string; + curated: boolean; + description: string; + display_name: string; + featured: boolean; name: string; - node_id: string; - number: number; - organization_permission: string; - owner_url: string; - permissions: TeamsListProjectsLegacyResponseItemPermissions; - private: boolean; - state: string; + released: string; + score: number; + short_description: string; updated_at: string; - url: string; }; -type TeamsListProjectsInOrgResponseItemPermissions = { - admin: boolean; - read: boolean; - write: boolean; +type SearchTopicsResponse = { + incomplete_results: boolean; + items: Array; + total_count: number; }; -type TeamsListProjectsInOrgResponseItemCreator = { +type SearchReposResponseItemsItemOwner = { avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; gravatar_id: string; - html_url: string; id: number; login: string; node_id: string; - organizations_url: string; received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; type: string; url: string; }; -type TeamsListProjectsInOrgResponseItem = { - body: string; - columns_url: string; +type SearchReposResponseItemsItem = { created_at: string; - creator: TeamsListProjectsInOrgResponseItemCreator; + default_branch: string; + description: string; + fork: boolean; + forks_count: number; + full_name: string; + homepage: string; html_url: string; id: number; + language: string; + master_branch: string; name: string; node_id: string; - number: number; - organization_permission: string; - owner_url: string; - permissions: TeamsListProjectsInOrgResponseItemPermissions; + open_issues_count: number; + owner: SearchReposResponseItemsItemOwner; private: boolean; - state: string; + pushed_at: string; + score: number; + size: number; + stargazers_count: number; updated_at: string; url: string; + watchers_count: number; }; -type TeamsListProjectsResponseItemPermissions = { - admin: boolean; - read: boolean; - write: boolean; +type SearchReposResponse = { + incomplete_results: boolean; + items: Array; + total_count: number; +}; +type SearchLabelsResponseItemsItem = { + color: string; + default: boolean; + description: string; + id: number; + name: string; + node_id: string; + score: number; + url: string; +}; +type SearchLabelsResponse = { + incomplete_results: boolean; + items: Array; + total_count: number; }; -type TeamsListProjectsResponseItemCreator = { +type SearchIssuesAndPullRequestsResponseItemsItemUser = { avatar_url: string; events_url: string; followers_url: string; @@ -1416,31 +1506,53 @@ type TeamsListProjectsResponseItemCreator = { organizations_url: string; received_events_url: string; repos_url: string; - site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string; }; -type TeamsListProjectsResponseItem = { +type SearchIssuesAndPullRequestsResponseItemsItemPullRequest = { + diff_url: null; + html_url: null; + patch_url: null; +}; +type SearchIssuesAndPullRequestsResponseItemsItemLabelsItem = { + color: string; + id: number; + name: string; + node_id: string; + url: string; +}; +type SearchIssuesAndPullRequestsResponseItemsItem = { + assignee: null; body: string; - columns_url: string; + closed_at: null; + comments: number; + comments_url: string; created_at: string; - creator: TeamsListProjectsResponseItemCreator; + events_url: string; html_url: string; id: number; - name: string; + labels: Array; + labels_url: string; + milestone: null; node_id: string; number: number; - organization_permission: string; - owner_url: string; - permissions: TeamsListProjectsResponseItemPermissions; - private: boolean; + pull_request: SearchIssuesAndPullRequestsResponseItemsItemPullRequest; + repository_url: string; + score: number; state: string; + title: string; updated_at: string; url: string; + user: SearchIssuesAndPullRequestsResponseItemsItemUser; +}; +type SearchIssuesAndPullRequestsResponse = { + incomplete_results: boolean; + items: Array; + total_count: number; }; -type TeamsListPendingInvitationsLegacyResponseItemInviter = { +type SearchCommitsResponseItemsItemRepositoryOwner = { avatar_url: string; events_url: string; followers_url: string; @@ -1460,47 +1572,60 @@ type TeamsListPendingInvitationsLegacyResponseItemInviter = { type: string; url: string; }; -type TeamsListPendingInvitationsLegacyResponseItem = { - created_at: string; - email: string; - id: number; - invitation_team_url: string; - inviter: TeamsListPendingInvitationsLegacyResponseItemInviter; - login: string; - role: string; - team_count: number; -}; -type TeamsListPendingInvitationsInOrgResponseItemInviter = { - avatar_url: string; +type SearchCommitsResponseItemsItemRepository = { + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + description: string; + downloads_url: string; events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; + fork: boolean; + forks_url: string; + full_name: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + hooks_url: string; html_url: string; id: number; - login: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + name: string; node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; + notifications_url: string; + owner: SearchCommitsResponseItemsItemRepositoryOwner; + private: boolean; + pulls_url: string; + releases_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; url: string; }; -type TeamsListPendingInvitationsInOrgResponseItem = { - created_at: string; - email: string; - id: number; - invitation_team_url: string; - inviter: TeamsListPendingInvitationsInOrgResponseItemInviter; - login: string; - role: string; - team_count: number; +type SearchCommitsResponseItemsItemParentsItem = { + html_url: string; + sha: string; + url: string; }; -type TeamsListPendingInvitationsResponseItemInviter = { +type SearchCommitsResponseItemsItemCommitter = { avatar_url: string; events_url: string; followers_url: string; @@ -1520,17 +1645,26 @@ type TeamsListPendingInvitationsResponseItemInviter = { type: string; url: string; }; -type TeamsListPendingInvitationsResponseItem = { - created_at: string; +type SearchCommitsResponseItemsItemCommitTree = { sha: string; url: string }; +type SearchCommitsResponseItemsItemCommitCommitter = { + date: string; email: string; - id: number; - invitation_team_url: string; - inviter: TeamsListPendingInvitationsResponseItemInviter; - login: string; - role: string; - team_count: number; + name: string; +}; +type SearchCommitsResponseItemsItemCommitAuthor = { + date: string; + email: string; + name: string; +}; +type SearchCommitsResponseItemsItemCommit = { + author: SearchCommitsResponseItemsItemCommitAuthor; + comment_count: number; + committer: SearchCommitsResponseItemsItemCommitCommitter; + message: string; + tree: SearchCommitsResponseItemsItemCommitTree; + url: string; }; -type TeamsListMembersLegacyResponseItem = { +type SearchCommitsResponseItemsItemAuthor = { avatar_url: string; events_url: string; followers_url: string; @@ -1550,27 +1684,24 @@ type TeamsListMembersLegacyResponseItem = { type: string; url: string; }; -type TeamsListMembersInOrgResponseItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; +type SearchCommitsResponseItemsItem = { + author: SearchCommitsResponseItemsItemAuthor; + comments_url: string; + commit: SearchCommitsResponseItemsItemCommit; + committer: SearchCommitsResponseItemsItemCommitter; html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; + parents: Array; + repository: SearchCommitsResponseItemsItemRepository; + score: number; + sha: string; url: string; }; -type TeamsListMembersResponseItem = { +type SearchCommitsResponse = { + incomplete_results: boolean; + items: Array; + total_count: number; +}; +type SearchCodeResponseItemsItemRepositoryOwner = { avatar_url: string; events_url: string; followers_url: string; @@ -1590,65 +1721,68 @@ type TeamsListMembersResponseItem = { type: string; url: string; }; -type TeamsListForAuthenticatedUserResponseItemOrganization = { - avatar_url: string; - blog: string; - company: string; - created_at: string; +type SearchCodeResponseItemsItemRepository = { + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; description: string; - email: string; + downloads_url: string; events_url: string; - followers: number; - following: number; - has_organization_projects: boolean; - has_repository_projects: boolean; + fork: boolean; + forks_url: string; + full_name: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; hooks_url: string; html_url: string; id: number; - is_verified: boolean; + issue_comment_url: string; + issue_events_url: string; issues_url: string; - location: string; - login: string; - members_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; name: string; node_id: string; - public_gists: number; - public_members_url: string; - public_repos: number; - repos_url: string; - type: string; + notifications_url: string; + owner: SearchCodeResponseItemsItemRepositoryOwner; + private: boolean; + pulls_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; url: string; }; -type TeamsListForAuthenticatedUserResponseItem = { - created_at: string; - description: string; +type SearchCodeResponseItemsItem = { + git_url: string; html_url: string; - id: number; - members_count: number; - members_url: string; name: string; - node_id: string; - organization: TeamsListForAuthenticatedUserResponseItemOrganization; - parent: null; - permission: string; - privacy: string; - repos_count: number; - repositories_url: string; - slug: string; - updated_at: string; + path: string; + repository: SearchCodeResponseItemsItemRepository; + score: number; + sha: string; url: string; }; -type TeamsListDiscussionsLegacyResponseItemReactions = { - "+1": number; - "-1": number; - confused: number; - heart: number; - hooray: number; - laugh: number; +type SearchCodeResponse = { + incomplete_results: boolean; + items: Array; total_count: number; - url: string; }; -type TeamsListDiscussionsLegacyResponseItemAuthor = { +type ReposUploadReleaseAssetResponseUploader = { avatar_url: string; events_url: string; followers_url: string; @@ -1668,37 +1802,22 @@ type TeamsListDiscussionsLegacyResponseItemAuthor = { type: string; url: string; }; -type TeamsListDiscussionsLegacyResponseItem = { - author: TeamsListDiscussionsLegacyResponseItemAuthor; - body: string; - body_html: string; - body_version: string; - comments_count: number; - comments_url: string; +type ReposUploadReleaseAssetResponse = { + browser_download_url: string; + content_type: string; created_at: string; - html_url: string; - last_edited_at: null; + download_count: number; + id: number; + label: string; + name: string; node_id: string; - number: number; - pinned: boolean; - private: boolean; - reactions: TeamsListDiscussionsLegacyResponseItemReactions; - team_url: string; - title: string; + size: number; + state: string; updated_at: string; + uploader: ReposUploadReleaseAssetResponseUploader; url: string; }; -type TeamsListDiscussionsInOrgResponseItemReactions = { - "+1": number; - "-1": number; - confused: number; - heart: number; - hooray: number; - laugh: number; - total_count: number; - url: string; -}; -type TeamsListDiscussionsInOrgResponseItemAuthor = { +type ReposUpdateReleaseAssetResponseUploader = { avatar_url: string; events_url: string; followers_url: string; @@ -1718,37 +1837,42 @@ type TeamsListDiscussionsInOrgResponseItemAuthor = { type: string; url: string; }; -type TeamsListDiscussionsInOrgResponseItem = { - author: TeamsListDiscussionsInOrgResponseItemAuthor; - body: string; - body_html: string; - body_version: string; - comments_count: number; - comments_url: string; +type ReposUpdateReleaseAssetResponse = { + browser_download_url: string; + content_type: string; created_at: string; - html_url: string; - last_edited_at: null; + download_count: number; + id: number; + label: string; + name: string; node_id: string; - number: number; - pinned: boolean; - private: boolean; - reactions: TeamsListDiscussionsInOrgResponseItemReactions; - team_url: string; - title: string; + size: number; + state: string; updated_at: string; + uploader: ReposUpdateReleaseAssetResponseUploader; url: string; }; -type TeamsListDiscussionsResponseItemReactions = { - "+1": number; - "-1": number; - confused: number; - heart: number; - hooray: number; - laugh: number; - total_count: number; +type ReposUpdateReleaseResponseAuthor = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; url: string; }; -type TeamsListDiscussionsResponseItemAuthor = { +type ReposUpdateReleaseResponseAssetsItemUploader = { avatar_url: string; events_url: string; followers_url: string; @@ -1768,37 +1892,48 @@ type TeamsListDiscussionsResponseItemAuthor = { type: string; url: string; }; -type TeamsListDiscussionsResponseItem = { - author: TeamsListDiscussionsResponseItemAuthor; +type ReposUpdateReleaseResponseAssetsItem = { + browser_download_url: string; + content_type: string; + created_at: string; + download_count: number; + id: number; + label: string; + name: string; + node_id: string; + size: number; + state: string; + updated_at: string; + uploader: ReposUpdateReleaseResponseAssetsItemUploader; + url: string; +}; +type ReposUpdateReleaseResponse = { + assets: Array; + assets_url: string; + author: ReposUpdateReleaseResponseAuthor; body: string; - body_html: string; - body_version: string; - comments_count: number; - comments_url: string; created_at: string; + draft: boolean; html_url: string; - last_edited_at: null; + id: number; + name: string; node_id: string; - number: number; - pinned: boolean; - private: boolean; - reactions: TeamsListDiscussionsResponseItemReactions; - team_url: string; - title: string; - updated_at: string; + prerelease: boolean; + published_at: string; + tag_name: string; + tarball_url: string; + target_commitish: string; + upload_url: string; url: string; + zipball_url: string; }; -type TeamsListDiscussionCommentsLegacyResponseItemReactions = { - "+1": number; - "-1": number; - confused: number; - heart: number; - hooray: number; - laugh: number; - total_count: number; +type ReposUpdateProtectedBranchRequiredStatusChecksResponse = { + contexts: Array; + contexts_url: string; + strict: boolean; url: string; }; -type TeamsListDiscussionCommentsLegacyResponseItemAuthor = { +type ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsUsersItem = { avatar_url: string; events_url: string; followers_url: string; @@ -1818,32 +1953,39 @@ type TeamsListDiscussionCommentsLegacyResponseItemAuthor = { type: string; url: string; }; -type TeamsListDiscussionCommentsLegacyResponseItem = { - author: TeamsListDiscussionCommentsLegacyResponseItemAuthor; - body: string; - body_html: string; - body_version: string; - created_at: string; - discussion_url: string; +type ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsTeamsItem = { + description: string; html_url: string; - last_edited_at: null; + id: number; + members_url: string; + name: string; node_id: string; - number: number; - reactions: TeamsListDiscussionCommentsLegacyResponseItemReactions; - updated_at: string; + parent: null; + permission: string; + privacy: string; + repositories_url: string; + slug: string; url: string; }; -type TeamsListDiscussionCommentsInOrgResponseItemReactions = { - "+1": number; - "-1": number; - confused: number; - heart: number; - hooray: number; - laugh: number; - total_count: number; +type ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictions = { + teams: Array< + ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsTeamsItem + >; + teams_url: string; url: string; + users: Array< + ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsUsersItem + >; + users_url: string; }; -type TeamsListDiscussionCommentsInOrgResponseItemAuthor = { +type ReposUpdateProtectedBranchPullRequestReviewEnforcementResponse = { + dismiss_stale_reviews: boolean; + dismissal_restrictions: ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictions; + require_code_owner_reviews: boolean; + required_approving_review_count: number; + url: string; +}; +type ReposUpdateInvitationResponseRepositoryOwner = { avatar_url: string; events_url: string; followers_url: string; @@ -1863,32 +2005,56 @@ type TeamsListDiscussionCommentsInOrgResponseItemAuthor = { type: string; url: string; }; -type TeamsListDiscussionCommentsInOrgResponseItem = { - author: TeamsListDiscussionCommentsInOrgResponseItemAuthor; - body: string; - body_html: string; - body_version: string; - created_at: string; - discussion_url: string; +type ReposUpdateInvitationResponseRepository = { + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; + description: string; + downloads_url: string; + events_url: string; + fork: boolean; + forks_url: string; + full_name: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; html_url: string; - last_edited_at: null; + id: number; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; + name: string; node_id: string; - number: number; - reactions: TeamsListDiscussionCommentsInOrgResponseItemReactions; - updated_at: string; - url: string; -}; -type TeamsListDiscussionCommentsResponseItemReactions = { - "+1": number; - "-1": number; - confused: number; - heart: number; - hooray: number; - laugh: number; - total_count: number; + notifications_url: string; + owner: ReposUpdateInvitationResponseRepositoryOwner; + private: boolean; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; url: string; }; -type TeamsListDiscussionCommentsResponseItemAuthor = { +type ReposUpdateInvitationResponseInviter = { avatar_url: string; events_url: string; followers_url: string; @@ -1908,100 +2074,115 @@ type TeamsListDiscussionCommentsResponseItemAuthor = { type: string; url: string; }; -type TeamsListDiscussionCommentsResponseItem = { - author: TeamsListDiscussionCommentsResponseItemAuthor; - body: string; - body_html: string; - body_version: string; - created_at: string; - discussion_url: string; +type ReposUpdateInvitationResponseInvitee = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; html_url: string; - last_edited_at: null; + id: number; + login: string; node_id: string; - number: number; - reactions: TeamsListDiscussionCommentsResponseItemReactions; - updated_at: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; url: string; }; -type TeamsListChildLegacyResponseItemParent = { - description: string; +type ReposUpdateInvitationResponse = { + created_at: string; html_url: string; id: number; - members_url: string; - name: string; - node_id: string; - permission: string; - privacy: string; - repositories_url: string; - slug: string; + invitee: ReposUpdateInvitationResponseInvitee; + inviter: ReposUpdateInvitationResponseInviter; + permissions: string; + repository: ReposUpdateInvitationResponseRepository; url: string; }; -type TeamsListChildLegacyResponseItem = { - description: string; - id: number; - members_url: string; - name: string; - node_id: string; - parent: TeamsListChildLegacyResponseItemParent; - permission: string; - privacy: string; - repositories_url: string; - slug: string; +type ReposUpdateHookResponseLastResponse = { + code: null; + message: null; + status: string; +}; +type ReposUpdateHookResponseConfig = { + content_type: string; + insecure_ssl: string; url: string; }; -type TeamsListChildInOrgResponseItemParent = { - description: string; - html_url: string; +type ReposUpdateHookResponse = { + active: boolean; + config: ReposUpdateHookResponseConfig; + created_at: string; + events: Array; id: number; - members_url: string; + last_response: ReposUpdateHookResponseLastResponse; name: string; - node_id: string; - permission: string; - privacy: string; - repositories_url: string; - slug: string; + ping_url: string; + test_url: string; + type: string; + updated_at: string; url: string; }; -type TeamsListChildInOrgResponseItem = { - description: string; +type ReposUpdateCommitCommentResponseUser = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; id: number; - members_url: string; - name: string; + login: string; node_id: string; - parent: TeamsListChildInOrgResponseItemParent; - permission: string; - privacy: string; - repositories_url: string; - slug: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; url: string; }; -type TeamsListChildResponseItemParent = { - description: string; +type ReposUpdateCommitCommentResponse = { + body: string; + commit_id: string; + created_at: string; html_url: string; id: number; - members_url: string; - name: string; + line: number; node_id: string; - permission: string; - privacy: string; - repositories_url: string; - slug: string; + path: string; + position: number; + updated_at: string; url: string; + user: ReposUpdateCommitCommentResponseUser; }; -type TeamsListChildResponseItem = { - description: string; +type ReposUpdateBranchProtectionResponseRestrictionsUsersItem = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; id: number; - members_url: string; - name: string; + login: string; node_id: string; - parent: TeamsListChildResponseItemParent; - permission: string; - privacy: string; - repositories_url: string; - slug: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; url: string; }; -type TeamsListResponseItem = { +type ReposUpdateBranchProtectionResponseRestrictionsTeamsItem = { description: string; html_url: string; id: number; @@ -2015,76 +2196,56 @@ type TeamsListResponseItem = { slug: string; url: string; }; -type TeamsGetMembershipLegacyResponse = { - role: string; - state: string; - url: string; -}; -type TeamsGetMembershipInOrgResponse = { - role: string; - state: string; - url: string; +type ReposUpdateBranchProtectionResponseRestrictionsAppsItemPermissions = { + contents: string; + issues: string; + metadata: string; + single_file: string; }; -type TeamsGetMembershipResponse = { role: string; state: string; url: string }; -type TeamsGetLegacyResponseOrganization = { +type ReposUpdateBranchProtectionResponseRestrictionsAppsItemOwner = { avatar_url: string; - blog: string; - company: string; - created_at: string; description: string; - email: string; events_url: string; - followers: number; - following: number; - has_organization_projects: boolean; - has_repository_projects: boolean; hooks_url: string; - html_url: string; id: number; - is_verified: boolean; issues_url: string; - location: string; login: string; members_url: string; - name: string; node_id: string; - public_gists: number; public_members_url: string; - public_repos: number; repos_url: string; - type: string; url: string; }; -type TeamsGetLegacyResponse = { +type ReposUpdateBranchProtectionResponseRestrictionsAppsItem = { created_at: string; description: string; + events: Array; + external_url: string; html_url: string; id: number; - members_count: number; - members_url: string; name: string; node_id: string; - organization: TeamsGetLegacyResponseOrganization; - parent: null; - permission: string; - privacy: string; - repos_count: number; - repositories_url: string; + owner: ReposUpdateBranchProtectionResponseRestrictionsAppsItemOwner; + permissions: ReposUpdateBranchProtectionResponseRestrictionsAppsItemPermissions; slug: string; updated_at: string; - url: string; }; -type TeamsGetDiscussionLegacyResponseReactions = { - "+1": number; - "-1": number; - confused: number; - heart: number; - hooray: number; - laugh: number; - total_count: number; +type ReposUpdateBranchProtectionResponseRestrictions = { + apps: Array; + apps_url: string; + teams: Array; + teams_url: string; + url: string; + users: Array; + users_url: string; +}; +type ReposUpdateBranchProtectionResponseRequiredStatusChecks = { + contexts: Array; + contexts_url: string; + strict: boolean; url: string; }; -type TeamsGetDiscussionLegacyResponseAuthor = { +type ReposUpdateBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsUsersItem = { avatar_url: string; events_url: string; followers_url: string; @@ -2104,37 +2265,63 @@ type TeamsGetDiscussionLegacyResponseAuthor = { type: string; url: string; }; -type TeamsGetDiscussionLegacyResponse = { - author: TeamsGetDiscussionLegacyResponseAuthor; - body: string; - body_html: string; - body_version: string; - comments_count: number; - comments_url: string; - created_at: string; +type ReposUpdateBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsTeamsItem = { + description: string; html_url: string; - last_edited_at: null; + id: number; + members_url: string; + name: string; node_id: string; - number: number; - pinned: boolean; - private: boolean; - reactions: TeamsGetDiscussionLegacyResponseReactions; - team_url: string; - title: string; - updated_at: string; + parent: null; + permission: string; + privacy: string; + repositories_url: string; + slug: string; url: string; }; -type TeamsGetDiscussionInOrgResponseReactions = { - "+1": number; - "-1": number; - confused: number; - heart: number; - hooray: number; - laugh: number; - total_count: number; +type ReposUpdateBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictions = { + teams: Array< + ReposUpdateBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsTeamsItem + >; + teams_url: string; url: string; + users: Array< + ReposUpdateBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsUsersItem + >; + users_url: string; }; -type TeamsGetDiscussionInOrgResponseAuthor = { +type ReposUpdateBranchProtectionResponseRequiredPullRequestReviews = { + dismiss_stale_reviews: boolean; + dismissal_restrictions: ReposUpdateBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictions; + require_code_owner_reviews: boolean; + required_approving_review_count: number; + url: string; +}; +type ReposUpdateBranchProtectionResponseRequiredLinearHistory = { + enabled: boolean; +}; +type ReposUpdateBranchProtectionResponseEnforceAdmins = { + enabled: boolean; + url: string; +}; +type ReposUpdateBranchProtectionResponseAllowForcePushes = { enabled: boolean }; +type ReposUpdateBranchProtectionResponseAllowDeletions = { enabled: boolean }; +type ReposUpdateBranchProtectionResponse = { + allow_deletions: ReposUpdateBranchProtectionResponseAllowDeletions; + allow_force_pushes: ReposUpdateBranchProtectionResponseAllowForcePushes; + enforce_admins: ReposUpdateBranchProtectionResponseEnforceAdmins; + required_linear_history: ReposUpdateBranchProtectionResponseRequiredLinearHistory; + required_pull_request_reviews: ReposUpdateBranchProtectionResponseRequiredPullRequestReviews; + required_status_checks: ReposUpdateBranchProtectionResponseRequiredStatusChecks; + restrictions: ReposUpdateBranchProtectionResponseRestrictions; + url: string; +}; +type ReposUpdateResponseSourcePermissions = { + admin: boolean; + pull: boolean; + push: boolean; +}; +type ReposUpdateResponseSourceOwner = { avatar_url: string; events_url: string; followers_url: string; @@ -2154,37 +2341,99 @@ type TeamsGetDiscussionInOrgResponseAuthor = { type: string; url: string; }; -type TeamsGetDiscussionInOrgResponse = { - author: TeamsGetDiscussionInOrgResponseAuthor; - body: string; - body_html: string; - body_version: string; - comments_count: number; +type ReposUpdateResponseSource = { + allow_merge_commit: boolean; + allow_rebase_merge: boolean; + allow_squash_merge: boolean; + archive_url: string; + archived: boolean; + assignees_url: string; + blobs_url: string; + branches_url: string; + clone_url: string; + collaborators_url: string; comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; created_at: string; + default_branch: string; + deployments_url: string; + description: string; + disabled: boolean; + downloads_url: string; + events_url: string; + fork: boolean; + forks_count: number; + forks_url: string; + full_name: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + has_downloads: boolean; + has_issues: boolean; + has_pages: boolean; + has_projects: boolean; + has_wiki: boolean; + homepage: string; + hooks_url: string; html_url: string; - last_edited_at: null; + id: number; + is_template: boolean; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + language: null; + languages_url: string; + merges_url: string; + milestones_url: string; + mirror_url: string; + name: string; + network_count: number; node_id: string; - number: number; - pinned: boolean; + notifications_url: string; + open_issues_count: number; + owner: ReposUpdateResponseSourceOwner; + permissions: ReposUpdateResponseSourcePermissions; private: boolean; - reactions: TeamsGetDiscussionInOrgResponseReactions; - team_url: string; - title: string; + pulls_url: string; + pushed_at: string; + releases_url: string; + size: number; + ssh_url: string; + stargazers_count: number; + stargazers_url: string; + statuses_url: string; + subscribers_count: number; + subscribers_url: string; + subscription_url: string; + svn_url: string; + tags_url: string; + teams_url: string; + temp_clone_token: string; + template_repository: null; + topics: Array; + trees_url: string; updated_at: string; url: string; + visibility: string; + watchers_count: number; }; -type TeamsGetDiscussionCommentLegacyResponseReactions = { - "+1": number; - "-1": number; - confused: number; - heart: number; - hooray: number; - laugh: number; - total_count: number; - url: string; +type ReposUpdateResponsePermissions = { + admin: boolean; + pull: boolean; + push: boolean; +}; +type ReposUpdateResponseParentPermissions = { + admin: boolean; + pull: boolean; + push: boolean; }; -type TeamsGetDiscussionCommentLegacyResponseAuthor = { +type ReposUpdateResponseParentOwner = { avatar_url: string; events_url: string; followers_url: string; @@ -2204,32 +2453,89 @@ type TeamsGetDiscussionCommentLegacyResponseAuthor = { type: string; url: string; }; -type TeamsGetDiscussionCommentLegacyResponse = { - author: TeamsGetDiscussionCommentLegacyResponseAuthor; - body: string; - body_html: string; - body_version: string; +type ReposUpdateResponseParent = { + allow_merge_commit: boolean; + allow_rebase_merge: boolean; + allow_squash_merge: boolean; + archive_url: string; + archived: boolean; + assignees_url: string; + blobs_url: string; + branches_url: string; + clone_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; created_at: string; - discussion_url: string; + default_branch: string; + deployments_url: string; + description: string; + disabled: boolean; + downloads_url: string; + events_url: string; + fork: boolean; + forks_count: number; + forks_url: string; + full_name: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + has_downloads: boolean; + has_issues: boolean; + has_pages: boolean; + has_projects: boolean; + has_wiki: boolean; + homepage: string; + hooks_url: string; html_url: string; - last_edited_at: null; + id: number; + is_template: boolean; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + language: null; + languages_url: string; + merges_url: string; + milestones_url: string; + mirror_url: string; + name: string; + network_count: number; node_id: string; - number: number; - reactions: TeamsGetDiscussionCommentLegacyResponseReactions; + notifications_url: string; + open_issues_count: number; + owner: ReposUpdateResponseParentOwner; + permissions: ReposUpdateResponseParentPermissions; + private: boolean; + pulls_url: string; + pushed_at: string; + releases_url: string; + size: number; + ssh_url: string; + stargazers_count: number; + stargazers_url: string; + statuses_url: string; + subscribers_count: number; + subscribers_url: string; + subscription_url: string; + svn_url: string; + tags_url: string; + teams_url: string; + temp_clone_token: string; + template_repository: null; + topics: Array; + trees_url: string; updated_at: string; url: string; + visibility: string; + watchers_count: number; }; -type TeamsGetDiscussionCommentInOrgResponseReactions = { - "+1": number; - "-1": number; - confused: number; - heart: number; - hooray: number; - laugh: number; - total_count: number; - url: string; -}; -type TeamsGetDiscussionCommentInOrgResponseAuthor = { +type ReposUpdateResponseOwner = { avatar_url: string; events_url: string; followers_url: string; @@ -2249,32 +2555,7 @@ type TeamsGetDiscussionCommentInOrgResponseAuthor = { type: string; url: string; }; -type TeamsGetDiscussionCommentInOrgResponse = { - author: TeamsGetDiscussionCommentInOrgResponseAuthor; - body: string; - body_html: string; - body_version: string; - created_at: string; - discussion_url: string; - html_url: string; - last_edited_at: null; - node_id: string; - number: number; - reactions: TeamsGetDiscussionCommentInOrgResponseReactions; - updated_at: string; - url: string; -}; -type TeamsGetDiscussionCommentResponseReactions = { - "+1": number; - "-1": number; - confused: number; - heart: number; - hooray: number; - laugh: number; - total_count: number; - url: string; -}; -type TeamsGetDiscussionCommentResponseAuthor = { +type ReposUpdateResponseOrganization = { avatar_url: string; events_url: string; followers_url: string; @@ -2294,32 +2575,97 @@ type TeamsGetDiscussionCommentResponseAuthor = { type: string; url: string; }; -type TeamsGetDiscussionCommentResponse = { - author: TeamsGetDiscussionCommentResponseAuthor; - body: string; - body_html: string; - body_version: string; +type ReposUpdateResponse = { + allow_merge_commit: boolean; + allow_rebase_merge: boolean; + allow_squash_merge: boolean; + archive_url: string; + archived: boolean; + assignees_url: string; + blobs_url: string; + branches_url: string; + clone_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; created_at: string; - discussion_url: string; + default_branch: string; + deployments_url: string; + description: string; + disabled: boolean; + downloads_url: string; + events_url: string; + fork: boolean; + forks_count: number; + forks_url: string; + full_name: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + has_downloads: boolean; + has_issues: boolean; + has_pages: boolean; + has_projects: boolean; + has_wiki: boolean; + homepage: string; + hooks_url: string; html_url: string; - last_edited_at: null; + id: number; + is_template: boolean; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + language: null; + languages_url: string; + merges_url: string; + milestones_url: string; + mirror_url: string; + name: string; + network_count: number; node_id: string; - number: number; - reactions: TeamsGetDiscussionCommentResponseReactions; + notifications_url: string; + open_issues_count: number; + organization: ReposUpdateResponseOrganization; + owner: ReposUpdateResponseOwner; + parent: ReposUpdateResponseParent; + permissions: ReposUpdateResponsePermissions; + private: boolean; + pulls_url: string; + pushed_at: string; + releases_url: string; + size: number; + source: ReposUpdateResponseSource; + ssh_url: string; + stargazers_count: number; + stargazers_url: string; + statuses_url: string; + subscribers_count: number; + subscribers_url: string; + subscription_url: string; + svn_url: string; + tags_url: string; + teams_url: string; + temp_clone_token: string; + template_repository: null; + topics: Array; + trees_url: string; updated_at: string; url: string; + visibility: string; + watchers_count: number; }; -type TeamsGetDiscussionResponseReactions = { - "+1": number; - "-1": number; - confused: number; - heart: number; - hooray: number; - laugh: number; - total_count: number; - url: string; +type ReposTransferResponsePermissions = { + admin: boolean; + pull: boolean; + push: boolean; }; -type TeamsGetDiscussionResponseAuthor = { +type ReposTransferResponseOwner = { avatar_url: string; events_url: string; followers_url: string; @@ -2339,133 +2685,203 @@ type TeamsGetDiscussionResponseAuthor = { type: string; url: string; }; -type TeamsGetDiscussionResponse = { - author: TeamsGetDiscussionResponseAuthor; - body: string; - body_html: string; - body_version: string; - comments_count: number; +type ReposTransferResponse = { + allow_merge_commit: boolean; + allow_rebase_merge: boolean; + allow_squash_merge: boolean; + archive_url: string; + archived: boolean; + assignees_url: string; + blobs_url: string; + branches_url: string; + clone_url: string; + collaborators_url: string; comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; created_at: string; - html_url: string; - last_edited_at: null; - node_id: string; - number: number; - pinned: boolean; - private: boolean; - reactions: TeamsGetDiscussionResponseReactions; - team_url: string; - title: string; - updated_at: string; - url: string; -}; -type TeamsGetByNameResponseOrganization = { - avatar_url: string; - blog: string; - company: string; - created_at: string; + default_branch: string; + deployments_url: string; description: string; - email: string; + disabled: boolean; + downloads_url: string; events_url: string; - followers: number; - following: number; - has_organization_projects: boolean; - has_repository_projects: boolean; + fork: boolean; + forks_count: number; + forks_url: string; + full_name: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + has_downloads: boolean; + has_issues: boolean; + has_pages: boolean; + has_projects: boolean; + has_wiki: boolean; + homepage: string; hooks_url: string; html_url: string; id: number; - is_verified: boolean; + is_template: boolean; + issue_comment_url: string; + issue_events_url: string; issues_url: string; - location: string; - login: string; - members_url: string; - name: string; - node_id: string; - public_gists: number; - public_members_url: string; - public_repos: number; - repos_url: string; - type: string; - url: string; -}; -type TeamsGetByNameResponse = { - created_at: string; - description: string; - html_url: string; - id: number; - members_count: number; - members_url: string; + keys_url: string; + labels_url: string; + language: null; + languages_url: string; + merges_url: string; + milestones_url: string; + mirror_url: string; name: string; + network_count: number; node_id: string; - organization: TeamsGetByNameResponseOrganization; - parent: null; - permission: string; - privacy: string; - repos_count: number; - repositories_url: string; - slug: string; - updated_at: string; - url: string; + notifications_url: string; + open_issues_count: number; + owner: ReposTransferResponseOwner; + permissions: ReposTransferResponsePermissions; + private: boolean; + pulls_url: string; + pushed_at: string; + releases_url: string; + size: number; + ssh_url: string; + stargazers_count: number; + stargazers_url: string; + statuses_url: string; + subscribers_count: number; + subscribers_url: string; + subscription_url: string; + svn_url: string; + tags_url: string; + teams_url: string; + temp_clone_token: string; + template_repository: null; + topics: Array; + trees_url: string; + updated_at: string; + url: string; + visibility: string; + watchers_count: number; }; -type TeamsGetResponseOrganization = { - avatar_url: string; - blog: string; - company: string; - created_at: string; +type ReposRetrieveCommunityProfileMetricsResponseFilesReadme = { + html_url: string; + url: string; +}; +type ReposRetrieveCommunityProfileMetricsResponseFilesPullRequestTemplate = { + html_url: string; + url: string; +}; +type ReposRetrieveCommunityProfileMetricsResponseFilesLicense = { + html_url: string; + key: string; + name: string; + spdx_id: string; + url: string; +}; +type ReposRetrieveCommunityProfileMetricsResponseFilesIssueTemplate = { + html_url: string; + url: string; +}; +type ReposRetrieveCommunityProfileMetricsResponseFilesContributing = { + html_url: string; + url: string; +}; +type ReposRetrieveCommunityProfileMetricsResponseFilesCodeOfConduct = { + html_url: string; + key: string; + name: string; + url: string; +}; +type ReposRetrieveCommunityProfileMetricsResponseFiles = { + code_of_conduct: ReposRetrieveCommunityProfileMetricsResponseFilesCodeOfConduct; + contributing: ReposRetrieveCommunityProfileMetricsResponseFilesContributing; + issue_template: ReposRetrieveCommunityProfileMetricsResponseFilesIssueTemplate; + license: ReposRetrieveCommunityProfileMetricsResponseFilesLicense; + pull_request_template: ReposRetrieveCommunityProfileMetricsResponseFilesPullRequestTemplate; + readme: ReposRetrieveCommunityProfileMetricsResponseFilesReadme; +}; +type ReposRetrieveCommunityProfileMetricsResponse = { description: string; - email: string; + documentation: boolean; + files: ReposRetrieveCommunityProfileMetricsResponseFiles; + health_percentage: number; + updated_at: string; +}; +type ReposRequestPageBuildResponse = { status: string; url: string }; +type ReposReplaceTopicsResponse = { names: Array }; +type ReposReplaceProtectedBranchUserRestrictionsResponseItem = { + avatar_url: string; events_url: string; - followers: number; - following: number; - has_organization_projects: boolean; - has_repository_projects: boolean; - hooks_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; html_url: string; id: number; - is_verified: boolean; - issues_url: string; - location: string; login: string; - members_url: string; - name: string; node_id: string; - public_gists: number; - public_members_url: string; - public_repos: number; + organizations_url: string; + received_events_url: string; repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; type: string; url: string; }; -type TeamsGetResponse = { - created_at: string; +type ReposReplaceProtectedBranchTeamRestrictionsResponseItem = { description: string; html_url: string; id: number; - members_count: number; members_url: string; name: string; node_id: string; - organization: TeamsGetResponseOrganization; parent: null; permission: string; privacy: string; - repos_count: number; repositories_url: string; slug: string; - updated_at: string; url: string; }; -type TeamsCreateDiscussionLegacyResponseReactions = { - "+1": number; - "-1": number; - confused: number; - heart: number; - hooray: number; - laugh: number; - total_count: number; +type ReposReplaceProtectedBranchAppRestrictionsResponseItemPermissions = { + contents: string; + issues: string; + metadata: string; + single_file: string; +}; +type ReposReplaceProtectedBranchAppRestrictionsResponseItemOwner = { + avatar_url: string; + description: string; + events_url: string; + hooks_url: string; + id: number; + issues_url: string; + login: string; + members_url: string; + node_id: string; + public_members_url: string; + repos_url: string; url: string; }; -type TeamsCreateDiscussionLegacyResponseAuthor = { +type ReposReplaceProtectedBranchAppRestrictionsResponseItem = { + created_at: string; + description: string; + events: Array; + external_url: string; + html_url: string; + id: number; + name: string; + node_id: string; + owner: ReposReplaceProtectedBranchAppRestrictionsResponseItemOwner; + permissions: ReposReplaceProtectedBranchAppRestrictionsResponseItemPermissions; + slug: string; + updated_at: string; +}; +type ReposRemoveProtectedBranchUserRestrictionsResponseItem = { avatar_url: string; events_url: string; followers_url: string; @@ -2485,37 +2901,102 @@ type TeamsCreateDiscussionLegacyResponseAuthor = { type: string; url: string; }; -type TeamsCreateDiscussionLegacyResponse = { - author: TeamsCreateDiscussionLegacyResponseAuthor; - body: string; - body_html: string; - body_version: string; - comments_count: number; - comments_url: string; +type ReposRemoveProtectedBranchTeamRestrictionsResponseItem = { + description: string; + html_url: string; + id: number; + members_url: string; + name: string; + node_id: string; + parent: null; + permission: string; + privacy: string; + repositories_url: string; + slug: string; + url: string; +}; +type ReposRemoveProtectedBranchAppRestrictionsResponseItemPermissions = { + contents: string; + issues: string; + metadata: string; + single_file: string; +}; +type ReposRemoveProtectedBranchAppRestrictionsResponseItemOwner = { + avatar_url: string; + description: string; + events_url: string; + hooks_url: string; + id: number; + issues_url: string; + login: string; + members_url: string; + node_id: string; + public_members_url: string; + repos_url: string; + url: string; +}; +type ReposRemoveProtectedBranchAppRestrictionsResponseItem = { created_at: string; + description: string; + events: Array; + external_url: string; html_url: string; - last_edited_at: null; + id: number; + name: string; node_id: string; - number: number; - pinned: boolean; - private: boolean; - reactions: TeamsCreateDiscussionLegacyResponseReactions; - team_url: string; - title: string; + owner: ReposRemoveProtectedBranchAppRestrictionsResponseItemOwner; + permissions: ReposRemoveProtectedBranchAppRestrictionsResponseItemPermissions; + slug: string; updated_at: string; +}; +type ReposMergeResponseParentsItem = { sha: string; url: string }; +type ReposMergeResponseCommitter = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; url: string; }; -type TeamsCreateDiscussionInOrgResponseReactions = { - "+1": number; - "-1": number; - confused: number; - heart: number; - hooray: number; - laugh: number; - total_count: number; +type ReposMergeResponseCommitVerification = { + payload: null; + reason: string; + signature: null; + verified: boolean; +}; +type ReposMergeResponseCommitTree = { sha: string; url: string }; +type ReposMergeResponseCommitCommitter = { + date: string; + email: string; + name: string; +}; +type ReposMergeResponseCommitAuthor = { + date: string; + email: string; + name: string; +}; +type ReposMergeResponseCommit = { + author: ReposMergeResponseCommitAuthor; + comment_count: number; + committer: ReposMergeResponseCommitCommitter; + message: string; + tree: ReposMergeResponseCommitTree; url: string; + verification: ReposMergeResponseCommitVerification; }; -type TeamsCreateDiscussionInOrgResponseAuthor = { +type ReposMergeResponseAuthor = { avatar_url: string; events_url: string; followers_url: string; @@ -2535,37 +3016,40 @@ type TeamsCreateDiscussionInOrgResponseAuthor = { type: string; url: string; }; -type TeamsCreateDiscussionInOrgResponse = { - author: TeamsCreateDiscussionInOrgResponseAuthor; - body: string; - body_html: string; - body_version: string; - comments_count: number; +type ReposMergeResponse = { + author: ReposMergeResponseAuthor; comments_url: string; - created_at: string; + commit: ReposMergeResponseCommit; + committer: ReposMergeResponseCommitter; html_url: string; - last_edited_at: null; node_id: string; - number: number; - pinned: boolean; - private: boolean; - reactions: TeamsCreateDiscussionInOrgResponseReactions; - team_url: string; - title: string; - updated_at: string; + parents: Array; + sha: string; url: string; }; -type TeamsCreateDiscussionCommentLegacyResponseReactions = { - "+1": number; - "-1": number; - confused: number; - heart: number; - hooray: number; - laugh: number; - total_count: number; +type ReposListTopicsResponse = { names: Array }; +type ReposListTeamsResponseItem = { + description: string; + html_url: string; + id: number; + members_url: string; + name: string; + node_id: string; + parent: null; + permission: string; + privacy: string; + repositories_url: string; + slug: string; url: string; }; -type TeamsCreateDiscussionCommentLegacyResponseAuthor = { +type ReposListTagsResponseItemCommit = { sha: string; url: string }; +type ReposListTagsResponseItem = { + commit: ReposListTagsResponseItemCommit; + name: string; + tarball_url: string; + zipball_url: string; +}; +type ReposListStatusesForRefResponseItemCreator = { avatar_url: string; events_url: string; followers_url: string; @@ -2585,32 +3069,40 @@ type TeamsCreateDiscussionCommentLegacyResponseAuthor = { type: string; url: string; }; -type TeamsCreateDiscussionCommentLegacyResponse = { - author: TeamsCreateDiscussionCommentLegacyResponseAuthor; - body: string; - body_html: string; - body_version: string; +type ReposListStatusesForRefResponseItem = { + avatar_url: string; + context: string; created_at: string; - discussion_url: string; - html_url: string; - last_edited_at: null; + creator: ReposListStatusesForRefResponseItemCreator; + description: string; + id: number; node_id: string; - number: number; - reactions: TeamsCreateDiscussionCommentLegacyResponseReactions; + state: string; + target_url: string; updated_at: string; url: string; }; -type TeamsCreateDiscussionCommentInOrgResponseReactions = { - "+1": number; - "-1": number; - confused: number; - heart: number; - hooray: number; - laugh: number; - total_count: number; +type ReposListReleasesResponseItemAuthor = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; url: string; }; -type TeamsCreateDiscussionCommentInOrgResponseAuthor = { +type ReposListReleasesResponseItemAssetsItemUploader = { avatar_url: string; events_url: string; followers_url: string; @@ -2630,32 +3122,42 @@ type TeamsCreateDiscussionCommentInOrgResponseAuthor = { type: string; url: string; }; -type TeamsCreateDiscussionCommentInOrgResponse = { - author: TeamsCreateDiscussionCommentInOrgResponseAuthor; - body: string; - body_html: string; - body_version: string; +type ReposListReleasesResponseItemAssetsItem = { + browser_download_url: string; + content_type: string; created_at: string; - discussion_url: string; - html_url: string; - last_edited_at: null; + download_count: number; + id: number; + label: string; + name: string; node_id: string; - number: number; - reactions: TeamsCreateDiscussionCommentInOrgResponseReactions; + size: number; + state: string; updated_at: string; + uploader: ReposListReleasesResponseItemAssetsItemUploader; url: string; }; -type TeamsCreateDiscussionCommentResponseReactions = { - "+1": number; - "-1": number; - confused: number; - heart: number; - hooray: number; - laugh: number; - total_count: number; +type ReposListReleasesResponseItem = { + assets: Array; + assets_url: string; + author: ReposListReleasesResponseItemAuthor; + body: string; + created_at: string; + draft: boolean; + html_url: string; + id: number; + name: string; + node_id: string; + prerelease: boolean; + published_at: string; + tag_name: string; + tarball_url: string; + target_commitish: string; + upload_url: string; url: string; + zipball_url: string; }; -type TeamsCreateDiscussionCommentResponseAuthor = { +type ReposListPullRequestsAssociatedWithCommitResponseItemUser = { avatar_url: string; events_url: string; followers_url: string; @@ -2675,32 +3177,41 @@ type TeamsCreateDiscussionCommentResponseAuthor = { type: string; url: string; }; -type TeamsCreateDiscussionCommentResponse = { - author: TeamsCreateDiscussionCommentResponseAuthor; - body: string; - body_html: string; - body_version: string; - created_at: string; - discussion_url: string; +type ReposListPullRequestsAssociatedWithCommitResponseItemRequestedTeamsItem = { + description: string; html_url: string; - last_edited_at: null; + id: number; + members_url: string; + name: string; node_id: string; - number: number; - reactions: TeamsCreateDiscussionCommentResponseReactions; - updated_at: string; + parent: null; + permission: string; + privacy: string; + repositories_url: string; + slug: string; url: string; }; -type TeamsCreateDiscussionResponseReactions = { - "+1": number; - "-1": number; - confused: number; - heart: number; - hooray: number; - laugh: number; - total_count: number; +type ReposListPullRequestsAssociatedWithCommitResponseItemRequestedReviewersItem = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; url: string; }; -type TeamsCreateDiscussionResponseAuthor = { +type ReposListPullRequestsAssociatedWithCommitResponseItemMilestoneCreator = { avatar_url: string; events_url: string; followers_url: string; @@ -2720,80 +3231,59 @@ type TeamsCreateDiscussionResponseAuthor = { type: string; url: string; }; -type TeamsCreateDiscussionResponse = { - author: TeamsCreateDiscussionResponseAuthor; - body: string; - body_html: string; - body_version: string; - comments_count: number; - comments_url: string; +type ReposListPullRequestsAssociatedWithCommitResponseItemMilestone = { + closed_at: string; + closed_issues: number; created_at: string; + creator: ReposListPullRequestsAssociatedWithCommitResponseItemMilestoneCreator; + description: string; + due_on: string; html_url: string; - last_edited_at: null; + id: number; + labels_url: string; node_id: string; number: number; - pinned: boolean; - private: boolean; - reactions: TeamsCreateDiscussionResponseReactions; - team_url: string; + open_issues: number; + state: string; title: string; updated_at: string; url: string; }; -type TeamsCreateResponseOrganization = { - avatar_url: string; - blog: string; - company: string; - created_at: string; +type ReposListPullRequestsAssociatedWithCommitResponseItemLabelsItem = { + color: string; + default: boolean; description: string; - email: string; - events_url: string; - followers: number; - following: number; - has_organization_projects: boolean; - has_repository_projects: boolean; - hooks_url: string; - html_url: string; id: number; - is_verified: boolean; - issues_url: string; - location: string; - login: string; - members_url: string; name: string; node_id: string; - public_gists: number; - public_members_url: string; - public_repos: number; - repos_url: string; - type: string; url: string; }; -type TeamsCreateResponse = { - created_at: string; - description: string; +type ReposListPullRequestsAssociatedWithCommitResponseItemHeadUser = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; html_url: string; id: number; - members_count: number; - members_url: string; - name: string; + login: string; node_id: string; - organization: TeamsCreateResponseOrganization; - parent: null; - permission: string; - privacy: string; - repos_count: number; - repositories_url: string; - slug: string; - updated_at: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; url: string; }; -type TeamsCheckManagesRepoLegacyResponsePermissions = { +type ReposListPullRequestsAssociatedWithCommitResponseItemHeadRepoPermissions = { admin: boolean; pull: boolean; push: boolean; }; -type TeamsCheckManagesRepoLegacyResponseOwner = { +type ReposListPullRequestsAssociatedWithCommitResponseItemHeadRepoOwner = { avatar_url: string; events_url: string; followers_url: string; @@ -2813,7 +3303,7 @@ type TeamsCheckManagesRepoLegacyResponseOwner = { type: string; url: string; }; -type TeamsCheckManagesRepoLegacyResponse = { +type ReposListPullRequestsAssociatedWithCommitResponseItemHeadRepo = { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; @@ -2869,8 +3359,8 @@ type TeamsCheckManagesRepoLegacyResponse = { node_id: string; notifications_url: string; open_issues_count: number; - owner: TeamsCheckManagesRepoLegacyResponseOwner; - permissions: TeamsCheckManagesRepoLegacyResponsePermissions; + owner: ReposListPullRequestsAssociatedWithCommitResponseItemHeadRepoOwner; + permissions: ReposListPullRequestsAssociatedWithCommitResponseItemHeadRepoPermissions; private: boolean; pulls_url: string; pushed_at: string; @@ -2895,12 +3385,39 @@ type TeamsCheckManagesRepoLegacyResponse = { visibility: string; watchers_count: number; }; -type TeamsCheckManagesRepoInOrgResponsePermissions = { +type ReposListPullRequestsAssociatedWithCommitResponseItemHead = { + label: string; + ref: string; + repo: ReposListPullRequestsAssociatedWithCommitResponseItemHeadRepo; + sha: string; + user: ReposListPullRequestsAssociatedWithCommitResponseItemHeadUser; +}; +type ReposListPullRequestsAssociatedWithCommitResponseItemBaseUser = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; +}; +type ReposListPullRequestsAssociatedWithCommitResponseItemBaseRepoPermissions = { admin: boolean; pull: boolean; push: boolean; }; -type TeamsCheckManagesRepoInOrgResponseOwner = { +type ReposListPullRequestsAssociatedWithCommitResponseItemBaseRepoOwner = { avatar_url: string; events_url: string; followers_url: string; @@ -2920,7 +3437,7 @@ type TeamsCheckManagesRepoInOrgResponseOwner = { type: string; url: string; }; -type TeamsCheckManagesRepoInOrgResponse = { +type ReposListPullRequestsAssociatedWithCommitResponseItemBaseRepo = { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; @@ -2976,8 +3493,8 @@ type TeamsCheckManagesRepoInOrgResponse = { node_id: string; notifications_url: string; open_issues_count: number; - owner: TeamsCheckManagesRepoInOrgResponseOwner; - permissions: TeamsCheckManagesRepoInOrgResponsePermissions; + owner: ReposListPullRequestsAssociatedWithCommitResponseItemBaseRepoOwner; + permissions: ReposListPullRequestsAssociatedWithCommitResponseItemBaseRepoPermissions; private: boolean; pulls_url: string; pushed_at: string; @@ -3002,12 +3519,14 @@ type TeamsCheckManagesRepoInOrgResponse = { visibility: string; watchers_count: number; }; -type TeamsCheckManagesRepoResponsePermissions = { - admin: boolean; - pull: boolean; - push: boolean; +type ReposListPullRequestsAssociatedWithCommitResponseItemBase = { + label: string; + ref: string; + repo: ReposListPullRequestsAssociatedWithCommitResponseItemBaseRepo; + sha: string; + user: ReposListPullRequestsAssociatedWithCommitResponseItemBaseUser; }; -type TeamsCheckManagesRepoResponseOwner = { +type ReposListPullRequestsAssociatedWithCommitResponseItemAssigneesItem = { avatar_url: string; events_url: string; followers_url: string; @@ -3027,157 +3546,180 @@ type TeamsCheckManagesRepoResponseOwner = { type: string; url: string; }; -type TeamsCheckManagesRepoResponse = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; +type ReposListPullRequestsAssociatedWithCommitResponseItemAssignee = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; +}; +type ReposListPullRequestsAssociatedWithCommitResponseItemLinksStatuses = { + href: string; +}; +type ReposListPullRequestsAssociatedWithCommitResponseItemLinksSelf = { + href: string; +}; +type ReposListPullRequestsAssociatedWithCommitResponseItemLinksReviewComments = { + href: string; +}; +type ReposListPullRequestsAssociatedWithCommitResponseItemLinksReviewComment = { + href: string; +}; +type ReposListPullRequestsAssociatedWithCommitResponseItemLinksIssue = { + href: string; +}; +type ReposListPullRequestsAssociatedWithCommitResponseItemLinksHtml = { + href: string; +}; +type ReposListPullRequestsAssociatedWithCommitResponseItemLinksCommits = { + href: string; +}; +type ReposListPullRequestsAssociatedWithCommitResponseItemLinksComments = { + href: string; +}; +type ReposListPullRequestsAssociatedWithCommitResponseItemLinks = { + comments: ReposListPullRequestsAssociatedWithCommitResponseItemLinksComments; + commits: ReposListPullRequestsAssociatedWithCommitResponseItemLinksCommits; + html: ReposListPullRequestsAssociatedWithCommitResponseItemLinksHtml; + issue: ReposListPullRequestsAssociatedWithCommitResponseItemLinksIssue; + review_comment: ReposListPullRequestsAssociatedWithCommitResponseItemLinksReviewComment; + review_comments: ReposListPullRequestsAssociatedWithCommitResponseItemLinksReviewComments; + self: ReposListPullRequestsAssociatedWithCommitResponseItemLinksSelf; + statuses: ReposListPullRequestsAssociatedWithCommitResponseItemLinksStatuses; +}; +type ReposListPullRequestsAssociatedWithCommitResponseItem = { + _links: ReposListPullRequestsAssociatedWithCommitResponseItemLinks; + active_lock_reason: string; + assignee: ReposListPullRequestsAssociatedWithCommitResponseItemAssignee; + assignees: Array< + ReposListPullRequestsAssociatedWithCommitResponseItemAssigneesItem + >; + author_association: string; + base: ReposListPullRequestsAssociatedWithCommitResponseItemBase; + body: string; + closed_at: string; + comments_url: string; + commits_url: string; + created_at: string; + diff_url: string; + draft: boolean; + head: ReposListPullRequestsAssociatedWithCommitResponseItemHead; + html_url: string; + id: number; + issue_url: string; + labels: Array< + ReposListPullRequestsAssociatedWithCommitResponseItemLabelsItem + >; + locked: boolean; + merge_commit_sha: string; + merged_at: string; + milestone: ReposListPullRequestsAssociatedWithCommitResponseItemMilestone; + node_id: string; + number: number; + patch_url: string; + requested_reviewers: Array< + ReposListPullRequestsAssociatedWithCommitResponseItemRequestedReviewersItem + >; + requested_teams: Array< + ReposListPullRequestsAssociatedWithCommitResponseItemRequestedTeamsItem + >; + review_comment_url: string; + review_comments_url: string; + state: string; + statuses_url: string; + title: string; + updated_at: string; + url: string; + user: ReposListPullRequestsAssociatedWithCommitResponseItemUser; +}; +type ReposListPublicResponseItemOwner = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; +}; +type ReposListPublicResponseItem = { archive_url: string; - archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; - clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; - created_at: string; - default_branch: string; deployments_url: string; description: string; - disabled: boolean; downloads_url: string; events_url: string; fork: boolean; - forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; html_url: string; id: number; - is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; - language: null; languages_url: string; merges_url: string; milestones_url: string; - mirror_url: string; name: string; - network_count: number; node_id: string; notifications_url: string; - open_issues_count: number; - owner: TeamsCheckManagesRepoResponseOwner; - permissions: TeamsCheckManagesRepoResponsePermissions; + owner: ReposListPublicResponseItemOwner; private: boolean; pulls_url: string; - pushed_at: string; releases_url: string; - size: number; ssh_url: string; - stargazers_count: number; stargazers_url: string; statuses_url: string; - subscribers_count: number; subscribers_url: string; subscription_url: string; - svn_url: string; tags_url: string; teams_url: string; - temp_clone_token: string; - template_repository: null; - topics: Array; trees_url: string; - updated_at: string; - url: string; - visibility: string; - watchers_count: number; -}; -type TeamsAddOrUpdateProjectLegacyResponse = { - documentation_url: string; - message: string; -}; -type TeamsAddOrUpdateProjectInOrgResponse = { - documentation_url: string; - message: string; -}; -type TeamsAddOrUpdateProjectResponse = { - documentation_url: string; - message: string; -}; -type TeamsAddOrUpdateMembershipLegacyResponse = { - role: string; - state: string; - url: string; -}; -type TeamsAddOrUpdateMembershipInOrgResponse = { - role: string; - state: string; - url: string; -}; -type TeamsAddOrUpdateMembershipResponse = { - role: string; - state: string; url: string; }; -type TeamsAddMemberLegacyResponseErrorsItem = { - code: string; - field: string; - resource: string; -}; -type TeamsAddMemberLegacyResponse = { - errors: Array; - message: string; -}; -type TeamsAddMemberResponseErrorsItem = { - code: string; - field: string; - resource: string; -}; -type TeamsAddMemberResponse = { - errors: Array; - message: string; -}; -type SearchUsersLegacyResponseUsersItem = { - created: string; - created_at: string; - followers: number; - followers_count: number; - fullname: string; - gravatar_id: string; - id: string; - language: string; - location: string; - login: string; - name: string; - public_repo_count: number; - repos: number; - score: number; - type: string; - username: string; -}; -type SearchUsersLegacyResponse = { - users: Array; -}; -type SearchUsersResponseItemsItem = { +type ReposListPagesBuildsResponseItemPusher = { avatar_url: string; + events_url: string; followers_url: string; + following_url: string; + gists_url: string; gravatar_id: string; html_url: string; id: number; @@ -3186,136 +3728,94 @@ type SearchUsersResponseItemsItem = { organizations_url: string; received_events_url: string; repos_url: string; - score: number; + site_admin: boolean; + starred_url: string; subscriptions_url: string; type: string; url: string; }; -type SearchUsersResponse = { - incomplete_results: boolean; - items: Array; - total_count: number; -}; -type SearchTopicsResponseItemsItem = { +type ReposListPagesBuildsResponseItemError = { message: null }; +type ReposListPagesBuildsResponseItem = { + commit: string; created_at: string; - created_by: string; - curated: boolean; - description: string; - display_name: string; - featured: boolean; - name: string; - released: string; - score: number; - short_description: string; + duration: number; + error: ReposListPagesBuildsResponseItemError; + pusher: ReposListPagesBuildsResponseItemPusher; + status: string; updated_at: string; -}; -type SearchTopicsResponse = { - incomplete_results: boolean; - items: Array; - total_count: number; -}; -type SearchReposLegacyResponseRepositoriesItem = { - created: string; - created_at: string; - description: string; - followers: number; - fork: boolean; - forks: number; - has_downloads: boolean; - has_issues: boolean; - has_wiki: boolean; - homepage: string; - language: string; - name: string; - open_issues: number; - owner: string; - private: boolean; - pushed: string; - pushed_at: string; - score: number; - size: number; - type: string; url: string; - username: string; - watchers: number; -}; -type SearchReposLegacyResponse = { - repositories: Array; }; -type SearchReposResponseItemsItemOwner = { +type ReposListLanguagesResponse = { C: number; Python: number }; +type ReposListInvitationsForAuthenticatedUserResponseItemRepositoryOwner = { avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; gravatar_id: string; + html_url: string; id: number; login: string; node_id: string; + organizations_url: string; received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; type: string; url: string; }; -type SearchReposResponseItemsItem = { - created_at: string; - default_branch: string; +type ReposListInvitationsForAuthenticatedUserResponseItemRepository = { + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; description: string; + downloads_url: string; + events_url: string; fork: boolean; - forks_count: number; + forks_url: string; full_name: string; - homepage: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; html_url: string; id: number; - language: string; - master_branch: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; name: string; node_id: string; - open_issues_count: number; - owner: SearchReposResponseItemsItemOwner; + notifications_url: string; + owner: ReposListInvitationsForAuthenticatedUserResponseItemRepositoryOwner; private: boolean; - pushed_at: string; - score: number; - size: number; - stargazers_count: number; - updated_at: string; - url: string; - watchers_count: number; -}; -type SearchReposResponse = { - incomplete_results: boolean; - items: Array; - total_count: number; -}; -type SearchLabelsResponseItemsItem = { - color: string; - default: boolean; - description: string; - id: number; - name: string; - node_id: string; - score: number; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; url: string; }; -type SearchLabelsResponse = { - incomplete_results: boolean; - items: Array; - total_count: number; -}; -type SearchIssuesLegacyResponseIssuesItem = { - body: string; - comments: number; - created_at: string; - gravatar_id: string; - html_url: string; - labels: Array; - number: number; - position: number; - state: string; - title: string; - updated_at: string; - user: string; - votes: number; -}; -type SearchIssuesLegacyResponse = { - issues: Array; -}; -type SearchIssuesAndPullRequestsResponseItemsItemUser = { +type ReposListInvitationsForAuthenticatedUserResponseItemInviter = { avatar_url: string; events_url: string; followers_url: string; @@ -3329,53 +3829,13 @@ type SearchIssuesAndPullRequestsResponseItemsItemUser = { organizations_url: string; received_events_url: string; repos_url: string; + site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string; }; -type SearchIssuesAndPullRequestsResponseItemsItemPullRequest = { - diff_url: null; - html_url: null; - patch_url: null; -}; -type SearchIssuesAndPullRequestsResponseItemsItemLabelsItem = { - color: string; - id: number; - name: string; - node_id: string; - url: string; -}; -type SearchIssuesAndPullRequestsResponseItemsItem = { - assignee: null; - body: string; - closed_at: null; - comments: number; - comments_url: string; - created_at: string; - events_url: string; - html_url: string; - id: number; - labels: Array; - labels_url: string; - milestone: null; - node_id: string; - number: number; - pull_request: SearchIssuesAndPullRequestsResponseItemsItemPullRequest; - repository_url: string; - score: number; - state: string; - title: string; - updated_at: string; - url: string; - user: SearchIssuesAndPullRequestsResponseItemsItemUser; -}; -type SearchIssuesAndPullRequestsResponse = { - incomplete_results: boolean; - items: Array; - total_count: number; -}; -type SearchIssuesResponseItemsItemUser = { +type ReposListInvitationsForAuthenticatedUserResponseItemInvitee = { avatar_url: string; events_url: string; followers_url: string; @@ -3389,71 +3849,23 @@ type SearchIssuesResponseItemsItemUser = { organizations_url: string; received_events_url: string; repos_url: string; + site_admin: boolean; starred_url: string; subscriptions_url: string; type: string; url: string; }; -type SearchIssuesResponseItemsItemPullRequest = { - diff_url: null; - html_url: null; - patch_url: null; -}; -type SearchIssuesResponseItemsItemLabelsItem = { - color: string; - id: number; - name: string; - node_id: string; - url: string; -}; -type SearchIssuesResponseItemsItem = { - assignee: null; - body: string; - closed_at: null; - comments: number; - comments_url: string; +type ReposListInvitationsForAuthenticatedUserResponseItem = { created_at: string; - events_url: string; html_url: string; id: number; - labels: Array; - labels_url: string; - milestone: null; - node_id: string; - number: number; - pull_request: SearchIssuesResponseItemsItemPullRequest; - repository_url: string; - score: number; - state: string; - title: string; - updated_at: string; + invitee: ReposListInvitationsForAuthenticatedUserResponseItemInvitee; + inviter: ReposListInvitationsForAuthenticatedUserResponseItemInviter; + permissions: string; + repository: ReposListInvitationsForAuthenticatedUserResponseItemRepository; url: string; - user: SearchIssuesResponseItemsItemUser; -}; -type SearchIssuesResponse = { - incomplete_results: boolean; - items: Array; - total_count: number; }; -type SearchEmailLegacyResponseUser = { - blog: string; - company: string; - created: string; - created_at: string; - email: string; - followers_count: number; - following_count: number; - gravatar_id: string; - id: number; - location: string; - login: string; - name: string; - public_gist_count: number; - public_repo_count: number; - type: string; -}; -type SearchEmailLegacyResponse = { user: SearchEmailLegacyResponseUser }; -type SearchCommitsResponseItemsItemRepositoryOwner = { +type ReposListInvitationsResponseItemRepositoryOwner = { avatar_url: string; events_url: string; followers_url: string; @@ -3473,7 +3885,7 @@ type SearchCommitsResponseItemsItemRepositoryOwner = { type: string; url: string; }; -type SearchCommitsResponseItemsItemRepository = { +type ReposListInvitationsResponseItemRepository = { archive_url: string; assignees_url: string; blobs_url: string; @@ -3494,7 +3906,7 @@ type SearchCommitsResponseItemsItemRepository = { git_commits_url: string; git_refs_url: string; git_tags_url: string; - hooks_url: string; + git_url: string; html_url: string; id: number; issue_comment_url: string; @@ -3508,10 +3920,11 @@ type SearchCommitsResponseItemsItemRepository = { name: string; node_id: string; notifications_url: string; - owner: SearchCommitsResponseItemsItemRepositoryOwner; + owner: ReposListInvitationsResponseItemRepositoryOwner; private: boolean; pulls_url: string; releases_url: string; + ssh_url: string; stargazers_url: string; statuses_url: string; subscribers_url: string; @@ -3521,12 +3934,7 @@ type SearchCommitsResponseItemsItemRepository = { trees_url: string; url: string; }; -type SearchCommitsResponseItemsItemParentsItem = { - html_url: string; - sha: string; - url: string; -}; -type SearchCommitsResponseItemsItemCommitter = { +type ReposListInvitationsResponseItemInviter = { avatar_url: string; events_url: string; followers_url: string; @@ -3546,26 +3954,7 @@ type SearchCommitsResponseItemsItemCommitter = { type: string; url: string; }; -type SearchCommitsResponseItemsItemCommitTree = { sha: string; url: string }; -type SearchCommitsResponseItemsItemCommitCommitter = { - date: string; - email: string; - name: string; -}; -type SearchCommitsResponseItemsItemCommitAuthor = { - date: string; - email: string; - name: string; -}; -type SearchCommitsResponseItemsItemCommit = { - author: SearchCommitsResponseItemsItemCommitAuthor; - comment_count: number; - committer: SearchCommitsResponseItemsItemCommitCommitter; - message: string; - tree: SearchCommitsResponseItemsItemCommitTree; - url: string; -}; -type SearchCommitsResponseItemsItemAuthor = { +type ReposListInvitationsResponseItemInvitee = { avatar_url: string; events_url: string; followers_url: string; @@ -3585,24 +3974,46 @@ type SearchCommitsResponseItemsItemAuthor = { type: string; url: string; }; -type SearchCommitsResponseItemsItem = { - author: SearchCommitsResponseItemsItemAuthor; - comments_url: string; - commit: SearchCommitsResponseItemsItemCommit; - committer: SearchCommitsResponseItemsItemCommitter; +type ReposListInvitationsResponseItem = { + created_at: string; html_url: string; - parents: Array; - repository: SearchCommitsResponseItemsItemRepository; - score: number; - sha: string; + id: number; + invitee: ReposListInvitationsResponseItemInvitee; + inviter: ReposListInvitationsResponseItemInviter; + permissions: string; + repository: ReposListInvitationsResponseItemRepository; url: string; }; -type SearchCommitsResponse = { - incomplete_results: boolean; - items: Array; - total_count: number; +type ReposListHooksResponseItemLastResponse = { + code: null; + message: null; + status: string; }; -type SearchCodeResponseItemsItemRepositoryOwner = { +type ReposListHooksResponseItemConfig = { + content_type: string; + insecure_ssl: string; + url: string; +}; +type ReposListHooksResponseItem = { + active: boolean; + config: ReposListHooksResponseItemConfig; + created_at: string; + events: Array; + id: number; + last_response: ReposListHooksResponseItemLastResponse; + name: string; + ping_url: string; + test_url: string; + type: string; + updated_at: string; + url: string; +}; +type ReposListForksResponseItemPermissions = { + admin: boolean; + pull: boolean; + push: boolean; +}; +type ReposListForksResponseItemOwner = { avatar_url: string; events_url: string; followers_url: string; @@ -3622,68 +4033,99 @@ type SearchCodeResponseItemsItemRepositoryOwner = { type: string; url: string; }; -type SearchCodeResponseItemsItemRepository = { +type ReposListForksResponseItemLicense = { + key: string; + name: string; + node_id: string; + spdx_id: string; + url: string; +}; +type ReposListForksResponseItem = { archive_url: string; + archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; + clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; + created_at: string; + default_branch: string; + deployments_url: string; description: string; + disabled: boolean; downloads_url: string; events_url: string; fork: boolean; + forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; + git_url: string; + has_downloads: boolean; + has_issues: boolean; + has_pages: boolean; + has_projects: boolean; + has_wiki: boolean; + homepage: string; hooks_url: string; html_url: string; id: number; + is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; + language: null; languages_url: string; + license: ReposListForksResponseItemLicense; merges_url: string; milestones_url: string; + mirror_url: string; name: string; + network_count: number; node_id: string; notifications_url: string; - owner: SearchCodeResponseItemsItemRepositoryOwner; + open_issues_count: number; + owner: ReposListForksResponseItemOwner; + permissions: ReposListForksResponseItemPermissions; private: boolean; pulls_url: string; + pushed_at: string; + releases_url: string; + size: number; + ssh_url: string; + stargazers_count: number; stargazers_url: string; statuses_url: string; + subscribers_count: number; subscribers_url: string; subscription_url: string; + svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; + template_repository: null; + topics: Array; trees_url: string; + updated_at: string; url: string; + visibility: string; + watchers_count: number; }; -type SearchCodeResponseItemsItem = { - git_url: string; - html_url: string; - name: string; - path: string; - repository: SearchCodeResponseItemsItemRepository; - score: number; - sha: string; - url: string; -}; -type SearchCodeResponse = { - incomplete_results: boolean; - items: Array; - total_count: number; +type ReposListForOrgResponseItemPermissions = { + admin: boolean; + pull: boolean; + push: boolean; }; -type ReposUploadReleaseAssetResponseValueUploader = { +type ReposListForOrgResponseItemOwner = { avatar_url: string; events_url: string; followers_url: string; @@ -3703,60 +4145,105 @@ type ReposUploadReleaseAssetResponseValueUploader = { type: string; url: string; }; -type ReposUploadReleaseAssetResponseValue = { - browser_download_url: string; - content_type: string; - created_at: string; - download_count: number; - id: number; - label: string; +type ReposListForOrgResponseItemLicense = { + key: string; name: string; node_id: string; - size: number; - state: string; - updated_at: string; - uploader: ReposUploadReleaseAssetResponseValueUploader; + spdx_id: string; url: string; }; -type ReposUploadReleaseAssetResponse = { - value: ReposUploadReleaseAssetResponseValue; -}; -type ReposUpdateReleaseAssetResponseUploader = { - avatar_url: string; +type ReposListForOrgResponseItem = { + archive_url: string; + archived: boolean; + assignees_url: string; + blobs_url: string; + branches_url: string; + clone_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + created_at: string; + default_branch: string; + deployments_url: string; + description: string; + disabled: boolean; + downloads_url: string; events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; + fork: boolean; + forks_count: number; + forks_url: string; + full_name: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + has_downloads: boolean; + has_issues: boolean; + has_pages: boolean; + has_projects: boolean; + has_wiki: boolean; + homepage: string; + hooks_url: string; html_url: string; id: number; - login: string; + is_template: boolean; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + language: null; + languages_url: string; + license: ReposListForOrgResponseItemLicense; + merges_url: string; + milestones_url: string; + mirror_url: string; + name: string; + network_count: number; node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; + notifications_url: string; + open_issues_count: number; + owner: ReposListForOrgResponseItemOwner; + permissions: ReposListForOrgResponseItemPermissions; + private: boolean; + pulls_url: string; + pushed_at: string; + releases_url: string; + size: number; + ssh_url: string; + stargazers_count: number; + stargazers_url: string; + statuses_url: string; + subscribers_count: number; + subscribers_url: string; + subscription_url: string; + svn_url: string; + tags_url: string; + teams_url: string; + temp_clone_token: string; + template_repository: null; + topics: Array; + trees_url: string; + updated_at: string; url: string; + visibility: string; + watchers_count: number; }; -type ReposUpdateReleaseAssetResponse = { - browser_download_url: string; +type ReposListDownloadsResponseItem = { content_type: string; - created_at: string; + description: string; download_count: number; + html_url: string; id: number; - label: string; name: string; - node_id: string; size: number; - state: string; - updated_at: string; - uploader: ReposUpdateReleaseAssetResponseUploader; url: string; }; -type ReposUpdateReleaseResponseAuthor = { +type ReposListDeploymentsResponseItemPayload = { deploy: string }; +type ReposListDeploymentsResponseItemCreator = { avatar_url: string; events_url: string; followers_url: string; @@ -3776,7 +4263,26 @@ type ReposUpdateReleaseResponseAuthor = { type: string; url: string; }; -type ReposUpdateReleaseResponseAssetsItemUploader = { +type ReposListDeploymentsResponseItem = { + created_at: string; + creator: ReposListDeploymentsResponseItemCreator; + description: string; + environment: string; + id: number; + node_id: string; + original_environment: string; + payload: ReposListDeploymentsResponseItemPayload; + production_environment: boolean; + ref: string; + repository_url: string; + sha: string; + statuses_url: string; + task: string; + transient_environment: boolean; + updated_at: string; + url: string; +}; +type ReposListDeploymentStatusesResponseItemCreator = { avatar_url: string; events_url: string; followers_url: string; @@ -3796,49 +4302,34 @@ type ReposUpdateReleaseResponseAssetsItemUploader = { type: string; url: string; }; -type ReposUpdateReleaseResponseAssetsItem = { - browser_download_url: string; - content_type: string; +type ReposListDeploymentStatusesResponseItem = { created_at: string; - download_count: number; + creator: ReposListDeploymentStatusesResponseItemCreator; + deployment_url: string; + description: string; + environment: string; + environment_url: string; id: number; - label: string; - name: string; + log_url: string; node_id: string; - size: number; + repository_url: string; state: string; + target_url: string; updated_at: string; - uploader: ReposUpdateReleaseResponseAssetsItemUploader; url: string; }; -type ReposUpdateReleaseResponse = { - assets: Array; - assets_url: string; - author: ReposUpdateReleaseResponseAuthor; - body: string; +type ReposListDeployKeysResponseItem = { created_at: string; - draft: boolean; - html_url: string; id: number; - name: string; - node_id: string; - prerelease: boolean; - published_at: string; - tag_name: string; - tarball_url: string; - target_commitish: string; - upload_url: string; - url: string; - zipball_url: string; -}; -type ReposUpdateProtectedBranchRequiredStatusChecksResponse = { - contexts: Array; - contexts_url: string; - strict: boolean; + key: string; + read_only: boolean; + title: string; url: string; + verified: boolean; }; -type ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsUsersItem = { +type ReposListContributorsResponseItem = { avatar_url: string; + contributions: number; events_url: string; followers_url: string; following_url: string; @@ -3857,39 +4348,8 @@ type ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDismissalRest type: string; url: string; }; -type ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsTeamsItem = { - description: string; - html_url: string; - id: number; - members_url: string; - name: string; - node_id: string; - parent: null; - permission: string; - privacy: string; - repositories_url: string; - slug: string; - url: string; -}; -type ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictions = { - teams: Array< - ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsTeamsItem - >; - teams_url: string; - url: string; - users: Array< - ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsUsersItem - >; - users_url: string; -}; -type ReposUpdateProtectedBranchPullRequestReviewEnforcementResponse = { - dismiss_stale_reviews: boolean; - dismissal_restrictions: ReposUpdateProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictions; - require_code_owner_reviews: boolean; - required_approving_review_count: number; - url: string; -}; -type ReposUpdateInvitationResponseRepositoryOwner = { +type ReposListCommitsResponseItemParentsItem = { sha: string; url: string }; +type ReposListCommitsResponseItemCommitter = { avatar_url: string; events_url: string; followers_url: string; @@ -3909,56 +4369,33 @@ type ReposUpdateInvitationResponseRepositoryOwner = { type: string; url: string; }; -type ReposUpdateInvitationResponseRepository = { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - deployments_url: string; - description: string; - downloads_url: string; - events_url: string; - fork: boolean; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - html_url: string; - id: number; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - languages_url: string; - merges_url: string; - milestones_url: string; +type ReposListCommitsResponseItemCommitVerification = { + payload: null; + reason: string; + signature: null; + verified: boolean; +}; +type ReposListCommitsResponseItemCommitTree = { sha: string; url: string }; +type ReposListCommitsResponseItemCommitCommitter = { + date: string; + email: string; name: string; - node_id: string; - notifications_url: string; - owner: ReposUpdateInvitationResponseRepositoryOwner; - private: boolean; - pulls_url: string; - releases_url: string; - ssh_url: string; - stargazers_url: string; - statuses_url: string; - subscribers_url: string; - subscription_url: string; - tags_url: string; - teams_url: string; - trees_url: string; +}; +type ReposListCommitsResponseItemCommitAuthor = { + date: string; + email: string; + name: string; +}; +type ReposListCommitsResponseItemCommit = { + author: ReposListCommitsResponseItemCommitAuthor; + comment_count: number; + committer: ReposListCommitsResponseItemCommitCommitter; + message: string; + tree: ReposListCommitsResponseItemCommitTree; url: string; + verification: ReposListCommitsResponseItemCommitVerification; }; -type ReposUpdateInvitationResponseInviter = { +type ReposListCommitsResponseItemAuthor = { avatar_url: string; events_url: string; followers_url: string; @@ -3978,7 +4415,18 @@ type ReposUpdateInvitationResponseInviter = { type: string; url: string; }; -type ReposUpdateInvitationResponseInvitee = { +type ReposListCommitsResponseItem = { + author: ReposListCommitsResponseItemAuthor; + comments_url: string; + commit: ReposListCommitsResponseItemCommit; + committer: ReposListCommitsResponseItemCommitter; + html_url: string; + node_id: string; + parents: Array; + sha: string; + url: string; +}; +type ReposListCommitCommentsResponseItemUser = { avatar_url: string; events_url: string; followers_url: string; @@ -3998,96 +4446,21 @@ type ReposUpdateInvitationResponseInvitee = { type: string; url: string; }; -type ReposUpdateInvitationResponse = { +type ReposListCommitCommentsResponseItem = { + body: string; + commit_id: string; created_at: string; html_url: string; id: number; - invitee: ReposUpdateInvitationResponseInvitee; - inviter: ReposUpdateInvitationResponseInviter; - permissions: string; - repository: ReposUpdateInvitationResponseRepository; - url: string; -}; -type ReposUpdateHookResponseLastResponse = { - code: null; - message: null; - status: string; -}; -type ReposUpdateHookResponseConfig = { - content_type: string; - insecure_ssl: string; - url: string; -}; -type ReposUpdateHookResponse = { - active: boolean; - config: ReposUpdateHookResponseConfig; - created_at: string; - events: Array; - id: number; - last_response: ReposUpdateHookResponseLastResponse; - name: string; - ping_url: string; - test_url: string; - type: string; - updated_at: string; - url: string; -}; -type ReposUpdateFileResponseContentLinks = { - git: string; - html: string; - self: string; -}; -type ReposUpdateFileResponseContent = { - _links: ReposUpdateFileResponseContentLinks; - download_url: string; - git_url: string; - html_url: string; - name: string; - path: string; - sha: string; - size: number; - type: string; - url: string; -}; -type ReposUpdateFileResponseCommitVerification = { - payload: null; - reason: string; - signature: null; - verified: boolean; -}; -type ReposUpdateFileResponseCommitTree = { sha: string; url: string }; -type ReposUpdateFileResponseCommitParentsItem = { - html_url: string; - sha: string; - url: string; -}; -type ReposUpdateFileResponseCommitCommitter = { - date: string; - email: string; - name: string; -}; -type ReposUpdateFileResponseCommitAuthor = { - date: string; - email: string; - name: string; -}; -type ReposUpdateFileResponseCommit = { - author: ReposUpdateFileResponseCommitAuthor; - committer: ReposUpdateFileResponseCommitCommitter; - html_url: string; - message: string; + line: number; node_id: string; - parents: Array; - sha: string; - tree: ReposUpdateFileResponseCommitTree; + path: string; + position: number; + updated_at: string; url: string; - verification: ReposUpdateFileResponseCommitVerification; -}; -type ReposUpdateFileResponse = { - commit: ReposUpdateFileResponseCommit; - content: ReposUpdateFileResponseContent; + user: ReposListCommitCommentsResponseItemUser; }; -type ReposUpdateCommitCommentResponseUser = { +type ReposListCommentsForCommitResponseItemUser = { avatar_url: string; events_url: string; followers_url: string; @@ -4107,7 +4480,7 @@ type ReposUpdateCommitCommentResponseUser = { type: string; url: string; }; -type ReposUpdateCommitCommentResponse = { +type ReposListCommentsForCommitResponseItem = { body: string; commit_id: string; created_at: string; @@ -4119,9 +4492,14 @@ type ReposUpdateCommitCommentResponse = { position: number; updated_at: string; url: string; - user: ReposUpdateCommitCommentResponseUser; + user: ReposListCommentsForCommitResponseItemUser; }; -type ReposUpdateBranchProtectionResponseRestrictionsUsersItem = { +type ReposListCollaboratorsResponseItemPermissions = { + admin: boolean; + pull: boolean; + push: boolean; +}; +type ReposListCollaboratorsResponseItem = { avatar_url: string; events_url: string; followers_url: string; @@ -4133,6 +4511,7 @@ type ReposUpdateBranchProtectionResponseRestrictionsUsersItem = { login: string; node_id: string; organizations_url: string; + permissions: ReposListCollaboratorsResponseItemPermissions; received_events_url: string; repos_url: string; site_admin: boolean; @@ -4141,70 +4520,77 @@ type ReposUpdateBranchProtectionResponseRestrictionsUsersItem = { type: string; url: string; }; -type ReposUpdateBranchProtectionResponseRestrictionsTeamsItem = { - description: string; - html_url: string; - id: number; - members_url: string; - name: string; - node_id: string; - parent: null; - permission: string; - privacy: string; - repositories_url: string; - slug: string; +type ReposListBranchesForHeadCommitResponseItemCommit = { + sha: string; url: string; }; -type ReposUpdateBranchProtectionResponseRestrictionsAppsItemPermissions = { - contents: string; - issues: string; - metadata: string; - single_file: string; +type ReposListBranchesForHeadCommitResponseItem = { + commit: ReposListBranchesForHeadCommitResponseItemCommit; + name: string; + protected: string; }; -type ReposUpdateBranchProtectionResponseRestrictionsAppsItemOwner = { +type ReposListBranchesResponseItemProtectionRequiredStatusChecks = { + contexts: Array; + enforcement_level: string; +}; +type ReposListBranchesResponseItemProtection = { + enabled: boolean; + required_status_checks: ReposListBranchesResponseItemProtectionRequiredStatusChecks; +}; +type ReposListBranchesResponseItemCommit = { sha: string; url: string }; +type ReposListBranchesResponseItem = { + commit: ReposListBranchesResponseItemCommit; + name: string; + protected: boolean; + protection: ReposListBranchesResponseItemProtection; + protection_url: string; +}; +type ReposListAssetsForReleaseResponseItemUploader = { avatar_url: string; - description: string; events_url: string; - hooks_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; id: number; - issues_url: string; login: string; - members_url: string; node_id: string; - public_members_url: string; + organizations_url: string; + received_events_url: string; repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; url: string; }; -type ReposUpdateBranchProtectionResponseRestrictionsAppsItem = { +type ReposListAssetsForReleaseResponseItem = { + browser_download_url: string; + content_type: string; created_at: string; - description: string; - events: Array; - external_url: string; - html_url: string; + download_count: number; id: number; + label: string; name: string; node_id: string; - owner: ReposUpdateBranchProtectionResponseRestrictionsAppsItemOwner; - permissions: ReposUpdateBranchProtectionResponseRestrictionsAppsItemPermissions; - slug: string; + size: number; + state: string; updated_at: string; -}; -type ReposUpdateBranchProtectionResponseRestrictions = { - apps: Array; - apps_url: string; - teams: Array; - teams_url: string; + uploader: ReposListAssetsForReleaseResponseItemUploader; url: string; - users: Array; - users_url: string; }; -type ReposUpdateBranchProtectionResponseRequiredStatusChecks = { - contexts: Array; - contexts_url: string; - strict: boolean; - url: string; +type ReposGetViewsResponseViewsItem = { + count: number; + timestamp: string; + uniques: number; }; -type ReposUpdateBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsUsersItem = { +type ReposGetViewsResponse = { + count: number; + uniques: number; + views: Array; +}; +type ReposGetUsersWithAccessToProtectedBranchResponseItem = { avatar_url: string; events_url: string; followers_url: string; @@ -4224,7 +4610,18 @@ type ReposUpdateBranchProtectionResponseRequiredPullRequestReviewsDismissalRestr type: string; url: string; }; -type ReposUpdateBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsTeamsItem = { +type ReposGetTopReferrersResponseItem = { + count: number; + referrer: string; + uniques: number; +}; +type ReposGetTopPathsResponseItem = { + count: number; + path: string; + title: string; + uniques: number; +}; +type ReposGetTeamsWithAccessToProtectedBranchResponseItem = { description: string; html_url: string; id: number; @@ -4238,49 +4635,27 @@ type ReposUpdateBranchProtectionResponseRequiredPullRequestReviewsDismissalRestr slug: string; url: string; }; -type ReposUpdateBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictions = { - teams: Array< - ReposUpdateBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsTeamsItem - >; - teams_url: string; - url: string; - users: Array< - ReposUpdateBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsUsersItem - >; - users_url: string; -}; -type ReposUpdateBranchProtectionResponseRequiredPullRequestReviews = { - dismiss_stale_reviews: boolean; - dismissal_restrictions: ReposUpdateBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictions; - require_code_owner_reviews: boolean; - required_approving_review_count: number; - url: string; -}; -type ReposUpdateBranchProtectionResponseRequiredLinearHistory = { - enabled: boolean; -}; -type ReposUpdateBranchProtectionResponseEnforceAdmins = { - enabled: boolean; - url: string; -}; -type ReposUpdateBranchProtectionResponseAllowForcePushes = { enabled: boolean }; -type ReposUpdateBranchProtectionResponseAllowDeletions = { enabled: boolean }; -type ReposUpdateBranchProtectionResponse = { - allow_deletions: ReposUpdateBranchProtectionResponseAllowDeletions; - allow_force_pushes: ReposUpdateBranchProtectionResponseAllowForcePushes; - enforce_admins: ReposUpdateBranchProtectionResponseEnforceAdmins; - required_linear_history: ReposUpdateBranchProtectionResponseRequiredLinearHistory; - required_pull_request_reviews: ReposUpdateBranchProtectionResponseRequiredPullRequestReviews; - required_status_checks: ReposUpdateBranchProtectionResponseRequiredStatusChecks; - restrictions: ReposUpdateBranchProtectionResponseRestrictions; +type ReposGetReleaseByTagResponseAuthor = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; url: string; }; -type ReposUpdateResponseSourcePermissions = { - admin: boolean; - pull: boolean; - push: boolean; -}; -type ReposUpdateResponseSourceOwner = { +type ReposGetReleaseByTagResponseAssetsItemUploader = { avatar_url: string; events_url: string; followers_url: string; @@ -4300,99 +4675,42 @@ type ReposUpdateResponseSourceOwner = { type: string; url: string; }; -type ReposUpdateResponseSource = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; +type ReposGetReleaseByTagResponseAssetsItem = { + browser_download_url: string; + content_type: string; created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; + download_count: number; id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; + label: string; name: string; - network_count: number; node_id: string; - notifications_url: string; - open_issues_count: number; - owner: ReposUpdateResponseSourceOwner; - permissions: ReposUpdateResponseSourcePermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - temp_clone_token: string; - template_repository: null; - topics: Array; - trees_url: string; + state: string; updated_at: string; + uploader: ReposGetReleaseByTagResponseAssetsItemUploader; url: string; - visibility: string; - watchers_count: number; -}; -type ReposUpdateResponsePermissions = { - admin: boolean; - pull: boolean; - push: boolean; }; -type ReposUpdateResponseParentPermissions = { - admin: boolean; - pull: boolean; - push: boolean; +type ReposGetReleaseByTagResponse = { + assets: Array; + assets_url: string; + author: ReposGetReleaseByTagResponseAuthor; + body: string; + created_at: string; + draft: boolean; + html_url: string; + id: number; + name: string; + node_id: string; + prerelease: boolean; + published_at: string; + tag_name: string; + tarball_url: string; + target_commitish: string; + upload_url: string; + url: string; + zipball_url: string; }; -type ReposUpdateResponseParentOwner = { +type ReposGetReleaseAssetResponseUploader = { avatar_url: string; events_url: string; followers_url: string; @@ -4412,89 +4730,22 @@ type ReposUpdateResponseParentOwner = { type: string; url: string; }; -type ReposUpdateResponseParent = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; +type ReposGetReleaseAssetResponse = { + browser_download_url: string; + content_type: string; created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; + download_count: number; id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; + label: string; name: string; - network_count: number; node_id: string; - notifications_url: string; - open_issues_count: number; - owner: ReposUpdateResponseParentOwner; - permissions: ReposUpdateResponseParentPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - temp_clone_token: string; - template_repository: null; - topics: Array; - trees_url: string; + state: string; updated_at: string; + uploader: ReposGetReleaseAssetResponseUploader; url: string; - visibility: string; - watchers_count: number; }; -type ReposUpdateResponseOwner = { +type ReposGetReleaseResponseAuthor = { avatar_url: string; events_url: string; followers_url: string; @@ -4514,7 +4765,7 @@ type ReposUpdateResponseOwner = { type: string; url: string; }; -type ReposUpdateResponseOrganization = { +type ReposGetReleaseResponseAssetsItemUploader = { avatar_url: string; events_url: string; followers_url: string; @@ -4534,97 +4785,57 @@ type ReposUpdateResponseOrganization = { type: string; url: string; }; -type ReposUpdateResponse = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; +type ReposGetReleaseResponseAssetsItem = { + browser_download_url: string; + content_type: string; created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; + download_count: number; id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; + label: string; name: string; - network_count: number; node_id: string; - notifications_url: string; - open_issues_count: number; - organization: ReposUpdateResponseOrganization; - owner: ReposUpdateResponseOwner; - parent: ReposUpdateResponseParent; - permissions: ReposUpdateResponsePermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; size: number; - source: ReposUpdateResponseSource; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - temp_clone_token: string; - template_repository: null; - topics: Array; - trees_url: string; + state: string; updated_at: string; + uploader: ReposGetReleaseResponseAssetsItemUploader; url: string; - visibility: string; - watchers_count: number; }; -type ReposTransferResponsePermissions = { - admin: boolean; - pull: boolean; - push: boolean; +type ReposGetReleaseResponse = { + assets: Array; + assets_url: string; + author: ReposGetReleaseResponseAuthor; + body: string; + created_at: string; + draft: boolean; + html_url: string; + id: number; + name: string; + node_id: string; + prerelease: boolean; + published_at: string; + tag_name: string; + tarball_url: string; + target_commitish: string; + upload_url: string; + url: string; + zipball_url: string; }; -type ReposTransferResponseOwner = { +type ReposGetReadmeResponseLinks = { git: string; html: string; self: string }; +type ReposGetReadmeResponse = { + _links: ReposGetReadmeResponseLinks; + content: string; + download_url: string; + encoding: string; + git_url: string; + html_url: string; + name: string; + path: string; + sha: string; + size: number; + type: string; + url: string; +}; +type ReposGetProtectedBranchRestrictionsResponseUsersItem = { avatar_url: string; events_url: string; followers_url: string; @@ -4644,223 +4855,7 @@ type ReposTransferResponseOwner = { type: string; url: string; }; -type ReposTransferResponse = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: ReposTransferResponseOwner; - permissions: ReposTransferResponsePermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - temp_clone_token: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - visibility: string; - watchers_count: number; -}; -type ReposRetrieveCommunityProfileMetricsResponseFilesReadme = { - html_url: string; - url: string; -}; -type ReposRetrieveCommunityProfileMetricsResponseFilesPullRequestTemplate = { - html_url: string; - url: string; -}; -type ReposRetrieveCommunityProfileMetricsResponseFilesLicense = { - html_url: string; - key: string; - name: string; - spdx_id: string; - url: string; -}; -type ReposRetrieveCommunityProfileMetricsResponseFilesIssueTemplate = { - html_url: string; - url: string; -}; -type ReposRetrieveCommunityProfileMetricsResponseFilesContributing = { - html_url: string; - url: string; -}; -type ReposRetrieveCommunityProfileMetricsResponseFilesCodeOfConduct = { - html_url: string; - key: string; - name: string; - url: string; -}; -type ReposRetrieveCommunityProfileMetricsResponseFiles = { - code_of_conduct: ReposRetrieveCommunityProfileMetricsResponseFilesCodeOfConduct; - contributing: ReposRetrieveCommunityProfileMetricsResponseFilesContributing; - issue_template: ReposRetrieveCommunityProfileMetricsResponseFilesIssueTemplate; - license: ReposRetrieveCommunityProfileMetricsResponseFilesLicense; - pull_request_template: ReposRetrieveCommunityProfileMetricsResponseFilesPullRequestTemplate; - readme: ReposRetrieveCommunityProfileMetricsResponseFilesReadme; -}; -type ReposRetrieveCommunityProfileMetricsResponse = { - description: string; - documentation: boolean; - files: ReposRetrieveCommunityProfileMetricsResponseFiles; - health_percentage: number; - updated_at: string; -}; -type ReposRequestPageBuildResponse = { status: string; url: string }; -type ReposReplaceTopicsResponse = { names: Array }; -type ReposReplaceProtectedBranchUserRestrictionsResponseItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposReplaceProtectedBranchTeamRestrictionsResponseItem = { - description: string; - html_url: string; - id: number; - members_url: string; - name: string; - node_id: string; - parent: null; - permission: string; - privacy: string; - repositories_url: string; - slug: string; - url: string; -}; -type ReposReplaceProtectedBranchAppRestrictionsResponseItemPermissions = { - contents: string; - issues: string; - metadata: string; - single_file: string; -}; -type ReposReplaceProtectedBranchAppRestrictionsResponseItemOwner = { - avatar_url: string; - description: string; - events_url: string; - hooks_url: string; - id: number; - issues_url: string; - login: string; - members_url: string; - node_id: string; - public_members_url: string; - repos_url: string; - url: string; -}; -type ReposReplaceProtectedBranchAppRestrictionsResponseItem = { - created_at: string; - description: string; - events: Array; - external_url: string; - html_url: string; - id: number; - name: string; - node_id: string; - owner: ReposReplaceProtectedBranchAppRestrictionsResponseItemOwner; - permissions: ReposReplaceProtectedBranchAppRestrictionsResponseItemPermissions; - slug: string; - updated_at: string; -}; -type ReposRemoveProtectedBranchUserRestrictionsResponseItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposRemoveProtectedBranchTeamRestrictionsResponseItem = { +type ReposGetProtectedBranchRestrictionsResponseTeamsItem = { description: string; html_url: string; id: number; @@ -4874,13 +4869,13 @@ type ReposRemoveProtectedBranchTeamRestrictionsResponseItem = { slug: string; url: string; }; -type ReposRemoveProtectedBranchAppRestrictionsResponseItemPermissions = { +type ReposGetProtectedBranchRestrictionsResponseAppsItemPermissions = { contents: string; issues: string; metadata: string; single_file: string; }; -type ReposRemoveProtectedBranchAppRestrictionsResponseItemOwner = { +type ReposGetProtectedBranchRestrictionsResponseAppsItemOwner = { avatar_url: string; description: string; events_url: string; @@ -4894,7 +4889,7 @@ type ReposRemoveProtectedBranchAppRestrictionsResponseItemOwner = { repos_url: string; url: string; }; -type ReposRemoveProtectedBranchAppRestrictionsResponseItem = { +type ReposGetProtectedBranchRestrictionsResponseAppsItem = { created_at: string; description: string; events: Array; @@ -4903,90 +4898,31 @@ type ReposRemoveProtectedBranchAppRestrictionsResponseItem = { id: number; name: string; node_id: string; - owner: ReposRemoveProtectedBranchAppRestrictionsResponseItemOwner; - permissions: ReposRemoveProtectedBranchAppRestrictionsResponseItemPermissions; + owner: ReposGetProtectedBranchRestrictionsResponseAppsItemOwner; + permissions: ReposGetProtectedBranchRestrictionsResponseAppsItemPermissions; slug: string; updated_at: string; }; -type ReposMergeResponseParentsItem = { sha: string; url: string }; -type ReposMergeResponseCommitter = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposMergeResponseCommitVerification = { - payload: null; - reason: string; - signature: null; - verified: boolean; -}; -type ReposMergeResponseCommitTree = { sha: string; url: string }; -type ReposMergeResponseCommitCommitter = { - date: string; - email: string; - name: string; -}; -type ReposMergeResponseCommitAuthor = { - date: string; - email: string; - name: string; -}; -type ReposMergeResponseCommit = { - author: ReposMergeResponseCommitAuthor; - comment_count: number; - committer: ReposMergeResponseCommitCommitter; - message: string; - tree: ReposMergeResponseCommitTree; +type ReposGetProtectedBranchRestrictionsResponse = { + apps: Array; + apps_url: string; + teams: Array; + teams_url: string; url: string; - verification: ReposMergeResponseCommitVerification; + users: Array; + users_url: string; }; -type ReposMergeResponseAuthor = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; +type ReposGetProtectedBranchRequiredStatusChecksResponse = { + contexts: Array; + contexts_url: string; + strict: boolean; url: string; }; -type ReposMergeResponse = { - author: ReposMergeResponseAuthor; - comments_url: string; - commit: ReposMergeResponseCommit; - committer: ReposMergeResponseCommitter; - html_url: string; - node_id: string; - parents: Array; - sha: string; +type ReposGetProtectedBranchRequiredSignaturesResponse = { + enabled: boolean; url: string; }; -type ReposListUsersWithAccessToProtectedBranchResponseItem = { +type ReposGetProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsUsersItem = { avatar_url: string; events_url: string; followers_url: string; @@ -5006,8 +4942,7 @@ type ReposListUsersWithAccessToProtectedBranchResponseItem = { type: string; url: string; }; -type ReposListTopicsResponse = { names: Array }; -type ReposListTeamsWithAccessToProtectedBranchResponseItem = { +type ReposGetProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsTeamsItem = { description: string; html_url: string; id: number; @@ -5021,28 +4956,33 @@ type ReposListTeamsWithAccessToProtectedBranchResponseItem = { slug: string; url: string; }; -type ReposListTeamsResponseItem = { - description: string; - html_url: string; - id: number; - members_url: string; - name: string; - node_id: string; - parent: null; - permission: string; - privacy: string; - repositories_url: string; - slug: string; +type ReposGetProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictions = { + teams: Array< + ReposGetProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsTeamsItem + >; + teams_url: string; url: string; + users: Array< + ReposGetProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsUsersItem + >; + users_url: string; }; -type ReposListTagsResponseItemCommit = { sha: string; url: string }; -type ReposListTagsResponseItem = { - commit: ReposListTagsResponseItemCommit; - name: string; - tarball_url: string; - zipball_url: string; +type ReposGetProtectedBranchPullRequestReviewEnforcementResponse = { + dismiss_stale_reviews: boolean; + dismissal_restrictions: ReposGetProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictions; + require_code_owner_reviews: boolean; + required_approving_review_count: number; + url: string; }; -type ReposListStatusesForRefResponseItemCreator = { +type ReposGetProtectedBranchAdminEnforcementResponse = { + enabled: boolean; + url: string; +}; +type ReposGetParticipationStatsResponse = { + all: Array; + owner: Array; +}; +type ReposGetPagesBuildResponsePusher = { avatar_url: string; events_url: string; followers_url: string; @@ -5062,20 +5002,27 @@ type ReposListStatusesForRefResponseItemCreator = { type: string; url: string; }; -type ReposListStatusesForRefResponseItem = { - avatar_url: string; - context: string; +type ReposGetPagesBuildResponseError = { message: null }; +type ReposGetPagesBuildResponse = { + commit: string; created_at: string; - creator: ReposListStatusesForRefResponseItemCreator; - description: string; - id: number; - node_id: string; - state: string; - target_url: string; + duration: number; + error: ReposGetPagesBuildResponseError; + pusher: ReposGetPagesBuildResponsePusher; + status: string; updated_at: string; url: string; }; -type ReposListReleasesResponseItemAuthor = { +type ReposGetPagesResponseSource = { branch: string; directory: string }; +type ReposGetPagesResponse = { + cname: string; + custom_404: boolean; + html_url: string; + source: ReposGetPagesResponseSource; + status: string; + url: string; +}; +type ReposGetLatestReleaseResponseAuthor = { avatar_url: string; events_url: string; followers_url: string; @@ -5095,7 +5042,7 @@ type ReposListReleasesResponseItemAuthor = { type: string; url: string; }; -type ReposListReleasesResponseItemAssetsItemUploader = { +type ReposGetLatestReleaseResponseAssetsItemUploader = { avatar_url: string; events_url: string; followers_url: string; @@ -5115,7 +5062,7 @@ type ReposListReleasesResponseItemAssetsItemUploader = { type: string; url: string; }; -type ReposListReleasesResponseItemAssetsItem = { +type ReposGetLatestReleaseResponseAssetsItem = { browser_download_url: string; content_type: string; created_at: string; @@ -5127,13 +5074,13 @@ type ReposListReleasesResponseItemAssetsItem = { size: number; state: string; updated_at: string; - uploader: ReposListReleasesResponseItemAssetsItemUploader; + uploader: ReposGetLatestReleaseResponseAssetsItemUploader; url: string; }; -type ReposListReleasesResponseItem = { - assets: Array; +type ReposGetLatestReleaseResponse = { + assets: Array; assets_url: string; - author: ReposListReleasesResponseItemAuthor; + author: ReposGetLatestReleaseResponseAuthor; body: string; created_at: string; draft: boolean; @@ -5150,7 +5097,7 @@ type ReposListReleasesResponseItem = { url: string; zipball_url: string; }; -type ReposListPullRequestsAssociatedWithCommitResponseItemUser = { +type ReposGetLatestPagesBuildResponsePusher = { avatar_url: string; events_url: string; followers_url: string; @@ -5170,21 +5117,52 @@ type ReposListPullRequestsAssociatedWithCommitResponseItemUser = { type: string; url: string; }; -type ReposListPullRequestsAssociatedWithCommitResponseItemRequestedTeamsItem = { +type ReposGetLatestPagesBuildResponseError = { message: null }; +type ReposGetLatestPagesBuildResponse = { + commit: string; + created_at: string; + duration: number; + error: ReposGetLatestPagesBuildResponseError; + pusher: ReposGetLatestPagesBuildResponsePusher; + status: string; + updated_at: string; + url: string; +}; +type ReposGetHookResponseLastResponse = { + code: null; + message: null; + status: string; +}; +type ReposGetHookResponseConfig = { + content_type: string; + insecure_ssl: string; + url: string; +}; +type ReposGetHookResponse = { + active: boolean; + config: ReposGetHookResponseConfig; + created_at: string; + events: Array; + id: number; + last_response: ReposGetHookResponseLastResponse; + name: string; + ping_url: string; + test_url: string; + type: string; + updated_at: string; + url: string; +}; +type ReposGetDownloadResponse = { + content_type: string; description: string; + download_count: number; html_url: string; id: number; - members_url: string; name: string; - node_id: string; - parent: null; - permission: string; - privacy: string; - repositories_url: string; - slug: string; + size: number; url: string; }; -type ReposListPullRequestsAssociatedWithCommitResponseItemRequestedReviewersItem = { +type ReposGetDeploymentStatusResponseCreator = { avatar_url: string; events_url: string; followers_url: string; @@ -5204,7 +5182,24 @@ type ReposListPullRequestsAssociatedWithCommitResponseItemRequestedReviewersItem type: string; url: string; }; -type ReposListPullRequestsAssociatedWithCommitResponseItemMilestoneCreator = { +type ReposGetDeploymentStatusResponse = { + created_at: string; + creator: ReposGetDeploymentStatusResponseCreator; + deployment_url: string; + description: string; + environment: string; + environment_url: string; + id: number; + log_url: string; + node_id: string; + repository_url: string; + state: string; + target_url: string; + updated_at: string; + url: string; +}; +type ReposGetDeploymentResponsePayload = { deploy: string }; +type ReposGetDeploymentResponseCreator = { avatar_url: string; events_url: string; followers_url: string; @@ -5224,34 +5219,41 @@ type ReposListPullRequestsAssociatedWithCommitResponseItemMilestoneCreator = { type: string; url: string; }; -type ReposListPullRequestsAssociatedWithCommitResponseItemMilestone = { - closed_at: string; - closed_issues: number; +type ReposGetDeploymentResponse = { created_at: string; - creator: ReposListPullRequestsAssociatedWithCommitResponseItemMilestoneCreator; + creator: ReposGetDeploymentResponseCreator; description: string; - due_on: string; - html_url: string; + environment: string; id: number; - labels_url: string; node_id: string; - number: number; - open_issues: number; - state: string; - title: string; + original_environment: string; + payload: ReposGetDeploymentResponsePayload; + production_environment: boolean; + ref: string; + repository_url: string; + sha: string; + statuses_url: string; + task: string; + transient_environment: boolean; updated_at: string; url: string; }; -type ReposListPullRequestsAssociatedWithCommitResponseItemLabelsItem = { - color: string; - default: boolean; - description: string; +type ReposGetDeployKeyResponse = { + created_at: string; id: number; - name: string; - node_id: string; + key: string; + read_only: boolean; + title: string; url: string; + verified: boolean; }; -type ReposListPullRequestsAssociatedWithCommitResponseItemHeadUser = { +type ReposGetContributorsStatsResponseItemWeeksItem = { + a: number; + c: number; + d: number; + w: string; +}; +type ReposGetContributorsStatsResponseItemAuthor = { avatar_url: string; events_url: string; followers_url: string; @@ -5271,146 +5273,52 @@ type ReposListPullRequestsAssociatedWithCommitResponseItemHeadUser = { type: string; url: string; }; -type ReposListPullRequestsAssociatedWithCommitResponseItemHeadRepoPermissions = { - admin: boolean; - pull: boolean; - push: boolean; +type ReposGetContributorsStatsResponseItem = { + author: ReposGetContributorsStatsResponseItemAuthor; + total: number; + weeks: Array; }; -type ReposListPullRequestsAssociatedWithCommitResponseItemHeadRepoOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; +type ReposGetContentsResponseItemLinks = { + git: string; + html: string; + self: string; }; -type ReposListPullRequestsAssociatedWithCommitResponseItemHeadRepo = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; +type ReposGetContentsResponseItem = { + _links: ReposGetContentsResponseItemLinks; + download_url: string | null; git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: ReposListPullRequestsAssociatedWithCommitResponseItemHeadRepoOwner; - permissions: ReposListPullRequestsAssociatedWithCommitResponseItemHeadRepoPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - temp_clone_token: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - visibility: string; - watchers_count: number; -}; -type ReposListPullRequestsAssociatedWithCommitResponseItemHead = { - label: string; - ref: string; - repo: ReposListPullRequestsAssociatedWithCommitResponseItemHeadRepo; + path: string; sha: string; - user: ReposListPullRequestsAssociatedWithCommitResponseItemHeadUser; -}; -type ReposListPullRequestsAssociatedWithCommitResponseItemBaseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; + size: number; type: string; url: string; }; -type ReposListPullRequestsAssociatedWithCommitResponseItemBaseRepoPermissions = { - admin: boolean; - pull: boolean; - push: boolean; +type ReposGetContentsResponseLinks = { + git: string; + html: string; + self: string; }; -type ReposListPullRequestsAssociatedWithCommitResponseItemBaseRepoOwner = { +type ReposGetContentsResponse = + | { + _links: ReposGetContentsResponseLinks; + content?: string; + download_url: string | null; + encoding?: string; + git_url: string; + html_url: string; + name: string; + path: string; + sha: string; + size: number; + type: string; + url: string; + target?: string; + submodule_git_url?: string; + } + | Array; +type ReposGetCommitCommentResponseUser = { avatar_url: string; events_url: string; followers_url: string; @@ -5430,96 +5338,42 @@ type ReposListPullRequestsAssociatedWithCommitResponseItemBaseRepoOwner = { type: string; url: string; }; -type ReposListPullRequestsAssociatedWithCommitResponseItemBaseRepo = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; +type ReposGetCommitCommentResponse = { + body: string; + commit_id: string; created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; html_url: string; id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; + line: number; node_id: string; - notifications_url: string; - open_issues_count: number; - owner: ReposListPullRequestsAssociatedWithCommitResponseItemBaseRepoOwner; - permissions: ReposListPullRequestsAssociatedWithCommitResponseItemBaseRepoPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - temp_clone_token: string; - template_repository: null; - topics: Array; - trees_url: string; + path: string; + position: number; updated_at: string; url: string; - visibility: string; - watchers_count: number; + user: ReposGetCommitCommentResponseUser; }; -type ReposListPullRequestsAssociatedWithCommitResponseItemBase = { - label: string; - ref: string; - repo: ReposListPullRequestsAssociatedWithCommitResponseItemBaseRepo; - sha: string; - user: ReposListPullRequestsAssociatedWithCommitResponseItemBaseUser; +type ReposGetCommitActivityStatsResponseItem = { + days: Array; + total: number; + week: number; }; -type ReposListPullRequestsAssociatedWithCommitResponseItemAssigneesItem = { +type ReposGetCommitResponseStats = { + additions: number; + deletions: number; + total: number; +}; +type ReposGetCommitResponseParentsItem = { sha: string; url: string }; +type ReposGetCommitResponseFilesItem = { + additions: number; + blob_url: string; + changes: number; + deletions: number; + filename: string; + patch: string; + raw_url: string; + status: string; +}; +type ReposGetCommitResponseCommitter = { avatar_url: string; events_url: string; followers_url: string; @@ -5539,7 +5393,33 @@ type ReposListPullRequestsAssociatedWithCommitResponseItemAssigneesItem = { type: string; url: string; }; -type ReposListPullRequestsAssociatedWithCommitResponseItemAssignee = { +type ReposGetCommitResponseCommitVerification = { + payload: null; + reason: string; + signature: null; + verified: boolean; +}; +type ReposGetCommitResponseCommitTree = { sha: string; url: string }; +type ReposGetCommitResponseCommitCommitter = { + date: string; + email: string; + name: string; +}; +type ReposGetCommitResponseCommitAuthor = { + date: string; + email: string; + name: string; +}; +type ReposGetCommitResponseCommit = { + author: ReposGetCommitResponseCommitAuthor; + comment_count: number; + committer: ReposGetCommitResponseCommitCommitter; + message: string; + tree: ReposGetCommitResponseCommitTree; + url: string; + verification: ReposGetCommitResponseCommitVerification; +}; +type ReposGetCommitResponseAuthor = { avatar_url: string; events_url: string; followers_url: string; @@ -5559,86 +5439,32 @@ type ReposListPullRequestsAssociatedWithCommitResponseItemAssignee = { type: string; url: string; }; -type ReposListPullRequestsAssociatedWithCommitResponseItemLinksStatuses = { - href: string; -}; -type ReposListPullRequestsAssociatedWithCommitResponseItemLinksSelf = { - href: string; -}; -type ReposListPullRequestsAssociatedWithCommitResponseItemLinksReviewComments = { - href: string; -}; -type ReposListPullRequestsAssociatedWithCommitResponseItemLinksReviewComment = { - href: string; -}; -type ReposListPullRequestsAssociatedWithCommitResponseItemLinksIssue = { - href: string; -}; -type ReposListPullRequestsAssociatedWithCommitResponseItemLinksHtml = { - href: string; -}; -type ReposListPullRequestsAssociatedWithCommitResponseItemLinksCommits = { - href: string; -}; -type ReposListPullRequestsAssociatedWithCommitResponseItemLinksComments = { - href: string; -}; -type ReposListPullRequestsAssociatedWithCommitResponseItemLinks = { - comments: ReposListPullRequestsAssociatedWithCommitResponseItemLinksComments; - commits: ReposListPullRequestsAssociatedWithCommitResponseItemLinksCommits; - html: ReposListPullRequestsAssociatedWithCommitResponseItemLinksHtml; - issue: ReposListPullRequestsAssociatedWithCommitResponseItemLinksIssue; - review_comment: ReposListPullRequestsAssociatedWithCommitResponseItemLinksReviewComment; - review_comments: ReposListPullRequestsAssociatedWithCommitResponseItemLinksReviewComments; - self: ReposListPullRequestsAssociatedWithCommitResponseItemLinksSelf; - statuses: ReposListPullRequestsAssociatedWithCommitResponseItemLinksStatuses; -}; -type ReposListPullRequestsAssociatedWithCommitResponseItem = { - _links: ReposListPullRequestsAssociatedWithCommitResponseItemLinks; - active_lock_reason: string; - assignee: ReposListPullRequestsAssociatedWithCommitResponseItemAssignee; - assignees: Array< - ReposListPullRequestsAssociatedWithCommitResponseItemAssigneesItem - >; - author_association: string; - base: ReposListPullRequestsAssociatedWithCommitResponseItemBase; - body: string; - closed_at: string; +type ReposGetCommitResponse = { + author: ReposGetCommitResponseAuthor; comments_url: string; - commits_url: string; - created_at: string; - diff_url: string; - draft: boolean; - head: ReposListPullRequestsAssociatedWithCommitResponseItemHead; + commit: ReposGetCommitResponseCommit; + committer: ReposGetCommitResponseCommitter; + files: Array; html_url: string; + node_id: string; + parents: Array; + sha: string; + stats: ReposGetCommitResponseStats; + url: string; +}; +type ReposGetCombinedStatusForRefResponseStatusesItem = { + avatar_url: string; + context: string; + created_at: string; + description: string; id: number; - issue_url: string; - labels: Array< - ReposListPullRequestsAssociatedWithCommitResponseItemLabelsItem - >; - locked: boolean; - merge_commit_sha: string; - merged_at: string; - milestone: ReposListPullRequestsAssociatedWithCommitResponseItemMilestone; node_id: string; - number: number; - patch_url: string; - requested_reviewers: Array< - ReposListPullRequestsAssociatedWithCommitResponseItemRequestedReviewersItem - >; - requested_teams: Array< - ReposListPullRequestsAssociatedWithCommitResponseItemRequestedTeamsItem - >; - review_comment_url: string; - review_comments_url: string; state: string; - statuses_url: string; - title: string; + target_url: string; updated_at: string; url: string; - user: ReposListPullRequestsAssociatedWithCommitResponseItemUser; }; -type ReposListPublicResponseItemOwner = { +type ReposGetCombinedStatusForRefResponseRepositoryOwner = { avatar_url: string; events_url: string; followers_url: string; @@ -5658,7 +5484,7 @@ type ReposListPublicResponseItemOwner = { type: string; url: string; }; -type ReposListPublicResponseItem = { +type ReposGetCombinedStatusForRefResponseRepository = { archive_url: string; assignees_url: string; blobs_url: string; @@ -5693,7 +5519,7 @@ type ReposListPublicResponseItem = { name: string; node_id: string; notifications_url: string; - owner: ReposListPublicResponseItemOwner; + owner: ReposGetCombinedStatusForRefResponseRepositoryOwner; private: boolean; pulls_url: string; releases_url: string; @@ -5707,7 +5533,16 @@ type ReposListPublicResponseItem = { trees_url: string; url: string; }; -type ReposListProtectedBranchUserRestrictionsResponseItem = { +type ReposGetCombinedStatusForRefResponse = { + commit_url: string; + repository: ReposGetCombinedStatusForRefResponseRepository; + sha: string; + state: string; + statuses: Array; + total_count: number; + url: string; +}; +type ReposGetCollaboratorPermissionLevelResponseUser = { avatar_url: string; events_url: string; followers_url: string; @@ -5727,21 +5562,21 @@ type ReposListProtectedBranchUserRestrictionsResponseItem = { type: string; url: string; }; -type ReposListProtectedBranchTeamRestrictionsResponseItem = { - description: string; - html_url: string; - id: number; - members_url: string; - name: string; - node_id: string; - parent: null; +type ReposGetCollaboratorPermissionLevelResponse = { permission: string; - privacy: string; - repositories_url: string; - slug: string; - url: string; + user: ReposGetCollaboratorPermissionLevelResponseUser; }; -type ReposListPagesBuildsResponseItemPusher = { +type ReposGetClonesResponseClonesItem = { + count: number; + timestamp: string; + uniques: number; +}; +type ReposGetClonesResponse = { + clones: Array; + count: number; + uniques: number; +}; +type ReposGetBranchProtectionResponseRestrictionsUsersItem = { avatar_url: string; events_url: string; followers_url: string; @@ -5761,19 +5596,70 @@ type ReposListPagesBuildsResponseItemPusher = { type: string; url: string; }; -type ReposListPagesBuildsResponseItemError = { message: null }; -type ReposListPagesBuildsResponseItem = { - commit: string; +type ReposGetBranchProtectionResponseRestrictionsTeamsItem = { + description: string; + html_url: string; + id: number; + members_url: string; + name: string; + node_id: string; + parent: null; + permission: string; + privacy: string; + repositories_url: string; + slug: string; + url: string; +}; +type ReposGetBranchProtectionResponseRestrictionsAppsItemPermissions = { + contents: string; + issues: string; + metadata: string; + single_file: string; +}; +type ReposGetBranchProtectionResponseRestrictionsAppsItemOwner = { + avatar_url: string; + description: string; + events_url: string; + hooks_url: string; + id: number; + issues_url: string; + login: string; + members_url: string; + node_id: string; + public_members_url: string; + repos_url: string; + url: string; +}; +type ReposGetBranchProtectionResponseRestrictionsAppsItem = { created_at: string; - duration: number; - error: ReposListPagesBuildsResponseItemError; - pusher: ReposListPagesBuildsResponseItemPusher; - status: string; + description: string; + events: Array; + external_url: string; + html_url: string; + id: number; + name: string; + node_id: string; + owner: ReposGetBranchProtectionResponseRestrictionsAppsItemOwner; + permissions: ReposGetBranchProtectionResponseRestrictionsAppsItemPermissions; + slug: string; updated_at: string; +}; +type ReposGetBranchProtectionResponseRestrictions = { + apps: Array; + apps_url: string; + teams: Array; + teams_url: string; url: string; + users: Array; + users_url: string; }; -type ReposListLanguagesResponse = { C: number; Python: number }; -type ReposListInvitationsForAuthenticatedUserResponseItemRepositoryOwner = { +type ReposGetBranchProtectionResponseRequiredStatusChecks = { + contexts: Array; + contexts_url: string; + strict: boolean; + url: string; +}; +type ReposGetBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsUsersItem = { avatar_url: string; events_url: string; followers_url: string; @@ -5793,106 +5679,163 @@ type ReposListInvitationsForAuthenticatedUserResponseItemRepositoryOwner = { type: string; url: string; }; -type ReposListInvitationsForAuthenticatedUserResponseItemRepository = { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - deployments_url: string; +type ReposGetBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsTeamsItem = { description: string; - downloads_url: string; - events_url: string; - fork: boolean; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; html_url: string; id: number; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - languages_url: string; - merges_url: string; - milestones_url: string; + members_url: string; name: string; node_id: string; - notifications_url: string; - owner: ReposListInvitationsForAuthenticatedUserResponseItemRepositoryOwner; - private: boolean; - pulls_url: string; - releases_url: string; - ssh_url: string; - stargazers_url: string; - statuses_url: string; - subscribers_url: string; - subscription_url: string; - tags_url: string; + parent: null; + permission: string; + privacy: string; + repositories_url: string; + slug: string; + url: string; +}; +type ReposGetBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictions = { + teams: Array< + ReposGetBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsTeamsItem + >; teams_url: string; - trees_url: string; + url: string; + users: Array< + ReposGetBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsUsersItem + >; + users_url: string; +}; +type ReposGetBranchProtectionResponseRequiredPullRequestReviews = { + dismiss_stale_reviews: boolean; + dismissal_restrictions: ReposGetBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictions; + require_code_owner_reviews: boolean; + required_approving_review_count: number; url: string; }; -type ReposListInvitationsForAuthenticatedUserResponseItemInviter = { +type ReposGetBranchProtectionResponseRequiredLinearHistory = { + enabled: boolean; +}; +type ReposGetBranchProtectionResponseEnforceAdmins = { + enabled: boolean; + url: string; +}; +type ReposGetBranchProtectionResponseAllowForcePushes = { enabled: boolean }; +type ReposGetBranchProtectionResponseAllowDeletions = { enabled: boolean }; +type ReposGetBranchProtectionResponse = { + allow_deletions: ReposGetBranchProtectionResponseAllowDeletions; + allow_force_pushes: ReposGetBranchProtectionResponseAllowForcePushes; + enforce_admins: ReposGetBranchProtectionResponseEnforceAdmins; + required_linear_history: ReposGetBranchProtectionResponseRequiredLinearHistory; + required_pull_request_reviews: ReposGetBranchProtectionResponseRequiredPullRequestReviews; + required_status_checks: ReposGetBranchProtectionResponseRequiredStatusChecks; + restrictions: ReposGetBranchProtectionResponseRestrictions; + url: string; +}; +type ReposGetBranchResponseProtectionRequiredStatusChecks = { + contexts: Array; + enforcement_level: string; +}; +type ReposGetBranchResponseProtection = { + enabled: boolean; + required_status_checks: ReposGetBranchResponseProtectionRequiredStatusChecks; +}; +type ReposGetBranchResponseCommitParentsItem = { sha: string; url: string }; +type ReposGetBranchResponseCommitCommitter = { + avatar_url: string; + gravatar_id: string; + id: number; + login: string; + url: string; +}; +type ReposGetBranchResponseCommitCommitVerification = { + payload: null; + reason: string; + signature: null; + verified: boolean; +}; +type ReposGetBranchResponseCommitCommitTree = { sha: string; url: string }; +type ReposGetBranchResponseCommitCommitCommitter = { + date: string; + email: string; + name: string; +}; +type ReposGetBranchResponseCommitCommitAuthor = { + date: string; + email: string; + name: string; +}; +type ReposGetBranchResponseCommitCommit = { + author: ReposGetBranchResponseCommitCommitAuthor; + committer: ReposGetBranchResponseCommitCommitCommitter; + message: string; + tree: ReposGetBranchResponseCommitCommitTree; + url: string; + verification: ReposGetBranchResponseCommitCommitVerification; +}; +type ReposGetBranchResponseCommitAuthor = { avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; gravatar_id: string; - html_url: string; id: number; login: string; + url: string; +}; +type ReposGetBranchResponseCommit = { + author: ReposGetBranchResponseCommitAuthor; + commit: ReposGetBranchResponseCommitCommit; + committer: ReposGetBranchResponseCommitCommitter; node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; + parents: Array; + sha: string; url: string; }; -type ReposListInvitationsForAuthenticatedUserResponseItemInvitee = { +type ReposGetBranchResponseLinks = { html: string; self: string }; +type ReposGetBranchResponse = { + _links: ReposGetBranchResponseLinks; + commit: ReposGetBranchResponseCommit; + name: string; + protected: boolean; + protection: ReposGetBranchResponseProtection; + protection_url: string; +}; +type ReposGetAppsWithAccessToProtectedBranchResponseItemPermissions = { + contents: string; + issues: string; + metadata: string; + single_file: string; +}; +type ReposGetAppsWithAccessToProtectedBranchResponseItemOwner = { avatar_url: string; + description: string; events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; + hooks_url: string; id: number; + issues_url: string; login: string; + members_url: string; node_id: string; - organizations_url: string; - received_events_url: string; + public_members_url: string; repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; url: string; }; -type ReposListInvitationsForAuthenticatedUserResponseItem = { +type ReposGetAppsWithAccessToProtectedBranchResponseItem = { created_at: string; + description: string; + events: Array; + external_url: string; html_url: string; id: number; - invitee: ReposListInvitationsForAuthenticatedUserResponseItemInvitee; - inviter: ReposListInvitationsForAuthenticatedUserResponseItemInviter; - permissions: string; - repository: ReposListInvitationsForAuthenticatedUserResponseItemRepository; - url: string; + name: string; + node_id: string; + owner: ReposGetAppsWithAccessToProtectedBranchResponseItemOwner; + permissions: ReposGetAppsWithAccessToProtectedBranchResponseItemPermissions; + slug: string; + updated_at: string; }; -type ReposListInvitationsResponseItemRepositoryOwner = { +type ReposGetResponseSourcePermissions = { + admin: boolean; + pull: boolean; + push: boolean; +}; +type ReposGetResponseSourceOwner = { avatar_url: string; events_url: string; followers_url: string; @@ -5912,135 +5855,99 @@ type ReposListInvitationsResponseItemRepositoryOwner = { type: string; url: string; }; -type ReposListInvitationsResponseItemRepository = { +type ReposGetResponseSource = { + allow_merge_commit: boolean; + allow_rebase_merge: boolean; + allow_squash_merge: boolean; archive_url: string; + archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; + clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; + created_at: string; + default_branch: string; deployments_url: string; description: string; + disabled: boolean; downloads_url: string; events_url: string; fork: boolean; + forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; + has_downloads: boolean; + has_issues: boolean; + has_pages: boolean; + has_projects: boolean; + has_wiki: boolean; + homepage: string; + hooks_url: string; html_url: string; id: number; + is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; + language: null; languages_url: string; merges_url: string; milestones_url: string; + mirror_url: string; name: string; + network_count: number; node_id: string; notifications_url: string; - owner: ReposListInvitationsResponseItemRepositoryOwner; + open_issues_count: number; + owner: ReposGetResponseSourceOwner; + permissions: ReposGetResponseSourcePermissions; private: boolean; pulls_url: string; + pushed_at: string; releases_url: string; + size: number; ssh_url: string; + stargazers_count: number; stargazers_url: string; statuses_url: string; + subscribers_count: number; subscribers_url: string; subscription_url: string; + svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; + template_repository: null; + topics: Array; trees_url: string; - url: string; -}; -type ReposListInvitationsResponseItemInviter = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposListInvitationsResponseItemInvitee = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposListInvitationsResponseItem = { - created_at: string; - html_url: string; - id: number; - invitee: ReposListInvitationsResponseItemInvitee; - inviter: ReposListInvitationsResponseItemInviter; - permissions: string; - repository: ReposListInvitationsResponseItemRepository; - url: string; -}; -type ReposListHooksResponseItemLastResponse = { - code: null; - message: null; - status: string; -}; -type ReposListHooksResponseItemConfig = { - content_type: string; - insecure_ssl: string; - url: string; -}; -type ReposListHooksResponseItem = { - active: boolean; - config: ReposListHooksResponseItemConfig; - created_at: string; - events: Array; - id: number; - last_response: ReposListHooksResponseItemLastResponse; - name: string; - ping_url: string; - test_url: string; - type: string; updated_at: string; url: string; + visibility: string; + watchers_count: number; }; -type ReposListForksResponseItemPermissions = { +type ReposGetResponsePermissions = { admin: boolean; pull: boolean; push: boolean; }; -type ReposListForksResponseItemOwner = { +type ReposGetResponseParentPermissions = { + admin: boolean; + pull: boolean; + push: boolean; +}; +type ReposGetResponseParentOwner = { avatar_url: string; events_url: string; followers_url: string; @@ -6060,14 +5967,10 @@ type ReposListForksResponseItemOwner = { type: string; url: string; }; -type ReposListForksResponseItemLicense = { - key: string; - name: string; - node_id: string; - spdx_id: string; - url: string; -}; -type ReposListForksResponseItem = { +type ReposGetResponseParent = { + allow_merge_commit: boolean; + allow_rebase_merge: boolean; + allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; @@ -6112,7 +6015,6 @@ type ReposListForksResponseItem = { labels_url: string; language: null; languages_url: string; - license: ReposListForksResponseItemLicense; merges_url: string; milestones_url: string; mirror_url: string; @@ -6121,8 +6023,8 @@ type ReposListForksResponseItem = { node_id: string; notifications_url: string; open_issues_count: number; - owner: ReposListForksResponseItemOwner; - permissions: ReposListForksResponseItemPermissions; + owner: ReposGetResponseParentOwner; + permissions: ReposGetResponseParentPermissions; private: boolean; pulls_url: string; pushed_at: string; @@ -6147,12 +6049,27 @@ type ReposListForksResponseItem = { visibility: string; watchers_count: number; }; -type ReposListForOrgResponseItemPermissions = { - admin: boolean; - pull: boolean; - push: boolean; +type ReposGetResponseOwner = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; }; -type ReposListForOrgResponseItemOwner = { +type ReposGetResponseOrganization = { avatar_url: string; events_url: string; followers_url: string; @@ -6172,14 +6089,17 @@ type ReposListForOrgResponseItemOwner = { type: string; url: string; }; -type ReposListForOrgResponseItemLicense = { +type ReposGetResponseLicense = { key: string; name: string; node_id: string; spdx_id: string; url: string; }; -type ReposListForOrgResponseItem = { +type ReposGetResponse = { + allow_merge_commit: boolean; + allow_rebase_merge: boolean; + allow_squash_merge: boolean; archive_url: string; archived: boolean; assignees_url: string; @@ -6224,7 +6144,7 @@ type ReposListForOrgResponseItem = { labels_url: string; language: null; languages_url: string; - license: ReposListForOrgResponseItemLicense; + license: ReposGetResponseLicense; merges_url: string; milestones_url: string; mirror_url: string; @@ -6233,13 +6153,16 @@ type ReposListForOrgResponseItem = { node_id: string; notifications_url: string; open_issues_count: number; - owner: ReposListForOrgResponseItemOwner; - permissions: ReposListForOrgResponseItemPermissions; + organization: ReposGetResponseOrganization; + owner: ReposGetResponseOwner; + parent: ReposGetResponseParent; + permissions: ReposGetResponsePermissions; private: boolean; pulls_url: string; pushed_at: string; releases_url: string; size: number; + source: ReposGetResponseSource; ssh_url: string; stargazers_count: number; stargazers_url: string; @@ -6259,57 +6182,60 @@ type ReposListForOrgResponseItem = { visibility: string; watchers_count: number; }; -type ReposListDownloadsResponseItem = { - content_type: string; - description: string; - download_count: number; +type ReposEnablePagesSiteResponseSource = { branch: string; directory: string }; +type ReposEnablePagesSiteResponse = { + cname: string; + custom_404: boolean; html_url: string; - id: number; - name: string; - size: number; + source: ReposEnablePagesSiteResponseSource; + status: string; url: string; }; -type ReposListDeploymentsResponseItemPayload = { deploy: string }; -type ReposListDeploymentsResponseItemCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; +type ReposDeleteFileResponseCommitVerification = { + payload: null; + reason: string; + signature: null; + verified: boolean; +}; +type ReposDeleteFileResponseCommitTree = { sha: string; url: string }; +type ReposDeleteFileResponseCommitParentsItem = { html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; + sha: string; url: string; }; -type ReposListDeploymentsResponseItem = { - created_at: string; - creator: ReposListDeploymentsResponseItemCreator; - description: string; - environment: string; - id: number; +type ReposDeleteFileResponseCommitCommitter = { + date: string; + email: string; + name: string; +}; +type ReposDeleteFileResponseCommitAuthor = { + date: string; + email: string; + name: string; +}; +type ReposDeleteFileResponseCommit = { + author: ReposDeleteFileResponseCommitAuthor; + committer: ReposDeleteFileResponseCommitCommitter; + html_url: string; + message: string; node_id: string; - original_environment: string; - payload: ReposListDeploymentsResponseItemPayload; - production_environment: boolean; - ref: string; - repository_url: string; + parents: Array; sha: string; - statuses_url: string; - task: string; - transient_environment: boolean; - updated_at: string; + tree: ReposDeleteFileResponseCommitTree; url: string; + verification: ReposDeleteFileResponseCommitVerification; }; -type ReposListDeploymentStatusesResponseItemCreator = { +type ReposDeleteFileResponse = { + commit: ReposDeleteFileResponseCommit; + content: null; +}; +type ReposDeleteResponse = { documentation_url: string; message: string }; +type ReposCreateUsingTemplateResponseTemplateRepositoryPermissions = { + admin: boolean; + pull: boolean; + push: boolean; +}; +type ReposCreateUsingTemplateResponseTemplateRepositoryOwner = { avatar_url: string; events_url: string; followers_url: string; @@ -6329,2611 +6255,44 @@ type ReposListDeploymentStatusesResponseItemCreator = { type: string; url: string; }; -type ReposListDeploymentStatusesResponseItem = { +type ReposCreateUsingTemplateResponseTemplateRepository = { + allow_merge_commit: boolean; + allow_rebase_merge: boolean; + allow_squash_merge: boolean; + archive_url: string; + archived: boolean; + assignees_url: string; + blobs_url: string; + branches_url: string; + clone_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; created_at: string; - creator: ReposListDeploymentStatusesResponseItemCreator; - deployment_url: string; + default_branch: string; + deployments_url: string; description: string; - environment: string; - environment_url: string; - id: number; - log_url: string; - node_id: string; - repository_url: string; - state: string; - target_url: string; - updated_at: string; - url: string; -}; -type ReposListDeployKeysResponseItem = { - created_at: string; - id: number; - key: string; - read_only: boolean; - title: string; - url: string; - verified: boolean; -}; -type ReposListContributorsResponseItem = { - avatar_url: string; - contributions: number; + disabled: boolean; + downloads_url: string; events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposListCommitsResponseItemParentsItem = { sha: string; url: string }; -type ReposListCommitsResponseItemCommitter = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposListCommitsResponseItemCommitVerification = { - payload: null; - reason: string; - signature: null; - verified: boolean; -}; -type ReposListCommitsResponseItemCommitTree = { sha: string; url: string }; -type ReposListCommitsResponseItemCommitCommitter = { - date: string; - email: string; - name: string; -}; -type ReposListCommitsResponseItemCommitAuthor = { - date: string; - email: string; - name: string; -}; -type ReposListCommitsResponseItemCommit = { - author: ReposListCommitsResponseItemCommitAuthor; - comment_count: number; - committer: ReposListCommitsResponseItemCommitCommitter; - message: string; - tree: ReposListCommitsResponseItemCommitTree; - url: string; - verification: ReposListCommitsResponseItemCommitVerification; -}; -type ReposListCommitsResponseItemAuthor = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposListCommitsResponseItem = { - author: ReposListCommitsResponseItemAuthor; - comments_url: string; - commit: ReposListCommitsResponseItemCommit; - committer: ReposListCommitsResponseItemCommitter; - html_url: string; - node_id: string; - parents: Array; - sha: string; - url: string; -}; -type ReposListCommitCommentsResponseItemUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposListCommitCommentsResponseItem = { - body: string; - commit_id: string; - created_at: string; - html_url: string; - id: number; - line: number; - node_id: string; - path: string; - position: number; - updated_at: string; - url: string; - user: ReposListCommitCommentsResponseItemUser; -}; -type ReposListCommentsForCommitResponseItemUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposListCommentsForCommitResponseItem = { - body: string; - commit_id: string; - created_at: string; - html_url: string; - id: number; - line: number; - node_id: string; - path: string; - position: number; - updated_at: string; - url: string; - user: ReposListCommentsForCommitResponseItemUser; -}; -type ReposListCollaboratorsResponseItemPermissions = { - admin: boolean; - pull: boolean; - push: boolean; -}; -type ReposListCollaboratorsResponseItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - permissions: ReposListCollaboratorsResponseItemPermissions; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposListBranchesForHeadCommitResponseItemCommit = { - sha: string; - url: string; -}; -type ReposListBranchesForHeadCommitResponseItem = { - commit: ReposListBranchesForHeadCommitResponseItemCommit; - name: string; - protected: string; -}; -type ReposListBranchesResponseItemProtectionRequiredStatusChecks = { - contexts: Array; - enforcement_level: string; -}; -type ReposListBranchesResponseItemProtection = { - enabled: boolean; - required_status_checks: ReposListBranchesResponseItemProtectionRequiredStatusChecks; -}; -type ReposListBranchesResponseItemCommit = { sha: string; url: string }; -type ReposListBranchesResponseItem = { - commit: ReposListBranchesResponseItemCommit; - name: string; - protected: boolean; - protection: ReposListBranchesResponseItemProtection; - protection_url: string; -}; -type ReposListAssetsForReleaseResponseItemUploader = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposListAssetsForReleaseResponseItem = { - browser_download_url: string; - content_type: string; - created_at: string; - download_count: number; - id: number; - label: string; - name: string; - node_id: string; - size: number; - state: string; - updated_at: string; - uploader: ReposListAssetsForReleaseResponseItemUploader; - url: string; -}; -type ReposListAppsWithAccessToProtectedBranchResponseItemPermissions = { - contents: string; - issues: string; - metadata: string; - single_file: string; -}; -type ReposListAppsWithAccessToProtectedBranchResponseItemOwner = { - avatar_url: string; - description: string; - events_url: string; - hooks_url: string; - id: number; - issues_url: string; - login: string; - members_url: string; - node_id: string; - public_members_url: string; - repos_url: string; - url: string; -}; -type ReposListAppsWithAccessToProtectedBranchResponseItem = { - created_at: string; - description: string; - events: Array; - external_url: string; - html_url: string; - id: number; - name: string; - node_id: string; - owner: ReposListAppsWithAccessToProtectedBranchResponseItemOwner; - permissions: ReposListAppsWithAccessToProtectedBranchResponseItemPermissions; - slug: string; - updated_at: string; -}; -type ReposGetViewsResponseViewsItem = { - count: number; - timestamp: string; - uniques: number; -}; -type ReposGetViewsResponse = { - count: number; - uniques: number; - views: Array; -}; -type ReposGetUsersWithAccessToProtectedBranchResponseItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposGetTopReferrersResponseItem = { - count: number; - referrer: string; - uniques: number; -}; -type ReposGetTopPathsResponseItem = { - count: number; - path: string; - title: string; - uniques: number; -}; -type ReposGetTeamsWithAccessToProtectedBranchResponseItem = { - description: string; - html_url: string; - id: number; - members_url: string; - name: string; - node_id: string; - parent: null; - permission: string; - privacy: string; - repositories_url: string; - slug: string; - url: string; -}; -type ReposGetReleaseByTagResponseAuthor = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposGetReleaseByTagResponseAssetsItemUploader = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposGetReleaseByTagResponseAssetsItem = { - browser_download_url: string; - content_type: string; - created_at: string; - download_count: number; - id: number; - label: string; - name: string; - node_id: string; - size: number; - state: string; - updated_at: string; - uploader: ReposGetReleaseByTagResponseAssetsItemUploader; - url: string; -}; -type ReposGetReleaseByTagResponse = { - assets: Array; - assets_url: string; - author: ReposGetReleaseByTagResponseAuthor; - body: string; - created_at: string; - draft: boolean; - html_url: string; - id: number; - name: string; - node_id: string; - prerelease: boolean; - published_at: string; - tag_name: string; - tarball_url: string; - target_commitish: string; - upload_url: string; - url: string; - zipball_url: string; -}; -type ReposGetReleaseAssetResponseUploader = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposGetReleaseAssetResponse = { - browser_download_url: string; - content_type: string; - created_at: string; - download_count: number; - id: number; - label: string; - name: string; - node_id: string; - size: number; - state: string; - updated_at: string; - uploader: ReposGetReleaseAssetResponseUploader; - url: string; -}; -type ReposGetReleaseResponseAuthor = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposGetReleaseResponseAssetsItemUploader = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposGetReleaseResponseAssetsItem = { - browser_download_url: string; - content_type: string; - created_at: string; - download_count: number; - id: number; - label: string; - name: string; - node_id: string; - size: number; - state: string; - updated_at: string; - uploader: ReposGetReleaseResponseAssetsItemUploader; - url: string; -}; -type ReposGetReleaseResponse = { - assets: Array; - assets_url: string; - author: ReposGetReleaseResponseAuthor; - body: string; - created_at: string; - draft: boolean; - html_url: string; - id: number; - name: string; - node_id: string; - prerelease: boolean; - published_at: string; - tag_name: string; - tarball_url: string; - target_commitish: string; - upload_url: string; - url: string; - zipball_url: string; -}; -type ReposGetReadmeResponseLinks = { git: string; html: string; self: string }; -type ReposGetReadmeResponse = { - _links: ReposGetReadmeResponseLinks; - content: string; - download_url: string; - encoding: string; - git_url: string; - html_url: string; - name: string; - path: string; - sha: string; - size: number; - type: string; - url: string; -}; -type ReposGetProtectedBranchRestrictionsResponseUsersItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposGetProtectedBranchRestrictionsResponseTeamsItem = { - description: string; - html_url: string; - id: number; - members_url: string; - name: string; - node_id: string; - parent: null; - permission: string; - privacy: string; - repositories_url: string; - slug: string; - url: string; -}; -type ReposGetProtectedBranchRestrictionsResponseAppsItemPermissions = { - contents: string; - issues: string; - metadata: string; - single_file: string; -}; -type ReposGetProtectedBranchRestrictionsResponseAppsItemOwner = { - avatar_url: string; - description: string; - events_url: string; - hooks_url: string; - id: number; - issues_url: string; - login: string; - members_url: string; - node_id: string; - public_members_url: string; - repos_url: string; - url: string; -}; -type ReposGetProtectedBranchRestrictionsResponseAppsItem = { - created_at: string; - description: string; - events: Array; - external_url: string; - html_url: string; - id: number; - name: string; - node_id: string; - owner: ReposGetProtectedBranchRestrictionsResponseAppsItemOwner; - permissions: ReposGetProtectedBranchRestrictionsResponseAppsItemPermissions; - slug: string; - updated_at: string; -}; -type ReposGetProtectedBranchRestrictionsResponse = { - apps: Array; - apps_url: string; - teams: Array; - teams_url: string; - url: string; - users: Array; - users_url: string; -}; -type ReposGetProtectedBranchRequiredStatusChecksResponse = { - contexts: Array; - contexts_url: string; - strict: boolean; - url: string; -}; -type ReposGetProtectedBranchRequiredSignaturesResponse = { - enabled: boolean; - url: string; -}; -type ReposGetProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsUsersItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposGetProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsTeamsItem = { - description: string; - html_url: string; - id: number; - members_url: string; - name: string; - node_id: string; - parent: null; - permission: string; - privacy: string; - repositories_url: string; - slug: string; - url: string; -}; -type ReposGetProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictions = { - teams: Array< - ReposGetProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsTeamsItem - >; - teams_url: string; - url: string; - users: Array< - ReposGetProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictionsUsersItem - >; - users_url: string; -}; -type ReposGetProtectedBranchPullRequestReviewEnforcementResponse = { - dismiss_stale_reviews: boolean; - dismissal_restrictions: ReposGetProtectedBranchPullRequestReviewEnforcementResponseDismissalRestrictions; - require_code_owner_reviews: boolean; - required_approving_review_count: number; - url: string; -}; -type ReposGetProtectedBranchAdminEnforcementResponse = { - enabled: boolean; - url: string; -}; -type ReposGetParticipationStatsResponse = { - all: Array; - owner: Array; -}; -type ReposGetPagesBuildResponsePusher = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposGetPagesBuildResponseError = { message: null }; -type ReposGetPagesBuildResponse = { - commit: string; - created_at: string; - duration: number; - error: ReposGetPagesBuildResponseError; - pusher: ReposGetPagesBuildResponsePusher; - status: string; - updated_at: string; - url: string; -}; -type ReposGetPagesResponseSource = { branch: string; directory: string }; -type ReposGetPagesResponse = { - cname: string; - custom_404: boolean; - html_url: string; - source: ReposGetPagesResponseSource; - status: string; - url: string; -}; -type ReposGetLatestReleaseResponseAuthor = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposGetLatestReleaseResponseAssetsItemUploader = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposGetLatestReleaseResponseAssetsItem = { - browser_download_url: string; - content_type: string; - created_at: string; - download_count: number; - id: number; - label: string; - name: string; - node_id: string; - size: number; - state: string; - updated_at: string; - uploader: ReposGetLatestReleaseResponseAssetsItemUploader; - url: string; -}; -type ReposGetLatestReleaseResponse = { - assets: Array; - assets_url: string; - author: ReposGetLatestReleaseResponseAuthor; - body: string; - created_at: string; - draft: boolean; - html_url: string; - id: number; - name: string; - node_id: string; - prerelease: boolean; - published_at: string; - tag_name: string; - tarball_url: string; - target_commitish: string; - upload_url: string; - url: string; - zipball_url: string; -}; -type ReposGetLatestPagesBuildResponsePusher = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposGetLatestPagesBuildResponseError = { message: null }; -type ReposGetLatestPagesBuildResponse = { - commit: string; - created_at: string; - duration: number; - error: ReposGetLatestPagesBuildResponseError; - pusher: ReposGetLatestPagesBuildResponsePusher; - status: string; - updated_at: string; - url: string; -}; -type ReposGetHookResponseLastResponse = { - code: null; - message: null; - status: string; -}; -type ReposGetHookResponseConfig = { - content_type: string; - insecure_ssl: string; - url: string; -}; -type ReposGetHookResponse = { - active: boolean; - config: ReposGetHookResponseConfig; - created_at: string; - events: Array; - id: number; - last_response: ReposGetHookResponseLastResponse; - name: string; - ping_url: string; - test_url: string; - type: string; - updated_at: string; - url: string; -}; -type ReposGetDownloadResponse = { - content_type: string; - description: string; - download_count: number; - html_url: string; - id: number; - name: string; - size: number; - url: string; -}; -type ReposGetDeploymentStatusResponseCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposGetDeploymentStatusResponse = { - created_at: string; - creator: ReposGetDeploymentStatusResponseCreator; - deployment_url: string; - description: string; - environment: string; - environment_url: string; - id: number; - log_url: string; - node_id: string; - repository_url: string; - state: string; - target_url: string; - updated_at: string; - url: string; -}; -type ReposGetDeploymentResponsePayload = { deploy: string }; -type ReposGetDeploymentResponseCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposGetDeploymentResponse = { - created_at: string; - creator: ReposGetDeploymentResponseCreator; - description: string; - environment: string; - id: number; - node_id: string; - original_environment: string; - payload: ReposGetDeploymentResponsePayload; - production_environment: boolean; - ref: string; - repository_url: string; - sha: string; - statuses_url: string; - task: string; - transient_environment: boolean; - updated_at: string; - url: string; -}; -type ReposGetDeployKeyResponse = { - created_at: string; - id: number; - key: string; - read_only: boolean; - title: string; - url: string; - verified: boolean; -}; -type ReposGetContributorsStatsResponseItemWeeksItem = { - a: number; - c: number; - d: number; - w: string; -}; -type ReposGetContributorsStatsResponseItemAuthor = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposGetContributorsStatsResponseItem = { - author: ReposGetContributorsStatsResponseItemAuthor; - total: number; - weeks: Array; -}; -type ReposGetContentsResponseItemLinks = { - git: string; - html: string; - self: string; -}; -type ReposGetContentsResponseItem = { - _links: ReposGetContentsResponseItemLinks; - download_url: string | null; - git_url: string; - html_url: string; - name: string; - path: string; - sha: string; - size: number; - type: string; - url: string; -}; -type ReposGetContentsResponseLinks = { - git: string; - html: string; - self: string; -}; -type ReposGetContentsResponse = - | { - _links: ReposGetContentsResponseLinks; - content?: string; - download_url: string | null; - encoding?: string; - git_url: string; - html_url: string; - name: string; - path: string; - sha: string; - size: number; - type: string; - url: string; - target?: string; - submodule_git_url?: string; - } - | Array; -type ReposGetCommitCommentResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposGetCommitCommentResponse = { - body: string; - commit_id: string; - created_at: string; - html_url: string; - id: number; - line: number; - node_id: string; - path: string; - position: number; - updated_at: string; - url: string; - user: ReposGetCommitCommentResponseUser; -}; -type ReposGetCommitActivityStatsResponseItem = { - days: Array; - total: number; - week: number; -}; -type ReposGetCommitResponseStats = { - additions: number; - deletions: number; - total: number; -}; -type ReposGetCommitResponseParentsItem = { sha: string; url: string }; -type ReposGetCommitResponseFilesItem = { - additions: number; - blob_url: string; - changes: number; - deletions: number; - filename: string; - patch: string; - raw_url: string; - status: string; -}; -type ReposGetCommitResponseCommitter = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposGetCommitResponseCommitVerification = { - payload: null; - reason: string; - signature: null; - verified: boolean; -}; -type ReposGetCommitResponseCommitTree = { sha: string; url: string }; -type ReposGetCommitResponseCommitCommitter = { - date: string; - email: string; - name: string; -}; -type ReposGetCommitResponseCommitAuthor = { - date: string; - email: string; - name: string; -}; -type ReposGetCommitResponseCommit = { - author: ReposGetCommitResponseCommitAuthor; - comment_count: number; - committer: ReposGetCommitResponseCommitCommitter; - message: string; - tree: ReposGetCommitResponseCommitTree; - url: string; - verification: ReposGetCommitResponseCommitVerification; -}; -type ReposGetCommitResponseAuthor = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposGetCommitResponse = { - author: ReposGetCommitResponseAuthor; - comments_url: string; - commit: ReposGetCommitResponseCommit; - committer: ReposGetCommitResponseCommitter; - files: Array; - html_url: string; - node_id: string; - parents: Array; - sha: string; - stats: ReposGetCommitResponseStats; - url: string; -}; -type ReposGetCombinedStatusForRefResponseStatusesItem = { - avatar_url: string; - context: string; - created_at: string; - description: string; - id: number; - node_id: string; - state: string; - target_url: string; - updated_at: string; - url: string; -}; -type ReposGetCombinedStatusForRefResponseRepositoryOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposGetCombinedStatusForRefResponseRepository = { - archive_url: string; - assignees_url: string; - blobs_url: string; - branches_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - deployments_url: string; - description: string; - downloads_url: string; - events_url: string; - fork: boolean; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - html_url: string; - id: number; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - languages_url: string; - merges_url: string; - milestones_url: string; - name: string; - node_id: string; - notifications_url: string; - owner: ReposGetCombinedStatusForRefResponseRepositoryOwner; - private: boolean; - pulls_url: string; - releases_url: string; - ssh_url: string; - stargazers_url: string; - statuses_url: string; - subscribers_url: string; - subscription_url: string; - tags_url: string; - teams_url: string; - trees_url: string; - url: string; -}; -type ReposGetCombinedStatusForRefResponse = { - commit_url: string; - repository: ReposGetCombinedStatusForRefResponseRepository; - sha: string; - state: string; - statuses: Array; - total_count: number; - url: string; -}; -type ReposGetCollaboratorPermissionLevelResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposGetCollaboratorPermissionLevelResponse = { - permission: string; - user: ReposGetCollaboratorPermissionLevelResponseUser; -}; -type ReposGetClonesResponseClonesItem = { - count: number; - timestamp: string; - uniques: number; -}; -type ReposGetClonesResponse = { - clones: Array; - count: number; - uniques: number; -}; -type ReposGetBranchProtectionResponseRestrictionsUsersItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposGetBranchProtectionResponseRestrictionsTeamsItem = { - description: string; - html_url: string; - id: number; - members_url: string; - name: string; - node_id: string; - parent: null; - permission: string; - privacy: string; - repositories_url: string; - slug: string; - url: string; -}; -type ReposGetBranchProtectionResponseRestrictionsAppsItemPermissions = { - contents: string; - issues: string; - metadata: string; - single_file: string; -}; -type ReposGetBranchProtectionResponseRestrictionsAppsItemOwner = { - avatar_url: string; - description: string; - events_url: string; - hooks_url: string; - id: number; - issues_url: string; - login: string; - members_url: string; - node_id: string; - public_members_url: string; - repos_url: string; - url: string; -}; -type ReposGetBranchProtectionResponseRestrictionsAppsItem = { - created_at: string; - description: string; - events: Array; - external_url: string; - html_url: string; - id: number; - name: string; - node_id: string; - owner: ReposGetBranchProtectionResponseRestrictionsAppsItemOwner; - permissions: ReposGetBranchProtectionResponseRestrictionsAppsItemPermissions; - slug: string; - updated_at: string; -}; -type ReposGetBranchProtectionResponseRestrictions = { - apps: Array; - apps_url: string; - teams: Array; - teams_url: string; - url: string; - users: Array; - users_url: string; -}; -type ReposGetBranchProtectionResponseRequiredStatusChecks = { - contexts: Array; - contexts_url: string; - strict: boolean; - url: string; -}; -type ReposGetBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsUsersItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposGetBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsTeamsItem = { - description: string; - html_url: string; - id: number; - members_url: string; - name: string; - node_id: string; - parent: null; - permission: string; - privacy: string; - repositories_url: string; - slug: string; - url: string; -}; -type ReposGetBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictions = { - teams: Array< - ReposGetBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsTeamsItem - >; - teams_url: string; - url: string; - users: Array< - ReposGetBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictionsUsersItem - >; - users_url: string; -}; -type ReposGetBranchProtectionResponseRequiredPullRequestReviews = { - dismiss_stale_reviews: boolean; - dismissal_restrictions: ReposGetBranchProtectionResponseRequiredPullRequestReviewsDismissalRestrictions; - require_code_owner_reviews: boolean; - required_approving_review_count: number; - url: string; -}; -type ReposGetBranchProtectionResponseRequiredLinearHistory = { - enabled: boolean; -}; -type ReposGetBranchProtectionResponseEnforceAdmins = { - enabled: boolean; - url: string; -}; -type ReposGetBranchProtectionResponseAllowForcePushes = { enabled: boolean }; -type ReposGetBranchProtectionResponseAllowDeletions = { enabled: boolean }; -type ReposGetBranchProtectionResponse = { - allow_deletions: ReposGetBranchProtectionResponseAllowDeletions; - allow_force_pushes: ReposGetBranchProtectionResponseAllowForcePushes; - enforce_admins: ReposGetBranchProtectionResponseEnforceAdmins; - required_linear_history: ReposGetBranchProtectionResponseRequiredLinearHistory; - required_pull_request_reviews: ReposGetBranchProtectionResponseRequiredPullRequestReviews; - required_status_checks: ReposGetBranchProtectionResponseRequiredStatusChecks; - restrictions: ReposGetBranchProtectionResponseRestrictions; - url: string; -}; -type ReposGetBranchResponseProtectionRequiredStatusChecks = { - contexts: Array; - enforcement_level: string; -}; -type ReposGetBranchResponseProtection = { - enabled: boolean; - required_status_checks: ReposGetBranchResponseProtectionRequiredStatusChecks; -}; -type ReposGetBranchResponseCommitParentsItem = { sha: string; url: string }; -type ReposGetBranchResponseCommitCommitter = { - avatar_url: string; - gravatar_id: string; - id: number; - login: string; - url: string; -}; -type ReposGetBranchResponseCommitCommitVerification = { - payload: null; - reason: string; - signature: null; - verified: boolean; -}; -type ReposGetBranchResponseCommitCommitTree = { sha: string; url: string }; -type ReposGetBranchResponseCommitCommitCommitter = { - date: string; - email: string; - name: string; -}; -type ReposGetBranchResponseCommitCommitAuthor = { - date: string; - email: string; - name: string; -}; -type ReposGetBranchResponseCommitCommit = { - author: ReposGetBranchResponseCommitCommitAuthor; - committer: ReposGetBranchResponseCommitCommitCommitter; - message: string; - tree: ReposGetBranchResponseCommitCommitTree; - url: string; - verification: ReposGetBranchResponseCommitCommitVerification; -}; -type ReposGetBranchResponseCommitAuthor = { - avatar_url: string; - gravatar_id: string; - id: number; - login: string; - url: string; -}; -type ReposGetBranchResponseCommit = { - author: ReposGetBranchResponseCommitAuthor; - commit: ReposGetBranchResponseCommitCommit; - committer: ReposGetBranchResponseCommitCommitter; - node_id: string; - parents: Array; - sha: string; - url: string; -}; -type ReposGetBranchResponseLinks = { html: string; self: string }; -type ReposGetBranchResponse = { - _links: ReposGetBranchResponseLinks; - commit: ReposGetBranchResponseCommit; - name: string; - protected: boolean; - protection: ReposGetBranchResponseProtection; - protection_url: string; -}; -type ReposGetAppsWithAccessToProtectedBranchResponseItemPermissions = { - contents: string; - issues: string; - metadata: string; - single_file: string; -}; -type ReposGetAppsWithAccessToProtectedBranchResponseItemOwner = { - avatar_url: string; - description: string; - events_url: string; - hooks_url: string; - id: number; - issues_url: string; - login: string; - members_url: string; - node_id: string; - public_members_url: string; - repos_url: string; - url: string; -}; -type ReposGetAppsWithAccessToProtectedBranchResponseItem = { - created_at: string; - description: string; - events: Array; - external_url: string; - html_url: string; - id: number; - name: string; - node_id: string; - owner: ReposGetAppsWithAccessToProtectedBranchResponseItemOwner; - permissions: ReposGetAppsWithAccessToProtectedBranchResponseItemPermissions; - slug: string; - updated_at: string; -}; -type ReposGetResponseSourcePermissions = { - admin: boolean; - pull: boolean; - push: boolean; -}; -type ReposGetResponseSourceOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposGetResponseSource = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: ReposGetResponseSourceOwner; - permissions: ReposGetResponseSourcePermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - temp_clone_token: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - visibility: string; - watchers_count: number; -}; -type ReposGetResponsePermissions = { - admin: boolean; - pull: boolean; - push: boolean; -}; -type ReposGetResponseParentPermissions = { - admin: boolean; - pull: boolean; - push: boolean; -}; -type ReposGetResponseParentOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposGetResponseParent = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: ReposGetResponseParentOwner; - permissions: ReposGetResponseParentPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - temp_clone_token: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - visibility: string; - watchers_count: number; -}; -type ReposGetResponseOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposGetResponseOrganization = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposGetResponseLicense = { - key: string; - name: string; - node_id: string; - spdx_id: string; - url: string; -}; -type ReposGetResponse = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - license: ReposGetResponseLicense; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - organization: ReposGetResponseOrganization; - owner: ReposGetResponseOwner; - parent: ReposGetResponseParent; - permissions: ReposGetResponsePermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - source: ReposGetResponseSource; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - temp_clone_token: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - visibility: string; - watchers_count: number; -}; -type ReposEnablePagesSiteResponseSource = { branch: string; directory: string }; -type ReposEnablePagesSiteResponse = { - cname: string; - custom_404: boolean; - html_url: string; - source: ReposEnablePagesSiteResponseSource; - status: string; - url: string; -}; -type ReposDeleteFileResponseCommitVerification = { - payload: null; - reason: string; - signature: null; - verified: boolean; -}; -type ReposDeleteFileResponseCommitTree = { sha: string; url: string }; -type ReposDeleteFileResponseCommitParentsItem = { - html_url: string; - sha: string; - url: string; -}; -type ReposDeleteFileResponseCommitCommitter = { - date: string; - email: string; - name: string; -}; -type ReposDeleteFileResponseCommitAuthor = { - date: string; - email: string; - name: string; -}; -type ReposDeleteFileResponseCommit = { - author: ReposDeleteFileResponseCommitAuthor; - committer: ReposDeleteFileResponseCommitCommitter; - html_url: string; - message: string; - node_id: string; - parents: Array; - sha: string; - tree: ReposDeleteFileResponseCommitTree; - url: string; - verification: ReposDeleteFileResponseCommitVerification; -}; -type ReposDeleteFileResponse = { - commit: ReposDeleteFileResponseCommit; - content: null; -}; -type ReposDeleteResponse = { documentation_url: string; message: string }; -type ReposCreateUsingTemplateResponseTemplateRepositoryPermissions = { - admin: boolean; - pull: boolean; - push: boolean; -}; -type ReposCreateUsingTemplateResponseTemplateRepositoryOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposCreateUsingTemplateResponseTemplateRepository = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: ReposCreateUsingTemplateResponseTemplateRepositoryOwner; - permissions: ReposCreateUsingTemplateResponseTemplateRepositoryPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - temp_clone_token: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - visibility: string; - watchers_count: number; -}; -type ReposCreateUsingTemplateResponsePermissions = { - admin: boolean; - pull: boolean; - push: boolean; -}; -type ReposCreateUsingTemplateResponseOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposCreateUsingTemplateResponse = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: ReposCreateUsingTemplateResponseOwner; - permissions: ReposCreateUsingTemplateResponsePermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - temp_clone_token: string; - template_repository: ReposCreateUsingTemplateResponseTemplateRepository; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - visibility: string; - watchers_count: number; -}; -type ReposCreateStatusResponseCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposCreateStatusResponse = { - avatar_url: string; - context: string; - created_at: string; - creator: ReposCreateStatusResponseCreator; - description: string; - id: number; - node_id: string; - state: string; - target_url: string; - updated_at: string; - url: string; -}; -type ReposCreateReleaseResponseAuthor = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposCreateReleaseResponse = { - assets: Array; - assets_url: string; - author: ReposCreateReleaseResponseAuthor; - body: string; - created_at: string; - draft: boolean; - html_url: string; - id: number; - name: string; - node_id: string; - prerelease: boolean; - published_at: string; - tag_name: string; - tarball_url: string; - target_commitish: string; - upload_url: string; - url: string; - zipball_url: string; -}; -type ReposCreateOrUpdateFileResponseContentLinks = { - git: string; - html: string; - self: string; -}; -type ReposCreateOrUpdateFileResponseContent = { - _links: ReposCreateOrUpdateFileResponseContentLinks; - download_url: string; - git_url: string; - html_url: string; - name: string; - path: string; - sha: string; - size: number; - type: string; - url: string; -}; -type ReposCreateOrUpdateFileResponseCommitVerification = { - payload: null; - reason: string; - signature: null; - verified: boolean; -}; -type ReposCreateOrUpdateFileResponseCommitTree = { sha: string; url: string }; -type ReposCreateOrUpdateFileResponseCommitParentsItem = { - html_url: string; - sha: string; - url: string; -}; -type ReposCreateOrUpdateFileResponseCommitCommitter = { - date: string; - email: string; - name: string; -}; -type ReposCreateOrUpdateFileResponseCommitAuthor = { - date: string; - email: string; - name: string; -}; -type ReposCreateOrUpdateFileResponseCommit = { - author: ReposCreateOrUpdateFileResponseCommitAuthor; - committer: ReposCreateOrUpdateFileResponseCommitCommitter; - html_url: string; - message: string; - node_id: string; - parents: Array; - sha: string; - tree: ReposCreateOrUpdateFileResponseCommitTree; - url: string; - verification: ReposCreateOrUpdateFileResponseCommitVerification; -}; -type ReposCreateOrUpdateFileResponse = { - commit: ReposCreateOrUpdateFileResponseCommit; - content: ReposCreateOrUpdateFileResponseContent; -}; -type ReposCreateInOrgResponsePermissions = { - admin: boolean; - pull: boolean; - push: boolean; -}; -type ReposCreateInOrgResponseOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposCreateInOrgResponse = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: ReposCreateInOrgResponseOwner; - permissions: ReposCreateInOrgResponsePermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - temp_clone_token: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - visibility: string; - watchers_count: number; -}; -type ReposCreateHookResponseLastResponse = { - code: null; - message: null; - status: string; -}; -type ReposCreateHookResponseConfig = { - content_type: string; - insecure_ssl: string; - url: string; -}; -type ReposCreateHookResponse = { - active: boolean; - config: ReposCreateHookResponseConfig; - created_at: string; - events: Array; - id: number; - last_response: ReposCreateHookResponseLastResponse; - name: string; - ping_url: string; - test_url: string; - type: string; - updated_at: string; - url: string; -}; -type ReposCreateForkResponsePermissions = { - admin: boolean; - pull: boolean; - push: boolean; -}; -type ReposCreateForkResponseOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposCreateForkResponse = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; - id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; - node_id: string; - notifications_url: string; - open_issues_count: number; - owner: ReposCreateForkResponseOwner; - permissions: ReposCreateForkResponsePermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - temp_clone_token: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - visibility: string; - watchers_count: number; -}; -type ReposCreateForAuthenticatedUserResponsePermissions = { - admin: boolean; - pull: boolean; - push: boolean; -}; -type ReposCreateForAuthenticatedUserResponseOwner = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposCreateForAuthenticatedUserResponse = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; - created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; + fork: boolean; + forks_count: number; + forks_url: string; + full_name: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + has_downloads: boolean; + has_issues: boolean; + has_pages: boolean; + has_projects: boolean; + has_wiki: boolean; + homepage: string; + hooks_url: string; html_url: string; id: number; is_template: boolean; @@ -8952,8 +6311,8 @@ type ReposCreateForAuthenticatedUserResponse = { node_id: string; notifications_url: string; open_issues_count: number; - owner: ReposCreateForAuthenticatedUserResponseOwner; - permissions: ReposCreateForAuthenticatedUserResponsePermissions; + owner: ReposCreateUsingTemplateResponseTemplateRepositoryOwner; + permissions: ReposCreateUsingTemplateResponseTemplateRepositoryPermissions; private: boolean; pulls_url: string; pushed_at: string; @@ -8967,547 +6326,23 @@ type ReposCreateForAuthenticatedUserResponse = { subscribers_url: string; subscription_url: string; svn_url: string; - tags_url: string; - teams_url: string; - temp_clone_token: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - visibility: string; - watchers_count: number; -}; -type ReposCreateFileResponseContentLinks = { - git: string; - html: string; - self: string; -}; -type ReposCreateFileResponseContent = { - _links: ReposCreateFileResponseContentLinks; - download_url: string; - git_url: string; - html_url: string; - name: string; - path: string; - sha: string; - size: number; - type: string; - url: string; -}; -type ReposCreateFileResponseCommitVerification = { - payload: null; - reason: string; - signature: null; - verified: boolean; -}; -type ReposCreateFileResponseCommitTree = { sha: string; url: string }; -type ReposCreateFileResponseCommitParentsItem = { - html_url: string; - sha: string; - url: string; -}; -type ReposCreateFileResponseCommitCommitter = { - date: string; - email: string; - name: string; -}; -type ReposCreateFileResponseCommitAuthor = { - date: string; - email: string; - name: string; -}; -type ReposCreateFileResponseCommit = { - author: ReposCreateFileResponseCommitAuthor; - committer: ReposCreateFileResponseCommitCommitter; - html_url: string; - message: string; - node_id: string; - parents: Array; - sha: string; - tree: ReposCreateFileResponseCommitTree; - url: string; - verification: ReposCreateFileResponseCommitVerification; -}; -type ReposCreateFileResponse = { - commit: ReposCreateFileResponseCommit; - content: ReposCreateFileResponseContent; -}; -type ReposCreateDeploymentStatusResponseCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposCreateDeploymentStatusResponse = { - created_at: string; - creator: ReposCreateDeploymentStatusResponseCreator; - deployment_url: string; - description: string; - environment: string; - environment_url: string; - id: number; - log_url: string; - node_id: string; - repository_url: string; - state: string; - target_url: string; - updated_at: string; - url: string; -}; -type ReposCreateDeploymentResponsePayload = { deploy: string }; -type ReposCreateDeploymentResponseCreator = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposCreateDeploymentResponse = { - created_at: string; - creator: ReposCreateDeploymentResponseCreator; - description: string; - environment: string; - id: number; - node_id: string; - original_environment: string; - payload: ReposCreateDeploymentResponsePayload; - production_environment: boolean; - ref: string; - repository_url: string; - sha: string; - statuses_url: string; - task: string; - transient_environment: boolean; - updated_at: string; - url: string; -}; -type ReposCreateCommitCommentResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposCreateCommitCommentResponse = { - body: string; - commit_id: string; - created_at: string; - html_url: string; - id: number; - line: number; - node_id: string; - path: string; - position: number; - updated_at: string; - url: string; - user: ReposCreateCommitCommentResponseUser; -}; -type ReposCompareCommitsResponseMergeBaseCommitParentsItem = { - sha: string; - url: string; -}; -type ReposCompareCommitsResponseMergeBaseCommitCommitter = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposCompareCommitsResponseMergeBaseCommitCommitVerification = { - payload: null; - reason: string; - signature: null; - verified: boolean; -}; -type ReposCompareCommitsResponseMergeBaseCommitCommitTree = { - sha: string; - url: string; -}; -type ReposCompareCommitsResponseMergeBaseCommitCommitCommitter = { - date: string; - email: string; - name: string; -}; -type ReposCompareCommitsResponseMergeBaseCommitCommitAuthor = { - date: string; - email: string; - name: string; -}; -type ReposCompareCommitsResponseMergeBaseCommitCommit = { - author: ReposCompareCommitsResponseMergeBaseCommitCommitAuthor; - comment_count: number; - committer: ReposCompareCommitsResponseMergeBaseCommitCommitCommitter; - message: string; - tree: ReposCompareCommitsResponseMergeBaseCommitCommitTree; - url: string; - verification: ReposCompareCommitsResponseMergeBaseCommitCommitVerification; -}; -type ReposCompareCommitsResponseMergeBaseCommitAuthor = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposCompareCommitsResponseMergeBaseCommit = { - author: ReposCompareCommitsResponseMergeBaseCommitAuthor; - comments_url: string; - commit: ReposCompareCommitsResponseMergeBaseCommitCommit; - committer: ReposCompareCommitsResponseMergeBaseCommitCommitter; - html_url: string; - node_id: string; - parents: Array; - sha: string; - url: string; -}; -type ReposCompareCommitsResponseFilesItem = { - additions: number; - blob_url: string; - changes: number; - contents_url: string; - deletions: number; - filename: string; - patch: string; - raw_url: string; - sha: string; - status: string; -}; -type ReposCompareCommitsResponseCommitsItemParentsItem = { - sha: string; - url: string; -}; -type ReposCompareCommitsResponseCommitsItemCommitter = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposCompareCommitsResponseCommitsItemCommitVerification = { - payload: null; - reason: string; - signature: null; - verified: boolean; -}; -type ReposCompareCommitsResponseCommitsItemCommitTree = { - sha: string; - url: string; -}; -type ReposCompareCommitsResponseCommitsItemCommitCommitter = { - date: string; - email: string; - name: string; -}; -type ReposCompareCommitsResponseCommitsItemCommitAuthor = { - date: string; - email: string; - name: string; -}; -type ReposCompareCommitsResponseCommitsItemCommit = { - author: ReposCompareCommitsResponseCommitsItemCommitAuthor; - comment_count: number; - committer: ReposCompareCommitsResponseCommitsItemCommitCommitter; - message: string; - tree: ReposCompareCommitsResponseCommitsItemCommitTree; - url: string; - verification: ReposCompareCommitsResponseCommitsItemCommitVerification; -}; -type ReposCompareCommitsResponseCommitsItemAuthor = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposCompareCommitsResponseCommitsItem = { - author: ReposCompareCommitsResponseCommitsItemAuthor; - comments_url: string; - commit: ReposCompareCommitsResponseCommitsItemCommit; - committer: ReposCompareCommitsResponseCommitsItemCommitter; - html_url: string; - node_id: string; - parents: Array; - sha: string; - url: string; -}; -type ReposCompareCommitsResponseBaseCommitParentsItem = { - sha: string; - url: string; -}; -type ReposCompareCommitsResponseBaseCommitCommitter = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposCompareCommitsResponseBaseCommitCommitVerification = { - payload: null; - reason: string; - signature: null; - verified: boolean; -}; -type ReposCompareCommitsResponseBaseCommitCommitTree = { - sha: string; - url: string; -}; -type ReposCompareCommitsResponseBaseCommitCommitCommitter = { - date: string; - email: string; - name: string; -}; -type ReposCompareCommitsResponseBaseCommitCommitAuthor = { - date: string; - email: string; - name: string; -}; -type ReposCompareCommitsResponseBaseCommitCommit = { - author: ReposCompareCommitsResponseBaseCommitCommitAuthor; - comment_count: number; - committer: ReposCompareCommitsResponseBaseCommitCommitCommitter; - message: string; - tree: ReposCompareCommitsResponseBaseCommitCommitTree; - url: string; - verification: ReposCompareCommitsResponseBaseCommitCommitVerification; -}; -type ReposCompareCommitsResponseBaseCommitAuthor = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposCompareCommitsResponseBaseCommit = { - author: ReposCompareCommitsResponseBaseCommitAuthor; - comments_url: string; - commit: ReposCompareCommitsResponseBaseCommitCommit; - committer: ReposCompareCommitsResponseBaseCommitCommitter; - html_url: string; - node_id: string; - parents: Array; - sha: string; - url: string; -}; -type ReposCompareCommitsResponse = { - ahead_by: number; - base_commit: ReposCompareCommitsResponseBaseCommit; - behind_by: number; - commits: Array; - diff_url: string; - files: Array; - html_url: string; - merge_base_commit: ReposCompareCommitsResponseMergeBaseCommit; - patch_url: string; - permalink_url: string; - status: string; - total_commits: number; - url: string; -}; -type ReposAddProtectedBranchUserRestrictionsResponseItem = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposAddProtectedBranchTeamRestrictionsResponseItem = { - description: string; - html_url: string; - id: number; - members_url: string; - name: string; - node_id: string; - parent: null; - permission: string; - privacy: string; - repositories_url: string; - slug: string; - url: string; -}; -type ReposAddProtectedBranchRequiredSignaturesResponse = { - enabled: boolean; - url: string; -}; -type ReposAddProtectedBranchAppRestrictionsResponseItemPermissions = { - contents: string; - issues: string; - metadata: string; - single_file: string; -}; -type ReposAddProtectedBranchAppRestrictionsResponseItemOwner = { - avatar_url: string; - description: string; - events_url: string; - hooks_url: string; - id: number; - issues_url: string; - login: string; - members_url: string; - node_id: string; - public_members_url: string; - repos_url: string; - url: string; -}; -type ReposAddProtectedBranchAppRestrictionsResponseItem = { - created_at: string; - description: string; - events: Array; - external_url: string; - html_url: string; - id: number; - name: string; - node_id: string; - owner: ReposAddProtectedBranchAppRestrictionsResponseItemOwner; - permissions: ReposAddProtectedBranchAppRestrictionsResponseItemPermissions; - slug: string; + tags_url: string; + teams_url: string; + temp_clone_token: string; + template_repository: null; + topics: Array; + trees_url: string; updated_at: string; -}; -type ReposAddProtectedBranchAdminEnforcementResponse = { - enabled: boolean; url: string; + visibility: string; + watchers_count: number; }; -type ReposAddDeployKeyResponse = { - created_at: string; - id: number; - key: string; - read_only: boolean; - title: string; - url: string; - verified: boolean; +type ReposCreateUsingTemplateResponsePermissions = { + admin: boolean; + pull: boolean; + push: boolean; }; -type ReposAddCollaboratorResponseRepositoryOwner = { +type ReposCreateUsingTemplateResponseOwner = { avatar_url: string; events_url: string; followers_url: string; @@ -9527,56 +6362,89 @@ type ReposAddCollaboratorResponseRepositoryOwner = { type: string; url: string; }; -type ReposAddCollaboratorResponseRepository = { +type ReposCreateUsingTemplateResponse = { + allow_merge_commit: boolean; + allow_rebase_merge: boolean; + allow_squash_merge: boolean; archive_url: string; + archived: boolean; assignees_url: string; blobs_url: string; branches_url: string; + clone_url: string; collaborators_url: string; comments_url: string; commits_url: string; compare_url: string; contents_url: string; contributors_url: string; + created_at: string; + default_branch: string; deployments_url: string; description: string; + disabled: boolean; downloads_url: string; events_url: string; fork: boolean; + forks_count: number; forks_url: string; full_name: string; git_commits_url: string; git_refs_url: string; git_tags_url: string; git_url: string; + has_downloads: boolean; + has_issues: boolean; + has_pages: boolean; + has_projects: boolean; + has_wiki: boolean; + homepage: string; + hooks_url: string; html_url: string; id: number; + is_template: boolean; issue_comment_url: string; issue_events_url: string; issues_url: string; keys_url: string; labels_url: string; + language: null; languages_url: string; merges_url: string; milestones_url: string; + mirror_url: string; name: string; + network_count: number; node_id: string; notifications_url: string; - owner: ReposAddCollaboratorResponseRepositoryOwner; + open_issues_count: number; + owner: ReposCreateUsingTemplateResponseOwner; + permissions: ReposCreateUsingTemplateResponsePermissions; private: boolean; pulls_url: string; + pushed_at: string; releases_url: string; + size: number; ssh_url: string; + stargazers_count: number; stargazers_url: string; statuses_url: string; + subscribers_count: number; subscribers_url: string; subscription_url: string; + svn_url: string; tags_url: string; teams_url: string; + temp_clone_token: string; + template_repository: ReposCreateUsingTemplateResponseTemplateRepository; + topics: Array; trees_url: string; + updated_at: string; url: string; + visibility: string; + watchers_count: number; }; -type ReposAddCollaboratorResponseInviter = { +type ReposCreateStatusResponseCreator = { avatar_url: string; events_url: string; followers_url: string; @@ -9596,37 +6464,20 @@ type ReposAddCollaboratorResponseInviter = { type: string; url: string; }; -type ReposAddCollaboratorResponseInvitee = { +type ReposCreateStatusResponse = { avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type ReposAddCollaboratorResponse = { + context: string; created_at: string; - html_url: string; + creator: ReposCreateStatusResponseCreator; + description: string; id: number; - invitee: ReposAddCollaboratorResponseInvitee; - inviter: ReposAddCollaboratorResponseInviter; - permissions: string; - repository: ReposAddCollaboratorResponseRepository; + node_id: string; + state: string; + target_url: string; + updated_at: string; url: string; }; -type ReactionsListForTeamDiscussionLegacyResponseItemUser = { +type ReposCreateReleaseResponseAuthor = { avatar_url: string; events_url: string; followers_url: string; @@ -9646,95 +6497,87 @@ type ReactionsListForTeamDiscussionLegacyResponseItemUser = { type: string; url: string; }; -type ReactionsListForTeamDiscussionLegacyResponseItem = { - content: string; +type ReposCreateReleaseResponse = { + assets: Array; + assets_url: string; + author: ReposCreateReleaseResponseAuthor; + body: string; created_at: string; + draft: boolean; + html_url: string; id: number; + name: string; node_id: string; - user: ReactionsListForTeamDiscussionLegacyResponseItemUser; + prerelease: boolean; + published_at: string; + tag_name: string; + tarball_url: string; + target_commitish: string; + upload_url: string; + url: string; + zipball_url: string; }; -type ReactionsListForTeamDiscussionInOrgResponseItemUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; +type ReposCreateOrUpdateFileResponseContentLinks = { + git: string; + html: string; + self: string; +}; +type ReposCreateOrUpdateFileResponseContent = { + _links: ReposCreateOrUpdateFileResponseContentLinks; + download_url: string; + git_url: string; html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; + name: string; + path: string; + sha: string; + size: number; type: string; url: string; }; -type ReactionsListForTeamDiscussionInOrgResponseItem = { - content: string; - created_at: string; - id: number; - node_id: string; - user: ReactionsListForTeamDiscussionInOrgResponseItemUser; +type ReposCreateOrUpdateFileResponseCommitVerification = { + payload: null; + reason: string; + signature: null; + verified: boolean; }; -type ReactionsListForTeamDiscussionCommentLegacyResponseItemUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; +type ReposCreateOrUpdateFileResponseCommitTree = { sha: string; url: string }; +type ReposCreateOrUpdateFileResponseCommitParentsItem = { html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; + sha: string; url: string; }; -type ReactionsListForTeamDiscussionCommentLegacyResponseItem = { - content: string; - created_at: string; - id: number; - node_id: string; - user: ReactionsListForTeamDiscussionCommentLegacyResponseItemUser; +type ReposCreateOrUpdateFileResponseCommitCommitter = { + date: string; + email: string; + name: string; }; -type ReactionsListForTeamDiscussionCommentInOrgResponseItemUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; +type ReposCreateOrUpdateFileResponseCommitAuthor = { + date: string; + email: string; + name: string; +}; +type ReposCreateOrUpdateFileResponseCommit = { + author: ReposCreateOrUpdateFileResponseCommitAuthor; + committer: ReposCreateOrUpdateFileResponseCommitCommitter; html_url: string; - id: number; - login: string; + message: string; node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; + parents: Array; + sha: string; + tree: ReposCreateOrUpdateFileResponseCommitTree; url: string; + verification: ReposCreateOrUpdateFileResponseCommitVerification; }; -type ReactionsListForTeamDiscussionCommentInOrgResponseItem = { - content: string; - created_at: string; - id: number; - node_id: string; - user: ReactionsListForTeamDiscussionCommentInOrgResponseItemUser; +type ReposCreateOrUpdateFileResponse = { + commit: ReposCreateOrUpdateFileResponseCommit; + content: ReposCreateOrUpdateFileResponseContent; +}; +type ReposCreateInOrgResponsePermissions = { + admin: boolean; + pull: boolean; + push: boolean; }; -type ReactionsListForTeamDiscussionCommentResponseItemUser = { +type ReposCreateInOrgResponseOwner = { avatar_url: string; events_url: string; followers_url: string; @@ -9754,41 +6597,118 @@ type ReactionsListForTeamDiscussionCommentResponseItemUser = { type: string; url: string; }; -type ReactionsListForTeamDiscussionCommentResponseItem = { - content: string; +type ReposCreateInOrgResponse = { + allow_merge_commit: boolean; + allow_rebase_merge: boolean; + allow_squash_merge: boolean; + archive_url: string; + archived: boolean; + assignees_url: string; + blobs_url: string; + branches_url: string; + clone_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; created_at: string; - id: number; - node_id: string; - user: ReactionsListForTeamDiscussionCommentResponseItemUser; -}; -type ReactionsListForTeamDiscussionResponseItemUser = { - avatar_url: string; + default_branch: string; + deployments_url: string; + description: string; + disabled: boolean; + downloads_url: string; events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; + fork: boolean; + forks_count: number; + forks_url: string; + full_name: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + has_downloads: boolean; + has_issues: boolean; + has_pages: boolean; + has_projects: boolean; + has_wiki: boolean; + homepage: string; + hooks_url: string; html_url: string; id: number; - login: string; + is_template: boolean; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + language: null; + languages_url: string; + merges_url: string; + milestones_url: string; + mirror_url: string; + name: string; + network_count: number; node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; + notifications_url: string; + open_issues_count: number; + owner: ReposCreateInOrgResponseOwner; + permissions: ReposCreateInOrgResponsePermissions; + private: boolean; + pulls_url: string; + pushed_at: string; + releases_url: string; + size: number; + ssh_url: string; + stargazers_count: number; + stargazers_url: string; + statuses_url: string; + subscribers_count: number; + subscribers_url: string; + subscription_url: string; + svn_url: string; + tags_url: string; + teams_url: string; + temp_clone_token: string; + template_repository: null; + topics: Array; + trees_url: string; + updated_at: string; url: string; + visibility: string; + watchers_count: number; }; -type ReactionsListForTeamDiscussionResponseItem = { - content: string; +type ReposCreateHookResponseLastResponse = { + code: null; + message: null; + status: string; +}; +type ReposCreateHookResponseConfig = { + content_type: string; + insecure_ssl: string; + url: string; +}; +type ReposCreateHookResponse = { + active: boolean; + config: ReposCreateHookResponseConfig; created_at: string; + events: Array; id: number; - node_id: string; - user: ReactionsListForTeamDiscussionResponseItemUser; + last_response: ReposCreateHookResponseLastResponse; + name: string; + ping_url: string; + test_url: string; + type: string; + updated_at: string; + url: string; }; -type ReactionsListForPullRequestReviewCommentResponseItemUser = { +type ReposCreateForkResponsePermissions = { + admin: boolean; + pull: boolean; + push: boolean; +}; +type ReposCreateForkResponseOwner = { avatar_url: string; events_url: string; followers_url: string; @@ -9808,14 +6728,94 @@ type ReactionsListForPullRequestReviewCommentResponseItemUser = { type: string; url: string; }; -type ReactionsListForPullRequestReviewCommentResponseItem = { - content: string; +type ReposCreateForkResponse = { + allow_merge_commit: boolean; + allow_rebase_merge: boolean; + allow_squash_merge: boolean; + archive_url: string; + archived: boolean; + assignees_url: string; + blobs_url: string; + branches_url: string; + clone_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; created_at: string; + default_branch: string; + deployments_url: string; + description: string; + disabled: boolean; + downloads_url: string; + events_url: string; + fork: boolean; + forks_count: number; + forks_url: string; + full_name: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + has_downloads: boolean; + has_issues: boolean; + has_pages: boolean; + has_projects: boolean; + has_wiki: boolean; + homepage: string; + hooks_url: string; + html_url: string; id: number; + is_template: boolean; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + language: null; + languages_url: string; + merges_url: string; + milestones_url: string; + mirror_url: string; + name: string; + network_count: number; node_id: string; - user: ReactionsListForPullRequestReviewCommentResponseItemUser; + notifications_url: string; + open_issues_count: number; + owner: ReposCreateForkResponseOwner; + permissions: ReposCreateForkResponsePermissions; + private: boolean; + pulls_url: string; + pushed_at: string; + releases_url: string; + size: number; + ssh_url: string; + stargazers_count: number; + stargazers_url: string; + statuses_url: string; + subscribers_count: number; + subscribers_url: string; + subscription_url: string; + svn_url: string; + tags_url: string; + teams_url: string; + temp_clone_token: string; + template_repository: null; + topics: Array; + trees_url: string; + updated_at: string; + url: string; + visibility: string; + watchers_count: number; }; -type ReactionsListForIssueCommentResponseItemUser = { +type ReposCreateForAuthenticatedUserResponsePermissions = { + admin: boolean; + pull: boolean; + push: boolean; +}; +type ReposCreateForAuthenticatedUserResponseOwner = { avatar_url: string; events_url: string; followers_url: string; @@ -9835,14 +6835,89 @@ type ReactionsListForIssueCommentResponseItemUser = { type: string; url: string; }; -type ReactionsListForIssueCommentResponseItem = { - content: string; +type ReposCreateForAuthenticatedUserResponse = { + allow_merge_commit: boolean; + allow_rebase_merge: boolean; + allow_squash_merge: boolean; + archive_url: string; + archived: boolean; + assignees_url: string; + blobs_url: string; + branches_url: string; + clone_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; created_at: string; + default_branch: string; + deployments_url: string; + description: string; + disabled: boolean; + downloads_url: string; + events_url: string; + fork: boolean; + forks_count: number; + forks_url: string; + full_name: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; + has_downloads: boolean; + has_issues: boolean; + has_pages: boolean; + has_projects: boolean; + has_wiki: boolean; + homepage: string; + hooks_url: string; + html_url: string; id: number; + is_template: boolean; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + language: null; + languages_url: string; + merges_url: string; + milestones_url: string; + mirror_url: string; + name: string; + network_count: number; node_id: string; - user: ReactionsListForIssueCommentResponseItemUser; + notifications_url: string; + open_issues_count: number; + owner: ReposCreateForAuthenticatedUserResponseOwner; + permissions: ReposCreateForAuthenticatedUserResponsePermissions; + private: boolean; + pulls_url: string; + pushed_at: string; + releases_url: string; + size: number; + ssh_url: string; + stargazers_count: number; + stargazers_url: string; + statuses_url: string; + subscribers_count: number; + subscribers_url: string; + subscription_url: string; + svn_url: string; + tags_url: string; + teams_url: string; + temp_clone_token: string; + template_repository: null; + topics: Array; + trees_url: string; + updated_at: string; + url: string; + visibility: string; + watchers_count: number; }; -type ReactionsListForIssueResponseItemUser = { +type ReposCreateDeploymentStatusResponseCreator = { avatar_url: string; events_url: string; followers_url: string; @@ -9862,14 +6937,24 @@ type ReactionsListForIssueResponseItemUser = { type: string; url: string; }; -type ReactionsListForIssueResponseItem = { - content: string; +type ReposCreateDeploymentStatusResponse = { created_at: string; + creator: ReposCreateDeploymentStatusResponseCreator; + deployment_url: string; + description: string; + environment: string; + environment_url: string; id: number; + log_url: string; node_id: string; - user: ReactionsListForIssueResponseItemUser; + repository_url: string; + state: string; + target_url: string; + updated_at: string; + url: string; }; -type ReactionsListForCommitCommentResponseItemUser = { +type ReposCreateDeploymentResponsePayload = { deploy: string }; +type ReposCreateDeploymentResponseCreator = { avatar_url: string; events_url: string; followers_url: string; @@ -9889,14 +6974,26 @@ type ReactionsListForCommitCommentResponseItemUser = { type: string; url: string; }; -type ReactionsListForCommitCommentResponseItem = { - content: string; +type ReposCreateDeploymentResponse = { created_at: string; + creator: ReposCreateDeploymentResponseCreator; + description: string; + environment: string; id: number; node_id: string; - user: ReactionsListForCommitCommentResponseItemUser; + original_environment: string; + payload: ReposCreateDeploymentResponsePayload; + production_environment: boolean; + ref: string; + repository_url: string; + sha: string; + statuses_url: string; + task: string; + transient_environment: boolean; + updated_at: string; + url: string; }; -type ReactionsCreateForTeamDiscussionLegacyResponseUser = { +type ReposCreateCommitCommentResponseUser = { avatar_url: string; events_url: string; followers_url: string; @@ -9916,41 +7013,25 @@ type ReactionsCreateForTeamDiscussionLegacyResponseUser = { type: string; url: string; }; -type ReactionsCreateForTeamDiscussionLegacyResponse = { - content: string; +type ReposCreateCommitCommentResponse = { + body: string; + commit_id: string; created_at: string; - id: number; - node_id: string; - user: ReactionsCreateForTeamDiscussionLegacyResponseUser; -}; -type ReactionsCreateForTeamDiscussionInOrgResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; html_url: string; id: number; - login: string; + line: number; node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; + path: string; + position: number; + updated_at: string; url: string; + user: ReposCreateCommitCommentResponseUser; }; -type ReactionsCreateForTeamDiscussionInOrgResponse = { - content: string; - created_at: string; - id: number; - node_id: string; - user: ReactionsCreateForTeamDiscussionInOrgResponseUser; +type ReposCompareCommitsResponseMergeBaseCommitParentsItem = { + sha: string; + url: string; }; -type ReactionsCreateForTeamDiscussionCommentLegacyResponseUser = { +type ReposCompareCommitsResponseMergeBaseCommitCommitter = { avatar_url: string; events_url: string; followers_url: string; @@ -9970,41 +7051,36 @@ type ReactionsCreateForTeamDiscussionCommentLegacyResponseUser = { type: string; url: string; }; -type ReactionsCreateForTeamDiscussionCommentLegacyResponse = { - content: string; - created_at: string; - id: number; - node_id: string; - user: ReactionsCreateForTeamDiscussionCommentLegacyResponseUser; +type ReposCompareCommitsResponseMergeBaseCommitCommitVerification = { + payload: null; + reason: string; + signature: null; + verified: boolean; }; -type ReactionsCreateForTeamDiscussionCommentInOrgResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; +type ReposCompareCommitsResponseMergeBaseCommitCommitTree = { + sha: string; url: string; }; -type ReactionsCreateForTeamDiscussionCommentInOrgResponse = { - content: string; - created_at: string; - id: number; - node_id: string; - user: ReactionsCreateForTeamDiscussionCommentInOrgResponseUser; +type ReposCompareCommitsResponseMergeBaseCommitCommitCommitter = { + date: string; + email: string; + name: string; +}; +type ReposCompareCommitsResponseMergeBaseCommitCommitAuthor = { + date: string; + email: string; + name: string; +}; +type ReposCompareCommitsResponseMergeBaseCommitCommit = { + author: ReposCompareCommitsResponseMergeBaseCommitCommitAuthor; + comment_count: number; + committer: ReposCompareCommitsResponseMergeBaseCommitCommitCommitter; + message: string; + tree: ReposCompareCommitsResponseMergeBaseCommitCommitTree; + url: string; + verification: ReposCompareCommitsResponseMergeBaseCommitCommitVerification; }; -type ReactionsCreateForTeamDiscussionCommentResponseUser = { +type ReposCompareCommitsResponseMergeBaseCommitAuthor = { avatar_url: string; events_url: string; followers_url: string; @@ -10024,41 +7100,34 @@ type ReactionsCreateForTeamDiscussionCommentResponseUser = { type: string; url: string; }; -type ReactionsCreateForTeamDiscussionCommentResponse = { - content: string; - created_at: string; - id: number; - node_id: string; - user: ReactionsCreateForTeamDiscussionCommentResponseUser; -}; -type ReactionsCreateForTeamDiscussionResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; +type ReposCompareCommitsResponseMergeBaseCommit = { + author: ReposCompareCommitsResponseMergeBaseCommitAuthor; + comments_url: string; + commit: ReposCompareCommitsResponseMergeBaseCommitCommit; + committer: ReposCompareCommitsResponseMergeBaseCommitCommitter; html_url: string; - id: number; - login: string; node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; + parents: Array; + sha: string; url: string; }; -type ReactionsCreateForTeamDiscussionResponse = { - content: string; - created_at: string; - id: number; - node_id: string; - user: ReactionsCreateForTeamDiscussionResponseUser; +type ReposCompareCommitsResponseFilesItem = { + additions: number; + blob_url: string; + changes: number; + contents_url: string; + deletions: number; + filename: string; + patch: string; + raw_url: string; + sha: string; + status: string; }; -type ReactionsCreateForPullRequestReviewCommentResponseUser = { +type ReposCompareCommitsResponseCommitsItemParentsItem = { + sha: string; + url: string; +}; +type ReposCompareCommitsResponseCommitsItemCommitter = { avatar_url: string; events_url: string; followers_url: string; @@ -10078,14 +7147,36 @@ type ReactionsCreateForPullRequestReviewCommentResponseUser = { type: string; url: string; }; -type ReactionsCreateForPullRequestReviewCommentResponse = { - content: string; - created_at: string; - id: number; - node_id: string; - user: ReactionsCreateForPullRequestReviewCommentResponseUser; +type ReposCompareCommitsResponseCommitsItemCommitVerification = { + payload: null; + reason: string; + signature: null; + verified: boolean; }; -type ReactionsCreateForIssueCommentResponseUser = { +type ReposCompareCommitsResponseCommitsItemCommitTree = { + sha: string; + url: string; +}; +type ReposCompareCommitsResponseCommitsItemCommitCommitter = { + date: string; + email: string; + name: string; +}; +type ReposCompareCommitsResponseCommitsItemCommitAuthor = { + date: string; + email: string; + name: string; +}; +type ReposCompareCommitsResponseCommitsItemCommit = { + author: ReposCompareCommitsResponseCommitsItemCommitAuthor; + comment_count: number; + committer: ReposCompareCommitsResponseCommitsItemCommitCommitter; + message: string; + tree: ReposCompareCommitsResponseCommitsItemCommitTree; + url: string; + verification: ReposCompareCommitsResponseCommitsItemCommitVerification; +}; +type ReposCompareCommitsResponseCommitsItemAuthor = { avatar_url: string; events_url: string; followers_url: string; @@ -10105,14 +7196,22 @@ type ReactionsCreateForIssueCommentResponseUser = { type: string; url: string; }; -type ReactionsCreateForIssueCommentResponse = { - content: string; - created_at: string; - id: number; +type ReposCompareCommitsResponseCommitsItem = { + author: ReposCompareCommitsResponseCommitsItemAuthor; + comments_url: string; + commit: ReposCompareCommitsResponseCommitsItemCommit; + committer: ReposCompareCommitsResponseCommitsItemCommitter; + html_url: string; node_id: string; - user: ReactionsCreateForIssueCommentResponseUser; + parents: Array; + sha: string; + url: string; }; -type ReactionsCreateForIssueResponseUser = { +type ReposCompareCommitsResponseBaseCommitParentsItem = { + sha: string; + url: string; +}; +type ReposCompareCommitsResponseBaseCommitCommitter = { avatar_url: string; events_url: string; followers_url: string; @@ -10132,14 +7231,36 @@ type ReactionsCreateForIssueResponseUser = { type: string; url: string; }; -type ReactionsCreateForIssueResponse = { - content: string; - created_at: string; - id: number; - node_id: string; - user: ReactionsCreateForIssueResponseUser; +type ReposCompareCommitsResponseBaseCommitCommitVerification = { + payload: null; + reason: string; + signature: null; + verified: boolean; }; -type ReactionsCreateForCommitCommentResponseUser = { +type ReposCompareCommitsResponseBaseCommitCommitTree = { + sha: string; + url: string; +}; +type ReposCompareCommitsResponseBaseCommitCommitCommitter = { + date: string; + email: string; + name: string; +}; +type ReposCompareCommitsResponseBaseCommitCommitAuthor = { + date: string; + email: string; + name: string; +}; +type ReposCompareCommitsResponseBaseCommitCommit = { + author: ReposCompareCommitsResponseBaseCommitCommitAuthor; + comment_count: number; + committer: ReposCompareCommitsResponseBaseCommitCommitCommitter; + message: string; + tree: ReposCompareCommitsResponseBaseCommitCommitTree; + url: string; + verification: ReposCompareCommitsResponseBaseCommitCommitVerification; +}; +type ReposCompareCommitsResponseBaseCommitAuthor = { avatar_url: string; events_url: string; followers_url: string; @@ -10159,49 +7280,33 @@ type ReactionsCreateForCommitCommentResponseUser = { type: string; url: string; }; -type ReactionsCreateForCommitCommentResponse = { - content: string; - created_at: string; - id: number; +type ReposCompareCommitsResponseBaseCommit = { + author: ReposCompareCommitsResponseBaseCommitAuthor; + comments_url: string; + commit: ReposCompareCommitsResponseBaseCommitCommit; + committer: ReposCompareCommitsResponseBaseCommitCommitter; + html_url: string; node_id: string; - user: ReactionsCreateForCommitCommentResponseUser; -}; -type RateLimitGetResponseResourcesSearch = { - limit: number; - remaining: number; - reset: number; -}; -type RateLimitGetResponseResourcesIntegrationManifest = { - limit: number; - remaining: number; - reset: number; -}; -type RateLimitGetResponseResourcesGraphql = { - limit: number; - remaining: number; - reset: number; -}; -type RateLimitGetResponseResourcesCore = { - limit: number; - remaining: number; - reset: number; -}; -type RateLimitGetResponseResources = { - core: RateLimitGetResponseResourcesCore; - graphql: RateLimitGetResponseResourcesGraphql; - integration_manifest: RateLimitGetResponseResourcesIntegrationManifest; - search: RateLimitGetResponseResourcesSearch; -}; -type RateLimitGetResponseRate = { - limit: number; - remaining: number; - reset: number; + parents: Array; + sha: string; + url: string; }; -type RateLimitGetResponse = { - rate: RateLimitGetResponseRate; - resources: RateLimitGetResponseResources; +type ReposCompareCommitsResponse = { + ahead_by: number; + base_commit: ReposCompareCommitsResponseBaseCommit; + behind_by: number; + commits: Array; + diff_url: string; + files: Array; + html_url: string; + merge_base_commit: ReposCompareCommitsResponseMergeBaseCommit; + patch_url: string; + permalink_url: string; + status: string; + total_commits: number; + url: string; }; -type PullsUpdateReviewResponseUser = { +type ReposAddProtectedBranchUserRestrictionsResponseItem = { avatar_url: string; events_url: string; followers_url: string; @@ -10221,80 +7326,72 @@ type PullsUpdateReviewResponseUser = { type: string; url: string; }; -type PullsUpdateReviewResponseLinksPullRequest = { href: string }; -type PullsUpdateReviewResponseLinksHtml = { href: string }; -type PullsUpdateReviewResponseLinks = { - html: PullsUpdateReviewResponseLinksHtml; - pull_request: PullsUpdateReviewResponseLinksPullRequest; -}; -type PullsUpdateReviewResponse = { - _links: PullsUpdateReviewResponseLinks; - body: string; - commit_id: string; +type ReposAddProtectedBranchTeamRestrictionsResponseItem = { + description: string; html_url: string; id: number; + members_url: string; + name: string; node_id: string; - pull_request_url: string; - state: string; - user: PullsUpdateReviewResponseUser; + parent: null; + permission: string; + privacy: string; + repositories_url: string; + slug: string; + url: string; }; -type PullsUpdateCommentResponseUser = { +type ReposAddProtectedBranchRequiredSignaturesResponse = { + enabled: boolean; + url: string; +}; +type ReposAddProtectedBranchAppRestrictionsResponseItemPermissions = { + contents: string; + issues: string; + metadata: string; + single_file: string; +}; +type ReposAddProtectedBranchAppRestrictionsResponseItemOwner = { avatar_url: string; + description: string; events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; + hooks_url: string; id: number; + issues_url: string; login: string; + members_url: string; node_id: string; - organizations_url: string; - received_events_url: string; + public_members_url: string; repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; url: string; }; -type PullsUpdateCommentResponseLinksSelf = { href: string }; -type PullsUpdateCommentResponseLinksPullRequest = { href: string }; -type PullsUpdateCommentResponseLinksHtml = { href: string }; -type PullsUpdateCommentResponseLinks = { - html: PullsUpdateCommentResponseLinksHtml; - pull_request: PullsUpdateCommentResponseLinksPullRequest; - self: PullsUpdateCommentResponseLinksSelf; -}; -type PullsUpdateCommentResponse = { - _links: PullsUpdateCommentResponseLinks; - author_association: string; - body: string; - commit_id: string; +type ReposAddProtectedBranchAppRestrictionsResponseItem = { created_at: string; - diff_hunk: string; + description: string; + events: Array; + external_url: string; html_url: string; id: number; - in_reply_to_id: number; - line: number; + name: string; node_id: string; - original_commit_id: string; - original_line: number; - original_position: number; - original_start_line: number; - path: string; - position: number; - pull_request_review_id: number; - pull_request_url: string; - side: string; - start_line: number; - start_side: string; + owner: ReposAddProtectedBranchAppRestrictionsResponseItemOwner; + permissions: ReposAddProtectedBranchAppRestrictionsResponseItemPermissions; + slug: string; updated_at: string; +}; +type ReposAddProtectedBranchAdminEnforcementResponse = { + enabled: boolean; url: string; - user: PullsUpdateCommentResponseUser; }; -type PullsUpdateBranchResponse = { message: string; url: string }; -type PullsUpdateResponseUser = { +type ReposAddDeployKeyResponse = { + created_at: string; + id: number; + key: string; + read_only: boolean; + title: string; + url: string; + verified: boolean; +}; +type ReposAddCollaboratorResponseRepositoryOwner = { avatar_url: string; events_url: string; followers_url: string; @@ -10314,21 +7411,56 @@ type PullsUpdateResponseUser = { type: string; url: string; }; -type PullsUpdateResponseRequestedTeamsItem = { +type ReposAddCollaboratorResponseRepository = { + archive_url: string; + assignees_url: string; + blobs_url: string; + branches_url: string; + collaborators_url: string; + comments_url: string; + commits_url: string; + compare_url: string; + contents_url: string; + contributors_url: string; + deployments_url: string; description: string; + downloads_url: string; + events_url: string; + fork: boolean; + forks_url: string; + full_name: string; + git_commits_url: string; + git_refs_url: string; + git_tags_url: string; + git_url: string; html_url: string; id: number; - members_url: string; + issue_comment_url: string; + issue_events_url: string; + issues_url: string; + keys_url: string; + labels_url: string; + languages_url: string; + merges_url: string; + milestones_url: string; name: string; node_id: string; - parent: null; - permission: string; - privacy: string; - repositories_url: string; - slug: string; + notifications_url: string; + owner: ReposAddCollaboratorResponseRepositoryOwner; + private: boolean; + pulls_url: string; + releases_url: string; + ssh_url: string; + stargazers_url: string; + statuses_url: string; + subscribers_url: string; + subscription_url: string; + tags_url: string; + teams_url: string; + trees_url: string; url: string; }; -type PullsUpdateResponseRequestedReviewersItem = { +type ReposAddCollaboratorResponseInviter = { avatar_url: string; events_url: string; followers_url: string; @@ -10348,7 +7480,7 @@ type PullsUpdateResponseRequestedReviewersItem = { type: string; url: string; }; -type PullsUpdateResponseMilestoneCreator = { +type ReposAddCollaboratorResponseInvitee = { avatar_url: string; events_url: string; followers_url: string; @@ -10368,25 +7500,17 @@ type PullsUpdateResponseMilestoneCreator = { type: string; url: string; }; -type PullsUpdateResponseMilestone = { - closed_at: string; - closed_issues: number; +type ReposAddCollaboratorResponse = { created_at: string; - creator: PullsUpdateResponseMilestoneCreator; - description: string; - due_on: string; html_url: string; id: number; - labels_url: string; - node_id: string; - number: number; - open_issues: number; - state: string; - title: string; - updated_at: string; + invitee: ReposAddCollaboratorResponseInvitee; + inviter: ReposAddCollaboratorResponseInviter; + permissions: string; + repository: ReposAddCollaboratorResponseRepository; url: string; }; -type PullsUpdateResponseMergedBy = { +type ReactionsListForTeamDiscussionInOrgResponseItemUser = { avatar_url: string; events_url: string; followers_url: string; @@ -10406,16 +7530,14 @@ type PullsUpdateResponseMergedBy = { type: string; url: string; }; -type PullsUpdateResponseLabelsItem = { - color: string; - default: boolean; - description: string; +type ReactionsListForTeamDiscussionInOrgResponseItem = { + content: string; + created_at: string; id: number; - name: string; node_id: string; - url: string; + user: ReactionsListForTeamDiscussionInOrgResponseItemUser; }; -type PullsUpdateResponseHeadUser = { +type ReactionsListForTeamDiscussionCommentInOrgResponseItemUser = { avatar_url: string; events_url: string; followers_url: string; @@ -10435,12 +7557,14 @@ type PullsUpdateResponseHeadUser = { type: string; url: string; }; -type PullsUpdateResponseHeadRepoPermissions = { - admin: boolean; - pull: boolean; - push: boolean; +type ReactionsListForTeamDiscussionCommentInOrgResponseItem = { + content: string; + created_at: string; + id: number; + node_id: string; + user: ReactionsListForTeamDiscussionCommentInOrgResponseItemUser; }; -type PullsUpdateResponseHeadRepoOwner = { +type ReactionsListForPullRequestReviewCommentResponseItemUser = { avatar_url: string; events_url: string; followers_url: string; @@ -10460,96 +7584,14 @@ type PullsUpdateResponseHeadRepoOwner = { type: string; url: string; }; -type PullsUpdateResponseHeadRepo = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; +type ReactionsListForPullRequestReviewCommentResponseItem = { + content: string; created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; node_id: string; - notifications_url: string; - open_issues_count: number; - owner: PullsUpdateResponseHeadRepoOwner; - permissions: PullsUpdateResponseHeadRepoPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - temp_clone_token: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - visibility: string; - watchers_count: number; -}; -type PullsUpdateResponseHead = { - label: string; - ref: string; - repo: PullsUpdateResponseHeadRepo; - sha: string; - user: PullsUpdateResponseHeadUser; + user: ReactionsListForPullRequestReviewCommentResponseItemUser; }; -type PullsUpdateResponseBaseUser = { +type ReactionsListForIssueCommentResponseItemUser = { avatar_url: string; events_url: string; followers_url: string; @@ -10569,12 +7611,14 @@ type PullsUpdateResponseBaseUser = { type: string; url: string; }; -type PullsUpdateResponseBaseRepoPermissions = { - admin: boolean; - pull: boolean; - push: boolean; +type ReactionsListForIssueCommentResponseItem = { + content: string; + created_at: string; + id: number; + node_id: string; + user: ReactionsListForIssueCommentResponseItemUser; }; -type PullsUpdateResponseBaseRepoOwner = { +type ReactionsListForIssueResponseItemUser = { avatar_url: string; events_url: string; followers_url: string; @@ -10594,96 +7638,14 @@ type PullsUpdateResponseBaseRepoOwner = { type: string; url: string; }; -type PullsUpdateResponseBaseRepo = { - allow_merge_commit: boolean; - allow_rebase_merge: boolean; - allow_squash_merge: boolean; - archive_url: string; - archived: boolean; - assignees_url: string; - blobs_url: string; - branches_url: string; - clone_url: string; - collaborators_url: string; - comments_url: string; - commits_url: string; - compare_url: string; - contents_url: string; - contributors_url: string; +type ReactionsListForIssueResponseItem = { + content: string; created_at: string; - default_branch: string; - deployments_url: string; - description: string; - disabled: boolean; - downloads_url: string; - events_url: string; - fork: boolean; - forks_count: number; - forks_url: string; - full_name: string; - git_commits_url: string; - git_refs_url: string; - git_tags_url: string; - git_url: string; - has_downloads: boolean; - has_issues: boolean; - has_pages: boolean; - has_projects: boolean; - has_wiki: boolean; - homepage: string; - hooks_url: string; - html_url: string; id: number; - is_template: boolean; - issue_comment_url: string; - issue_events_url: string; - issues_url: string; - keys_url: string; - labels_url: string; - language: null; - languages_url: string; - merges_url: string; - milestones_url: string; - mirror_url: string; - name: string; - network_count: number; node_id: string; - notifications_url: string; - open_issues_count: number; - owner: PullsUpdateResponseBaseRepoOwner; - permissions: PullsUpdateResponseBaseRepoPermissions; - private: boolean; - pulls_url: string; - pushed_at: string; - releases_url: string; - size: number; - ssh_url: string; - stargazers_count: number; - stargazers_url: string; - statuses_url: string; - subscribers_count: number; - subscribers_url: string; - subscription_url: string; - svn_url: string; - tags_url: string; - teams_url: string; - temp_clone_token: string; - template_repository: null; - topics: Array; - trees_url: string; - updated_at: string; - url: string; - visibility: string; - watchers_count: number; -}; -type PullsUpdateResponseBase = { - label: string; - ref: string; - repo: PullsUpdateResponseBaseRepo; - sha: string; - user: PullsUpdateResponseBaseUser; + user: ReactionsListForIssueResponseItemUser; }; -type PullsUpdateResponseAssigneesItem = { +type ReactionsListForCommitCommentResponseItemUser = { avatar_url: string; events_url: string; followers_url: string; @@ -10703,7 +7665,14 @@ type PullsUpdateResponseAssigneesItem = { type: string; url: string; }; -type PullsUpdateResponseAssignee = { +type ReactionsListForCommitCommentResponseItem = { + content: string; + created_at: string; + id: number; + node_id: string; + user: ReactionsListForCommitCommentResponseItemUser; +}; +type ReactionsCreateForTeamDiscussionInOrgResponseUser = { avatar_url: string; events_url: string; followers_url: string; @@ -10723,74 +7692,14 @@ type PullsUpdateResponseAssignee = { type: string; url: string; }; -type PullsUpdateResponseLinksStatuses = { href: string }; -type PullsUpdateResponseLinksSelf = { href: string }; -type PullsUpdateResponseLinksReviewComments = { href: string }; -type PullsUpdateResponseLinksReviewComment = { href: string }; -type PullsUpdateResponseLinksIssue = { href: string }; -type PullsUpdateResponseLinksHtml = { href: string }; -type PullsUpdateResponseLinksCommits = { href: string }; -type PullsUpdateResponseLinksComments = { href: string }; -type PullsUpdateResponseLinks = { - comments: PullsUpdateResponseLinksComments; - commits: PullsUpdateResponseLinksCommits; - html: PullsUpdateResponseLinksHtml; - issue: PullsUpdateResponseLinksIssue; - review_comment: PullsUpdateResponseLinksReviewComment; - review_comments: PullsUpdateResponseLinksReviewComments; - self: PullsUpdateResponseLinksSelf; - statuses: PullsUpdateResponseLinksStatuses; -}; -type PullsUpdateResponse = { - _links: PullsUpdateResponseLinks; - active_lock_reason: string; - additions: number; - assignee: PullsUpdateResponseAssignee; - assignees: Array; - author_association: string; - base: PullsUpdateResponseBase; - body: string; - changed_files: number; - closed_at: string; - comments: number; - comments_url: string; - commits: number; - commits_url: string; +type ReactionsCreateForTeamDiscussionInOrgResponse = { + content: string; created_at: string; - deletions: number; - diff_url: string; - draft: boolean; - head: PullsUpdateResponseHead; - html_url: string; id: number; - issue_url: string; - labels: Array; - locked: boolean; - maintainer_can_modify: boolean; - merge_commit_sha: string; - mergeable: boolean; - mergeable_state: string; - merged: boolean; - merged_at: string; - merged_by: PullsUpdateResponseMergedBy; - milestone: PullsUpdateResponseMilestone; node_id: string; - number: number; - patch_url: string; - rebaseable: boolean; - requested_reviewers: Array; - requested_teams: Array; - review_comment_url: string; - review_comments: number; - review_comments_url: string; - state: string; - statuses_url: string; - title: string; - updated_at: string; - url: string; - user: PullsUpdateResponseUser; + user: ReactionsCreateForTeamDiscussionInOrgResponseUser; }; -type PullsSubmitReviewResponseUser = { +type ReactionsCreateForTeamDiscussionCommentInOrgResponseUser = { avatar_url: string; events_url: string; followers_url: string; @@ -10810,26 +7719,14 @@ type PullsSubmitReviewResponseUser = { type: string; url: string; }; -type PullsSubmitReviewResponseLinksPullRequest = { href: string }; -type PullsSubmitReviewResponseLinksHtml = { href: string }; -type PullsSubmitReviewResponseLinks = { - html: PullsSubmitReviewResponseLinksHtml; - pull_request: PullsSubmitReviewResponseLinksPullRequest; -}; -type PullsSubmitReviewResponse = { - _links: PullsSubmitReviewResponseLinks; - body: string; - commit_id: string; - html_url: string; +type ReactionsCreateForTeamDiscussionCommentInOrgResponse = { + content: string; + created_at: string; id: number; node_id: string; - pull_request_url: string; - state: string; - submitted_at: string; - user: PullsSubmitReviewResponseUser; + user: ReactionsCreateForTeamDiscussionCommentInOrgResponseUser; }; -type PullsMergeResponse = { merged: boolean; message: string; sha: string }; -type PullsListReviewsResponseItemUser = { +type ReactionsCreateForPullRequestReviewCommentResponseUser = { avatar_url: string; events_url: string; followers_url: string; @@ -10849,25 +7746,14 @@ type PullsListReviewsResponseItemUser = { type: string; url: string; }; -type PullsListReviewsResponseItemLinksPullRequest = { href: string }; -type PullsListReviewsResponseItemLinksHtml = { href: string }; -type PullsListReviewsResponseItemLinks = { - html: PullsListReviewsResponseItemLinksHtml; - pull_request: PullsListReviewsResponseItemLinksPullRequest; -}; -type PullsListReviewsResponseItem = { - _links: PullsListReviewsResponseItemLinks; - body: string; - commit_id: string; - html_url: string; +type ReactionsCreateForPullRequestReviewCommentResponse = { + content: string; + created_at: string; id: number; node_id: string; - pull_request_url: string; - state: string; - submitted_at: string; - user: PullsListReviewsResponseItemUser; + user: ReactionsCreateForPullRequestReviewCommentResponseUser; }; -type PullsListReviewRequestsResponseUsersItem = { +type ReactionsCreateForIssueCommentResponseUser = { avatar_url: string; events_url: string; followers_url: string; @@ -10887,38 +7773,14 @@ type PullsListReviewRequestsResponseUsersItem = { type: string; url: string; }; -type PullsListReviewRequestsResponseTeamsItem = { - description: string; - html_url: string; +type ReactionsCreateForIssueCommentResponse = { + content: string; + created_at: string; id: number; - members_url: string; - name: string; node_id: string; - parent: null; - permission: string; - privacy: string; - repositories_url: string; - slug: string; - url: string; -}; -type PullsListReviewRequestsResponse = { - teams: Array; - users: Array; -}; -type PullsListFilesResponseItem = { - additions: number; - blob_url: string; - changes: number; - contents_url: string; - deletions: number; - filename: string; - patch: string; - raw_url: string; - sha: string; - status: string; + user: ReactionsCreateForIssueCommentResponseUser; }; -type PullsListCommitsResponseItemParentsItem = { sha: string; url: string }; -type PullsListCommitsResponseItemCommitter = { +type ReactionsCreateForIssueResponseUser = { avatar_url: string; events_url: string; followers_url: string; @@ -10938,33 +7800,14 @@ type PullsListCommitsResponseItemCommitter = { type: string; url: string; }; -type PullsListCommitsResponseItemCommitVerification = { - payload: null; - reason: string; - signature: null; - verified: boolean; -}; -type PullsListCommitsResponseItemCommitTree = { sha: string; url: string }; -type PullsListCommitsResponseItemCommitCommitter = { - date: string; - email: string; - name: string; -}; -type PullsListCommitsResponseItemCommitAuthor = { - date: string; - email: string; - name: string; -}; -type PullsListCommitsResponseItemCommit = { - author: PullsListCommitsResponseItemCommitAuthor; - comment_count: number; - committer: PullsListCommitsResponseItemCommitCommitter; - message: string; - tree: PullsListCommitsResponseItemCommitTree; - url: string; - verification: PullsListCommitsResponseItemCommitVerification; +type ReactionsCreateForIssueResponse = { + content: string; + created_at: string; + id: number; + node_id: string; + user: ReactionsCreateForIssueResponseUser; }; -type PullsListCommitsResponseItemAuthor = { +type ReactionsCreateForCommitCommentResponseUser = { avatar_url: string; events_url: string; followers_url: string; @@ -10984,18 +7827,49 @@ type PullsListCommitsResponseItemAuthor = { type: string; url: string; }; -type PullsListCommitsResponseItem = { - author: PullsListCommitsResponseItemAuthor; - comments_url: string; - commit: PullsListCommitsResponseItemCommit; - committer: PullsListCommitsResponseItemCommitter; - html_url: string; +type ReactionsCreateForCommitCommentResponse = { + content: string; + created_at: string; + id: number; node_id: string; - parents: Array; - sha: string; - url: string; + user: ReactionsCreateForCommitCommentResponseUser; }; -type PullsListCommentsForRepoResponseItemUser = { +type RateLimitGetResponseResourcesSearch = { + limit: number; + remaining: number; + reset: number; +}; +type RateLimitGetResponseResourcesIntegrationManifest = { + limit: number; + remaining: number; + reset: number; +}; +type RateLimitGetResponseResourcesGraphql = { + limit: number; + remaining: number; + reset: number; +}; +type RateLimitGetResponseResourcesCore = { + limit: number; + remaining: number; + reset: number; +}; +type RateLimitGetResponseResources = { + core: RateLimitGetResponseResourcesCore; + graphql: RateLimitGetResponseResourcesGraphql; + integration_manifest: RateLimitGetResponseResourcesIntegrationManifest; + search: RateLimitGetResponseResourcesSearch; +}; +type RateLimitGetResponseRate = { + limit: number; + remaining: number; + reset: number; +}; +type RateLimitGetResponse = { + rate: RateLimitGetResponseRate; + resources: RateLimitGetResponseResources; +}; +type PullsUpdateReviewResponseUser = { avatar_url: string; events_url: string; followers_url: string; @@ -11015,42 +7889,24 @@ type PullsListCommentsForRepoResponseItemUser = { type: string; url: string; }; -type PullsListCommentsForRepoResponseItemLinksSelf = { href: string }; -type PullsListCommentsForRepoResponseItemLinksPullRequest = { href: string }; -type PullsListCommentsForRepoResponseItemLinksHtml = { href: string }; -type PullsListCommentsForRepoResponseItemLinks = { - html: PullsListCommentsForRepoResponseItemLinksHtml; - pull_request: PullsListCommentsForRepoResponseItemLinksPullRequest; - self: PullsListCommentsForRepoResponseItemLinksSelf; +type PullsUpdateReviewResponseLinksPullRequest = { href: string }; +type PullsUpdateReviewResponseLinksHtml = { href: string }; +type PullsUpdateReviewResponseLinks = { + html: PullsUpdateReviewResponseLinksHtml; + pull_request: PullsUpdateReviewResponseLinksPullRequest; }; -type PullsListCommentsForRepoResponseItem = { - _links: PullsListCommentsForRepoResponseItemLinks; - author_association: string; +type PullsUpdateReviewResponse = { + _links: PullsUpdateReviewResponseLinks; body: string; commit_id: string; - created_at: string; - diff_hunk: string; html_url: string; id: number; - in_reply_to_id: number; - line: number; node_id: string; - original_commit_id: string; - original_line: number; - original_position: number; - original_start_line: number; - path: string; - position: number; - pull_request_review_id: number; pull_request_url: string; - side: string; - start_line: number; - start_side: string; - updated_at: string; - url: string; - user: PullsListCommentsForRepoResponseItemUser; + state: string; + user: PullsUpdateReviewResponseUser; }; -type PullsListCommentsResponseItemUser = { +type PullsUpdateCommentResponseUser = { avatar_url: string; events_url: string; followers_url: string; @@ -11070,16 +7926,16 @@ type PullsListCommentsResponseItemUser = { type: string; url: string; }; -type PullsListCommentsResponseItemLinksSelf = { href: string }; -type PullsListCommentsResponseItemLinksPullRequest = { href: string }; -type PullsListCommentsResponseItemLinksHtml = { href: string }; -type PullsListCommentsResponseItemLinks = { - html: PullsListCommentsResponseItemLinksHtml; - pull_request: PullsListCommentsResponseItemLinksPullRequest; - self: PullsListCommentsResponseItemLinksSelf; +type PullsUpdateCommentResponseLinksSelf = { href: string }; +type PullsUpdateCommentResponseLinksPullRequest = { href: string }; +type PullsUpdateCommentResponseLinksHtml = { href: string }; +type PullsUpdateCommentResponseLinks = { + html: PullsUpdateCommentResponseLinksHtml; + pull_request: PullsUpdateCommentResponseLinksPullRequest; + self: PullsUpdateCommentResponseLinksSelf; }; -type PullsListCommentsResponseItem = { - _links: PullsListCommentsResponseItemLinks; +type PullsUpdateCommentResponse = { + _links: PullsUpdateCommentResponseLinks; author_association: string; body: string; commit_id: string; @@ -11103,9 +7959,10 @@ type PullsListCommentsResponseItem = { start_side: string; updated_at: string; url: string; - user: PullsListCommentsResponseItemUser; + user: PullsUpdateCommentResponseUser; }; -type PullsListResponseItemUser = { +type PullsUpdateBranchResponse = { message: string; url: string }; +type PullsUpdateResponseUser = { avatar_url: string; events_url: string; followers_url: string; @@ -11125,7 +7982,7 @@ type PullsListResponseItemUser = { type: string; url: string; }; -type PullsListResponseItemRequestedTeamsItem = { +type PullsUpdateResponseRequestedTeamsItem = { description: string; html_url: string; id: number; @@ -11139,7 +7996,7 @@ type PullsListResponseItemRequestedTeamsItem = { slug: string; url: string; }; -type PullsListResponseItemRequestedReviewersItem = { +type PullsUpdateResponseRequestedReviewersItem = { avatar_url: string; events_url: string; followers_url: string; @@ -11159,7 +8016,7 @@ type PullsListResponseItemRequestedReviewersItem = { type: string; url: string; }; -type PullsListResponseItemMilestoneCreator = { +type PullsUpdateResponseMilestoneCreator = { avatar_url: string; events_url: string; followers_url: string; @@ -11179,11 +8036,11 @@ type PullsListResponseItemMilestoneCreator = { type: string; url: string; }; -type PullsListResponseItemMilestone = { +type PullsUpdateResponseMilestone = { closed_at: string; closed_issues: number; created_at: string; - creator: PullsListResponseItemMilestoneCreator; + creator: PullsUpdateResponseMilestoneCreator; description: string; due_on: string; html_url: string; @@ -11197,7 +8054,27 @@ type PullsListResponseItemMilestone = { updated_at: string; url: string; }; -type PullsListResponseItemLabelsItem = { +type PullsUpdateResponseMergedBy = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; +}; +type PullsUpdateResponseLabelsItem = { color: string; default: boolean; description: string; @@ -11206,7 +8083,7 @@ type PullsListResponseItemLabelsItem = { node_id: string; url: string; }; -type PullsListResponseItemHeadUser = { +type PullsUpdateResponseHeadUser = { avatar_url: string; events_url: string; followers_url: string; @@ -11226,12 +8103,12 @@ type PullsListResponseItemHeadUser = { type: string; url: string; }; -type PullsListResponseItemHeadRepoPermissions = { +type PullsUpdateResponseHeadRepoPermissions = { admin: boolean; pull: boolean; push: boolean; }; -type PullsListResponseItemHeadRepoOwner = { +type PullsUpdateResponseHeadRepoOwner = { avatar_url: string; events_url: string; followers_url: string; @@ -11251,7 +8128,7 @@ type PullsListResponseItemHeadRepoOwner = { type: string; url: string; }; -type PullsListResponseItemHeadRepo = { +type PullsUpdateResponseHeadRepo = { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; @@ -11307,8 +8184,8 @@ type PullsListResponseItemHeadRepo = { node_id: string; notifications_url: string; open_issues_count: number; - owner: PullsListResponseItemHeadRepoOwner; - permissions: PullsListResponseItemHeadRepoPermissions; + owner: PullsUpdateResponseHeadRepoOwner; + permissions: PullsUpdateResponseHeadRepoPermissions; private: boolean; pulls_url: string; pushed_at: string; @@ -11333,14 +8210,14 @@ type PullsListResponseItemHeadRepo = { visibility: string; watchers_count: number; }; -type PullsListResponseItemHead = { +type PullsUpdateResponseHead = { label: string; ref: string; - repo: PullsListResponseItemHeadRepo; + repo: PullsUpdateResponseHeadRepo; sha: string; - user: PullsListResponseItemHeadUser; + user: PullsUpdateResponseHeadUser; }; -type PullsListResponseItemBaseUser = { +type PullsUpdateResponseBaseUser = { avatar_url: string; events_url: string; followers_url: string; @@ -11360,12 +8237,12 @@ type PullsListResponseItemBaseUser = { type: string; url: string; }; -type PullsListResponseItemBaseRepoPermissions = { +type PullsUpdateResponseBaseRepoPermissions = { admin: boolean; pull: boolean; push: boolean; }; -type PullsListResponseItemBaseRepoOwner = { +type PullsUpdateResponseBaseRepoOwner = { avatar_url: string; events_url: string; followers_url: string; @@ -11385,7 +8262,7 @@ type PullsListResponseItemBaseRepoOwner = { type: string; url: string; }; -type PullsListResponseItemBaseRepo = { +type PullsUpdateResponseBaseRepo = { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; @@ -11441,8 +8318,8 @@ type PullsListResponseItemBaseRepo = { node_id: string; notifications_url: string; open_issues_count: number; - owner: PullsListResponseItemBaseRepoOwner; - permissions: PullsListResponseItemBaseRepoPermissions; + owner: PullsUpdateResponseBaseRepoOwner; + permissions: PullsUpdateResponseBaseRepoPermissions; private: boolean; pulls_url: string; pushed_at: string; @@ -11467,14 +8344,14 @@ type PullsListResponseItemBaseRepo = { visibility: string; watchers_count: number; }; -type PullsListResponseItemBase = { +type PullsUpdateResponseBase = { label: string; ref: string; - repo: PullsListResponseItemBaseRepo; + repo: PullsUpdateResponseBaseRepo; sha: string; - user: PullsListResponseItemBaseUser; + user: PullsUpdateResponseBaseUser; }; -type PullsListResponseItemAssigneesItem = { +type PullsUpdateResponseAssigneesItem = { avatar_url: string; events_url: string; followers_url: string; @@ -11494,7 +8371,7 @@ type PullsListResponseItemAssigneesItem = { type: string; url: string; }; -type PullsListResponseItemAssignee = { +type PullsUpdateResponseAssignee = { avatar_url: string; events_url: string; followers_url: string; @@ -11514,62 +8391,74 @@ type PullsListResponseItemAssignee = { type: string; url: string; }; -type PullsListResponseItemLinksStatuses = { href: string }; -type PullsListResponseItemLinksSelf = { href: string }; -type PullsListResponseItemLinksReviewComments = { href: string }; -type PullsListResponseItemLinksReviewComment = { href: string }; -type PullsListResponseItemLinksIssue = { href: string }; -type PullsListResponseItemLinksHtml = { href: string }; -type PullsListResponseItemLinksCommits = { href: string }; -type PullsListResponseItemLinksComments = { href: string }; -type PullsListResponseItemLinks = { - comments: PullsListResponseItemLinksComments; - commits: PullsListResponseItemLinksCommits; - html: PullsListResponseItemLinksHtml; - issue: PullsListResponseItemLinksIssue; - review_comment: PullsListResponseItemLinksReviewComment; - review_comments: PullsListResponseItemLinksReviewComments; - self: PullsListResponseItemLinksSelf; - statuses: PullsListResponseItemLinksStatuses; +type PullsUpdateResponseLinksStatuses = { href: string }; +type PullsUpdateResponseLinksSelf = { href: string }; +type PullsUpdateResponseLinksReviewComments = { href: string }; +type PullsUpdateResponseLinksReviewComment = { href: string }; +type PullsUpdateResponseLinksIssue = { href: string }; +type PullsUpdateResponseLinksHtml = { href: string }; +type PullsUpdateResponseLinksCommits = { href: string }; +type PullsUpdateResponseLinksComments = { href: string }; +type PullsUpdateResponseLinks = { + comments: PullsUpdateResponseLinksComments; + commits: PullsUpdateResponseLinksCommits; + html: PullsUpdateResponseLinksHtml; + issue: PullsUpdateResponseLinksIssue; + review_comment: PullsUpdateResponseLinksReviewComment; + review_comments: PullsUpdateResponseLinksReviewComments; + self: PullsUpdateResponseLinksSelf; + statuses: PullsUpdateResponseLinksStatuses; }; -type PullsListResponseItem = { - _links: PullsListResponseItemLinks; +type PullsUpdateResponse = { + _links: PullsUpdateResponseLinks; active_lock_reason: string; - assignee: PullsListResponseItemAssignee; - assignees: Array; + additions: number; + assignee: PullsUpdateResponseAssignee; + assignees: Array; author_association: string; - base: PullsListResponseItemBase; + base: PullsUpdateResponseBase; body: string; + changed_files: number; closed_at: string; + comments: number; comments_url: string; + commits: number; commits_url: string; created_at: string; + deletions: number; diff_url: string; draft: boolean; - head: PullsListResponseItemHead; + head: PullsUpdateResponseHead; html_url: string; id: number; issue_url: string; - labels: Array; + labels: Array; locked: boolean; + maintainer_can_modify: boolean; merge_commit_sha: string; + mergeable: boolean; + mergeable_state: string; + merged: boolean; merged_at: string; - milestone: PullsListResponseItemMilestone; + merged_by: PullsUpdateResponseMergedBy; + milestone: PullsUpdateResponseMilestone; node_id: string; number: number; patch_url: string; - requested_reviewers: Array; - requested_teams: Array; + rebaseable: boolean; + requested_reviewers: Array; + requested_teams: Array; review_comment_url: string; + review_comments: number; review_comments_url: string; state: string; statuses_url: string; title: string; updated_at: string; url: string; - user: PullsListResponseItemUser; + user: PullsUpdateResponseUser; }; -type PullsGetReviewResponseUser = { +type PullsSubmitReviewResponseUser = { avatar_url: string; events_url: string; followers_url: string; @@ -11589,14 +8478,14 @@ type PullsGetReviewResponseUser = { type: string; url: string; }; -type PullsGetReviewResponseLinksPullRequest = { href: string }; -type PullsGetReviewResponseLinksHtml = { href: string }; -type PullsGetReviewResponseLinks = { - html: PullsGetReviewResponseLinksHtml; - pull_request: PullsGetReviewResponseLinksPullRequest; +type PullsSubmitReviewResponseLinksPullRequest = { href: string }; +type PullsSubmitReviewResponseLinksHtml = { href: string }; +type PullsSubmitReviewResponseLinks = { + html: PullsSubmitReviewResponseLinksHtml; + pull_request: PullsSubmitReviewResponseLinksPullRequest; }; -type PullsGetReviewResponse = { - _links: PullsGetReviewResponseLinks; +type PullsSubmitReviewResponse = { + _links: PullsSubmitReviewResponseLinks; body: string; commit_id: string; html_url: string; @@ -11605,9 +8494,10 @@ type PullsGetReviewResponse = { pull_request_url: string; state: string; submitted_at: string; - user: PullsGetReviewResponseUser; + user: PullsSubmitReviewResponseUser; }; -type PullsGetCommentsForReviewResponseItemUser = { +type PullsMergeResponse = { merged: boolean; message: string; sha: string }; +type PullsListReviewsResponseItemUser = { avatar_url: string; events_url: string; followers_url: string; @@ -11627,16 +8517,182 @@ type PullsGetCommentsForReviewResponseItemUser = { type: string; url: string; }; -type PullsGetCommentsForReviewResponseItemLinksSelf = { href: string }; -type PullsGetCommentsForReviewResponseItemLinksPullRequest = { href: string }; -type PullsGetCommentsForReviewResponseItemLinksHtml = { href: string }; -type PullsGetCommentsForReviewResponseItemLinks = { - html: PullsGetCommentsForReviewResponseItemLinksHtml; - pull_request: PullsGetCommentsForReviewResponseItemLinksPullRequest; - self: PullsGetCommentsForReviewResponseItemLinksSelf; +type PullsListReviewsResponseItemLinksPullRequest = { href: string }; +type PullsListReviewsResponseItemLinksHtml = { href: string }; +type PullsListReviewsResponseItemLinks = { + html: PullsListReviewsResponseItemLinksHtml; + pull_request: PullsListReviewsResponseItemLinksPullRequest; }; -type PullsGetCommentsForReviewResponseItem = { - _links: PullsGetCommentsForReviewResponseItemLinks; +type PullsListReviewsResponseItem = { + _links: PullsListReviewsResponseItemLinks; + body: string; + commit_id: string; + html_url: string; + id: number; + node_id: string; + pull_request_url: string; + state: string; + submitted_at: string; + user: PullsListReviewsResponseItemUser; +}; +type PullsListReviewRequestsResponseUsersItem = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; +}; +type PullsListReviewRequestsResponseTeamsItem = { + description: string; + html_url: string; + id: number; + members_url: string; + name: string; + node_id: string; + parent: null; + permission: string; + privacy: string; + repositories_url: string; + slug: string; + url: string; +}; +type PullsListReviewRequestsResponse = { + teams: Array; + users: Array; +}; +type PullsListFilesResponseItem = { + additions: number; + blob_url: string; + changes: number; + contents_url: string; + deletions: number; + filename: string; + patch: string; + raw_url: string; + sha: string; + status: string; +}; +type PullsListCommitsResponseItemParentsItem = { sha: string; url: string }; +type PullsListCommitsResponseItemCommitter = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; +}; +type PullsListCommitsResponseItemCommitVerification = { + payload: null; + reason: string; + signature: null; + verified: boolean; +}; +type PullsListCommitsResponseItemCommitTree = { sha: string; url: string }; +type PullsListCommitsResponseItemCommitCommitter = { + date: string; + email: string; + name: string; +}; +type PullsListCommitsResponseItemCommitAuthor = { + date: string; + email: string; + name: string; +}; +type PullsListCommitsResponseItemCommit = { + author: PullsListCommitsResponseItemCommitAuthor; + comment_count: number; + committer: PullsListCommitsResponseItemCommitCommitter; + message: string; + tree: PullsListCommitsResponseItemCommitTree; + url: string; + verification: PullsListCommitsResponseItemCommitVerification; +}; +type PullsListCommitsResponseItemAuthor = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; +}; +type PullsListCommitsResponseItem = { + author: PullsListCommitsResponseItemAuthor; + comments_url: string; + commit: PullsListCommitsResponseItemCommit; + committer: PullsListCommitsResponseItemCommitter; + html_url: string; + node_id: string; + parents: Array; + sha: string; + url: string; +}; +type PullsListCommentsForRepoResponseItemUser = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; +}; +type PullsListCommentsForRepoResponseItemLinksSelf = { href: string }; +type PullsListCommentsForRepoResponseItemLinksPullRequest = { href: string }; +type PullsListCommentsForRepoResponseItemLinksHtml = { href: string }; +type PullsListCommentsForRepoResponseItemLinks = { + html: PullsListCommentsForRepoResponseItemLinksHtml; + pull_request: PullsListCommentsForRepoResponseItemLinksPullRequest; + self: PullsListCommentsForRepoResponseItemLinksSelf; +}; +type PullsListCommentsForRepoResponseItem = { + _links: PullsListCommentsForRepoResponseItemLinks; author_association: string; body: string; commit_id: string; @@ -11645,18 +8701,24 @@ type PullsGetCommentsForReviewResponseItem = { html_url: string; id: number; in_reply_to_id: number; + line: number; node_id: string; original_commit_id: string; + original_line: number; original_position: number; + original_start_line: number; path: string; position: number; pull_request_review_id: number; pull_request_url: string; + side: string; + start_line: number; + start_side: string; updated_at: string; url: string; - user: PullsGetCommentsForReviewResponseItemUser; + user: PullsListCommentsForRepoResponseItemUser; }; -type PullsGetCommentResponseUser = { +type PullsListCommentsResponseItemUser = { avatar_url: string; events_url: string; followers_url: string; @@ -11676,16 +8738,16 @@ type PullsGetCommentResponseUser = { type: string; url: string; }; -type PullsGetCommentResponseLinksSelf = { href: string }; -type PullsGetCommentResponseLinksPullRequest = { href: string }; -type PullsGetCommentResponseLinksHtml = { href: string }; -type PullsGetCommentResponseLinks = { - html: PullsGetCommentResponseLinksHtml; - pull_request: PullsGetCommentResponseLinksPullRequest; - self: PullsGetCommentResponseLinksSelf; +type PullsListCommentsResponseItemLinksSelf = { href: string }; +type PullsListCommentsResponseItemLinksPullRequest = { href: string }; +type PullsListCommentsResponseItemLinksHtml = { href: string }; +type PullsListCommentsResponseItemLinks = { + html: PullsListCommentsResponseItemLinksHtml; + pull_request: PullsListCommentsResponseItemLinksPullRequest; + self: PullsListCommentsResponseItemLinksSelf; }; -type PullsGetCommentResponse = { - _links: PullsGetCommentResponseLinks; +type PullsListCommentsResponseItem = { + _links: PullsListCommentsResponseItemLinks; author_association: string; body: string; commit_id: string; @@ -11709,9 +8771,9 @@ type PullsGetCommentResponse = { start_side: string; updated_at: string; url: string; - user: PullsGetCommentResponseUser; + user: PullsListCommentsResponseItemUser; }; -type PullsGetResponseUser = { +type PullsListResponseItemUser = { avatar_url: string; events_url: string; followers_url: string; @@ -11731,7 +8793,7 @@ type PullsGetResponseUser = { type: string; url: string; }; -type PullsGetResponseRequestedTeamsItem = { +type PullsListResponseItemRequestedTeamsItem = { description: string; html_url: string; id: number; @@ -11745,7 +8807,7 @@ type PullsGetResponseRequestedTeamsItem = { slug: string; url: string; }; -type PullsGetResponseRequestedReviewersItem = { +type PullsListResponseItemRequestedReviewersItem = { avatar_url: string; events_url: string; followers_url: string; @@ -11765,7 +8827,7 @@ type PullsGetResponseRequestedReviewersItem = { type: string; url: string; }; -type PullsGetResponseMilestoneCreator = { +type PullsListResponseItemMilestoneCreator = { avatar_url: string; events_url: string; followers_url: string; @@ -11785,11 +8847,11 @@ type PullsGetResponseMilestoneCreator = { type: string; url: string; }; -type PullsGetResponseMilestone = { +type PullsListResponseItemMilestone = { closed_at: string; closed_issues: number; created_at: string; - creator: PullsGetResponseMilestoneCreator; + creator: PullsListResponseItemMilestoneCreator; description: string; due_on: string; html_url: string; @@ -11803,27 +8865,7 @@ type PullsGetResponseMilestone = { updated_at: string; url: string; }; -type PullsGetResponseMergedBy = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type PullsGetResponseLabelsItem = { +type PullsListResponseItemLabelsItem = { color: string; default: boolean; description: string; @@ -11832,7 +8874,7 @@ type PullsGetResponseLabelsItem = { node_id: string; url: string; }; -type PullsGetResponseHeadUser = { +type PullsListResponseItemHeadUser = { avatar_url: string; events_url: string; followers_url: string; @@ -11852,12 +8894,12 @@ type PullsGetResponseHeadUser = { type: string; url: string; }; -type PullsGetResponseHeadRepoPermissions = { +type PullsListResponseItemHeadRepoPermissions = { admin: boolean; pull: boolean; push: boolean; }; -type PullsGetResponseHeadRepoOwner = { +type PullsListResponseItemHeadRepoOwner = { avatar_url: string; events_url: string; followers_url: string; @@ -11877,7 +8919,7 @@ type PullsGetResponseHeadRepoOwner = { type: string; url: string; }; -type PullsGetResponseHeadRepo = { +type PullsListResponseItemHeadRepo = { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; @@ -11933,8 +8975,8 @@ type PullsGetResponseHeadRepo = { node_id: string; notifications_url: string; open_issues_count: number; - owner: PullsGetResponseHeadRepoOwner; - permissions: PullsGetResponseHeadRepoPermissions; + owner: PullsListResponseItemHeadRepoOwner; + permissions: PullsListResponseItemHeadRepoPermissions; private: boolean; pulls_url: string; pushed_at: string; @@ -11959,14 +9001,14 @@ type PullsGetResponseHeadRepo = { visibility: string; watchers_count: number; }; -type PullsGetResponseHead = { +type PullsListResponseItemHead = { label: string; ref: string; - repo: PullsGetResponseHeadRepo; + repo: PullsListResponseItemHeadRepo; sha: string; - user: PullsGetResponseHeadUser; + user: PullsListResponseItemHeadUser; }; -type PullsGetResponseBaseUser = { +type PullsListResponseItemBaseUser = { avatar_url: string; events_url: string; followers_url: string; @@ -11986,12 +9028,12 @@ type PullsGetResponseBaseUser = { type: string; url: string; }; -type PullsGetResponseBaseRepoPermissions = { +type PullsListResponseItemBaseRepoPermissions = { admin: boolean; pull: boolean; push: boolean; }; -type PullsGetResponseBaseRepoOwner = { +type PullsListResponseItemBaseRepoOwner = { avatar_url: string; events_url: string; followers_url: string; @@ -12011,7 +9053,7 @@ type PullsGetResponseBaseRepoOwner = { type: string; url: string; }; -type PullsGetResponseBaseRepo = { +type PullsListResponseItemBaseRepo = { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; @@ -12067,8 +9109,8 @@ type PullsGetResponseBaseRepo = { node_id: string; notifications_url: string; open_issues_count: number; - owner: PullsGetResponseBaseRepoOwner; - permissions: PullsGetResponseBaseRepoPermissions; + owner: PullsListResponseItemBaseRepoOwner; + permissions: PullsListResponseItemBaseRepoPermissions; private: boolean; pulls_url: string; pushed_at: string; @@ -12093,14 +9135,14 @@ type PullsGetResponseBaseRepo = { visibility: string; watchers_count: number; }; -type PullsGetResponseBase = { +type PullsListResponseItemBase = { label: string; ref: string; - repo: PullsGetResponseBaseRepo; + repo: PullsListResponseItemBaseRepo; sha: string; - user: PullsGetResponseBaseUser; + user: PullsListResponseItemBaseUser; }; -type PullsGetResponseAssigneesItem = { +type PullsListResponseItemAssigneesItem = { avatar_url: string; events_url: string; followers_url: string; @@ -12120,7 +9162,7 @@ type PullsGetResponseAssigneesItem = { type: string; url: string; }; -type PullsGetResponseAssignee = { +type PullsListResponseItemAssignee = { avatar_url: string; events_url: string; followers_url: string; @@ -12140,74 +9182,62 @@ type PullsGetResponseAssignee = { type: string; url: string; }; -type PullsGetResponseLinksStatuses = { href: string }; -type PullsGetResponseLinksSelf = { href: string }; -type PullsGetResponseLinksReviewComments = { href: string }; -type PullsGetResponseLinksReviewComment = { href: string }; -type PullsGetResponseLinksIssue = { href: string }; -type PullsGetResponseLinksHtml = { href: string }; -type PullsGetResponseLinksCommits = { href: string }; -type PullsGetResponseLinksComments = { href: string }; -type PullsGetResponseLinks = { - comments: PullsGetResponseLinksComments; - commits: PullsGetResponseLinksCommits; - html: PullsGetResponseLinksHtml; - issue: PullsGetResponseLinksIssue; - review_comment: PullsGetResponseLinksReviewComment; - review_comments: PullsGetResponseLinksReviewComments; - self: PullsGetResponseLinksSelf; - statuses: PullsGetResponseLinksStatuses; +type PullsListResponseItemLinksStatuses = { href: string }; +type PullsListResponseItemLinksSelf = { href: string }; +type PullsListResponseItemLinksReviewComments = { href: string }; +type PullsListResponseItemLinksReviewComment = { href: string }; +type PullsListResponseItemLinksIssue = { href: string }; +type PullsListResponseItemLinksHtml = { href: string }; +type PullsListResponseItemLinksCommits = { href: string }; +type PullsListResponseItemLinksComments = { href: string }; +type PullsListResponseItemLinks = { + comments: PullsListResponseItemLinksComments; + commits: PullsListResponseItemLinksCommits; + html: PullsListResponseItemLinksHtml; + issue: PullsListResponseItemLinksIssue; + review_comment: PullsListResponseItemLinksReviewComment; + review_comments: PullsListResponseItemLinksReviewComments; + self: PullsListResponseItemLinksSelf; + statuses: PullsListResponseItemLinksStatuses; }; -type PullsGetResponse = { - _links: PullsGetResponseLinks; +type PullsListResponseItem = { + _links: PullsListResponseItemLinks; active_lock_reason: string; - additions: number; - assignee: PullsGetResponseAssignee; - assignees: Array; + assignee: PullsListResponseItemAssignee; + assignees: Array; author_association: string; - base: PullsGetResponseBase; + base: PullsListResponseItemBase; body: string; - changed_files: number; closed_at: string; - comments: number; comments_url: string; - commits: number; commits_url: string; created_at: string; - deletions: number; diff_url: string; draft: boolean; - head: PullsGetResponseHead; + head: PullsListResponseItemHead; html_url: string; id: number; issue_url: string; - labels: Array; + labels: Array; locked: boolean; - maintainer_can_modify: boolean; merge_commit_sha: string; - mergeable: boolean; - mergeable_state: string; - merged: boolean; merged_at: string; - merged_by: PullsGetResponseMergedBy; - milestone: PullsGetResponseMilestone; + milestone: PullsListResponseItemMilestone; node_id: string; number: number; patch_url: string; - rebaseable: boolean; - requested_reviewers: Array; - requested_teams: Array; + requested_reviewers: Array; + requested_teams: Array; review_comment_url: string; - review_comments: number; review_comments_url: string; state: string; statuses_url: string; title: string; updated_at: string; url: string; - user: PullsGetResponseUser; + user: PullsListResponseItemUser; }; -type PullsDismissReviewResponseUser = { +type PullsGetReviewResponseUser = { avatar_url: string; events_url: string; followers_url: string; @@ -12227,14 +9257,14 @@ type PullsDismissReviewResponseUser = { type: string; url: string; }; -type PullsDismissReviewResponseLinksPullRequest = { href: string }; -type PullsDismissReviewResponseLinksHtml = { href: string }; -type PullsDismissReviewResponseLinks = { - html: PullsDismissReviewResponseLinksHtml; - pull_request: PullsDismissReviewResponseLinksPullRequest; +type PullsGetReviewResponseLinksPullRequest = { href: string }; +type PullsGetReviewResponseLinksHtml = { href: string }; +type PullsGetReviewResponseLinks = { + html: PullsGetReviewResponseLinksHtml; + pull_request: PullsGetReviewResponseLinksPullRequest; }; -type PullsDismissReviewResponse = { - _links: PullsDismissReviewResponseLinks; +type PullsGetReviewResponse = { + _links: PullsGetReviewResponseLinks; body: string; commit_id: string; html_url: string; @@ -12242,9 +9272,10 @@ type PullsDismissReviewResponse = { node_id: string; pull_request_url: string; state: string; - user: PullsDismissReviewResponseUser; + submitted_at: string; + user: PullsGetReviewResponseUser; }; -type PullsDeletePendingReviewResponseUser = { +type PullsGetCommentsForReviewResponseItemUser = { avatar_url: string; events_url: string; followers_url: string; @@ -12264,24 +9295,36 @@ type PullsDeletePendingReviewResponseUser = { type: string; url: string; }; -type PullsDeletePendingReviewResponseLinksPullRequest = { href: string }; -type PullsDeletePendingReviewResponseLinksHtml = { href: string }; -type PullsDeletePendingReviewResponseLinks = { - html: PullsDeletePendingReviewResponseLinksHtml; - pull_request: PullsDeletePendingReviewResponseLinksPullRequest; +type PullsGetCommentsForReviewResponseItemLinksSelf = { href: string }; +type PullsGetCommentsForReviewResponseItemLinksPullRequest = { href: string }; +type PullsGetCommentsForReviewResponseItemLinksHtml = { href: string }; +type PullsGetCommentsForReviewResponseItemLinks = { + html: PullsGetCommentsForReviewResponseItemLinksHtml; + pull_request: PullsGetCommentsForReviewResponseItemLinksPullRequest; + self: PullsGetCommentsForReviewResponseItemLinksSelf; }; -type PullsDeletePendingReviewResponse = { - _links: PullsDeletePendingReviewResponseLinks; +type PullsGetCommentsForReviewResponseItem = { + _links: PullsGetCommentsForReviewResponseItemLinks; + author_association: string; body: string; commit_id: string; + created_at: string; + diff_hunk: string; html_url: string; id: number; + in_reply_to_id: number; node_id: string; + original_commit_id: string; + original_position: number; + path: string; + position: number; + pull_request_review_id: number; pull_request_url: string; - state: string; - user: PullsDeletePendingReviewResponseUser; + updated_at: string; + url: string; + user: PullsGetCommentsForReviewResponseItemUser; }; -type PullsCreateReviewRequestResponseUser = { +type PullsGetCommentResponseUser = { avatar_url: string; events_url: string; followers_url: string; @@ -12301,7 +9344,62 @@ type PullsCreateReviewRequestResponseUser = { type: string; url: string; }; -type PullsCreateReviewRequestResponseRequestedTeamsItem = { +type PullsGetCommentResponseLinksSelf = { href: string }; +type PullsGetCommentResponseLinksPullRequest = { href: string }; +type PullsGetCommentResponseLinksHtml = { href: string }; +type PullsGetCommentResponseLinks = { + html: PullsGetCommentResponseLinksHtml; + pull_request: PullsGetCommentResponseLinksPullRequest; + self: PullsGetCommentResponseLinksSelf; +}; +type PullsGetCommentResponse = { + _links: PullsGetCommentResponseLinks; + author_association: string; + body: string; + commit_id: string; + created_at: string; + diff_hunk: string; + html_url: string; + id: number; + in_reply_to_id: number; + line: number; + node_id: string; + original_commit_id: string; + original_line: number; + original_position: number; + original_start_line: number; + path: string; + position: number; + pull_request_review_id: number; + pull_request_url: string; + side: string; + start_line: number; + start_side: string; + updated_at: string; + url: string; + user: PullsGetCommentResponseUser; +}; +type PullsGetResponseUser = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; +}; +type PullsGetResponseRequestedTeamsItem = { description: string; html_url: string; id: number; @@ -12315,7 +9413,7 @@ type PullsCreateReviewRequestResponseRequestedTeamsItem = { slug: string; url: string; }; -type PullsCreateReviewRequestResponseRequestedReviewersItem = { +type PullsGetResponseRequestedReviewersItem = { avatar_url: string; events_url: string; followers_url: string; @@ -12335,7 +9433,7 @@ type PullsCreateReviewRequestResponseRequestedReviewersItem = { type: string; url: string; }; -type PullsCreateReviewRequestResponseMilestoneCreator = { +type PullsGetResponseMilestoneCreator = { avatar_url: string; events_url: string; followers_url: string; @@ -12355,11 +9453,11 @@ type PullsCreateReviewRequestResponseMilestoneCreator = { type: string; url: string; }; -type PullsCreateReviewRequestResponseMilestone = { +type PullsGetResponseMilestone = { closed_at: string; closed_issues: number; created_at: string; - creator: PullsCreateReviewRequestResponseMilestoneCreator; + creator: PullsGetResponseMilestoneCreator; description: string; due_on: string; html_url: string; @@ -12373,7 +9471,27 @@ type PullsCreateReviewRequestResponseMilestone = { updated_at: string; url: string; }; -type PullsCreateReviewRequestResponseLabelsItem = { +type PullsGetResponseMergedBy = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; +}; +type PullsGetResponseLabelsItem = { color: string; default: boolean; description: string; @@ -12382,7 +9500,7 @@ type PullsCreateReviewRequestResponseLabelsItem = { node_id: string; url: string; }; -type PullsCreateReviewRequestResponseHeadUser = { +type PullsGetResponseHeadUser = { avatar_url: string; events_url: string; followers_url: string; @@ -12402,12 +9520,12 @@ type PullsCreateReviewRequestResponseHeadUser = { type: string; url: string; }; -type PullsCreateReviewRequestResponseHeadRepoPermissions = { +type PullsGetResponseHeadRepoPermissions = { admin: boolean; pull: boolean; push: boolean; }; -type PullsCreateReviewRequestResponseHeadRepoOwner = { +type PullsGetResponseHeadRepoOwner = { avatar_url: string; events_url: string; followers_url: string; @@ -12427,7 +9545,7 @@ type PullsCreateReviewRequestResponseHeadRepoOwner = { type: string; url: string; }; -type PullsCreateReviewRequestResponseHeadRepo = { +type PullsGetResponseHeadRepo = { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; @@ -12483,8 +9601,8 @@ type PullsCreateReviewRequestResponseHeadRepo = { node_id: string; notifications_url: string; open_issues_count: number; - owner: PullsCreateReviewRequestResponseHeadRepoOwner; - permissions: PullsCreateReviewRequestResponseHeadRepoPermissions; + owner: PullsGetResponseHeadRepoOwner; + permissions: PullsGetResponseHeadRepoPermissions; private: boolean; pulls_url: string; pushed_at: string; @@ -12509,14 +9627,14 @@ type PullsCreateReviewRequestResponseHeadRepo = { visibility: string; watchers_count: number; }; -type PullsCreateReviewRequestResponseHead = { +type PullsGetResponseHead = { label: string; ref: string; - repo: PullsCreateReviewRequestResponseHeadRepo; + repo: PullsGetResponseHeadRepo; sha: string; - user: PullsCreateReviewRequestResponseHeadUser; + user: PullsGetResponseHeadUser; }; -type PullsCreateReviewRequestResponseBaseUser = { +type PullsGetResponseBaseUser = { avatar_url: string; events_url: string; followers_url: string; @@ -12536,12 +9654,12 @@ type PullsCreateReviewRequestResponseBaseUser = { type: string; url: string; }; -type PullsCreateReviewRequestResponseBaseRepoPermissions = { +type PullsGetResponseBaseRepoPermissions = { admin: boolean; pull: boolean; push: boolean; }; -type PullsCreateReviewRequestResponseBaseRepoOwner = { +type PullsGetResponseBaseRepoOwner = { avatar_url: string; events_url: string; followers_url: string; @@ -12561,7 +9679,7 @@ type PullsCreateReviewRequestResponseBaseRepoOwner = { type: string; url: string; }; -type PullsCreateReviewRequestResponseBaseRepo = { +type PullsGetResponseBaseRepo = { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; @@ -12617,8 +9735,8 @@ type PullsCreateReviewRequestResponseBaseRepo = { node_id: string; notifications_url: string; open_issues_count: number; - owner: PullsCreateReviewRequestResponseBaseRepoOwner; - permissions: PullsCreateReviewRequestResponseBaseRepoPermissions; + owner: PullsGetResponseBaseRepoOwner; + permissions: PullsGetResponseBaseRepoPermissions; private: boolean; pulls_url: string; pushed_at: string; @@ -12643,14 +9761,14 @@ type PullsCreateReviewRequestResponseBaseRepo = { visibility: string; watchers_count: number; }; -type PullsCreateReviewRequestResponseBase = { +type PullsGetResponseBase = { label: string; ref: string; - repo: PullsCreateReviewRequestResponseBaseRepo; + repo: PullsGetResponseBaseRepo; sha: string; - user: PullsCreateReviewRequestResponseBaseUser; + user: PullsGetResponseBaseUser; }; -type PullsCreateReviewRequestResponseAssigneesItem = { +type PullsGetResponseAssigneesItem = { avatar_url: string; events_url: string; followers_url: string; @@ -12670,7 +9788,7 @@ type PullsCreateReviewRequestResponseAssigneesItem = { type: string; url: string; }; -type PullsCreateReviewRequestResponseAssignee = { +type PullsGetResponseAssignee = { avatar_url: string; events_url: string; followers_url: string; @@ -12690,64 +9808,74 @@ type PullsCreateReviewRequestResponseAssignee = { type: string; url: string; }; -type PullsCreateReviewRequestResponseLinksStatuses = { href: string }; -type PullsCreateReviewRequestResponseLinksSelf = { href: string }; -type PullsCreateReviewRequestResponseLinksReviewComments = { href: string }; -type PullsCreateReviewRequestResponseLinksReviewComment = { href: string }; -type PullsCreateReviewRequestResponseLinksIssue = { href: string }; -type PullsCreateReviewRequestResponseLinksHtml = { href: string }; -type PullsCreateReviewRequestResponseLinksCommits = { href: string }; -type PullsCreateReviewRequestResponseLinksComments = { href: string }; -type PullsCreateReviewRequestResponseLinks = { - comments: PullsCreateReviewRequestResponseLinksComments; - commits: PullsCreateReviewRequestResponseLinksCommits; - html: PullsCreateReviewRequestResponseLinksHtml; - issue: PullsCreateReviewRequestResponseLinksIssue; - review_comment: PullsCreateReviewRequestResponseLinksReviewComment; - review_comments: PullsCreateReviewRequestResponseLinksReviewComments; - self: PullsCreateReviewRequestResponseLinksSelf; - statuses: PullsCreateReviewRequestResponseLinksStatuses; +type PullsGetResponseLinksStatuses = { href: string }; +type PullsGetResponseLinksSelf = { href: string }; +type PullsGetResponseLinksReviewComments = { href: string }; +type PullsGetResponseLinksReviewComment = { href: string }; +type PullsGetResponseLinksIssue = { href: string }; +type PullsGetResponseLinksHtml = { href: string }; +type PullsGetResponseLinksCommits = { href: string }; +type PullsGetResponseLinksComments = { href: string }; +type PullsGetResponseLinks = { + comments: PullsGetResponseLinksComments; + commits: PullsGetResponseLinksCommits; + html: PullsGetResponseLinksHtml; + issue: PullsGetResponseLinksIssue; + review_comment: PullsGetResponseLinksReviewComment; + review_comments: PullsGetResponseLinksReviewComments; + self: PullsGetResponseLinksSelf; + statuses: PullsGetResponseLinksStatuses; }; -type PullsCreateReviewRequestResponse = { - _links: PullsCreateReviewRequestResponseLinks; +type PullsGetResponse = { + _links: PullsGetResponseLinks; active_lock_reason: string; - assignee: PullsCreateReviewRequestResponseAssignee; - assignees: Array; + additions: number; + assignee: PullsGetResponseAssignee; + assignees: Array; author_association: string; - base: PullsCreateReviewRequestResponseBase; + base: PullsGetResponseBase; body: string; + changed_files: number; closed_at: string; + comments: number; comments_url: string; + commits: number; commits_url: string; created_at: string; + deletions: number; diff_url: string; draft: boolean; - head: PullsCreateReviewRequestResponseHead; + head: PullsGetResponseHead; html_url: string; id: number; issue_url: string; - labels: Array; + labels: Array; locked: boolean; + maintainer_can_modify: boolean; merge_commit_sha: string; + mergeable: boolean; + mergeable_state: string; + merged: boolean; merged_at: string; - milestone: PullsCreateReviewRequestResponseMilestone; + merged_by: PullsGetResponseMergedBy; + milestone: PullsGetResponseMilestone; node_id: string; number: number; patch_url: string; - requested_reviewers: Array< - PullsCreateReviewRequestResponseRequestedReviewersItem - >; - requested_teams: Array; + rebaseable: boolean; + requested_reviewers: Array; + requested_teams: Array; review_comment_url: string; + review_comments: number; review_comments_url: string; state: string; statuses_url: string; title: string; updated_at: string; url: string; - user: PullsCreateReviewRequestResponseUser; + user: PullsGetResponseUser; }; -type PullsCreateReviewCommentReplyResponseUser = { +type PullsDismissReviewResponseUser = { avatar_url: string; events_url: string; followers_url: string; @@ -12767,35 +9895,24 @@ type PullsCreateReviewCommentReplyResponseUser = { type: string; url: string; }; -type PullsCreateReviewCommentReplyResponseLinksSelf = { href: string }; -type PullsCreateReviewCommentReplyResponseLinksPullRequest = { href: string }; -type PullsCreateReviewCommentReplyResponseLinksHtml = { href: string }; -type PullsCreateReviewCommentReplyResponseLinks = { - html: PullsCreateReviewCommentReplyResponseLinksHtml; - pull_request: PullsCreateReviewCommentReplyResponseLinksPullRequest; - self: PullsCreateReviewCommentReplyResponseLinksSelf; +type PullsDismissReviewResponseLinksPullRequest = { href: string }; +type PullsDismissReviewResponseLinksHtml = { href: string }; +type PullsDismissReviewResponseLinks = { + html: PullsDismissReviewResponseLinksHtml; + pull_request: PullsDismissReviewResponseLinksPullRequest; }; -type PullsCreateReviewCommentReplyResponse = { - _links: PullsCreateReviewCommentReplyResponseLinks; - author_association: string; +type PullsDismissReviewResponse = { + _links: PullsDismissReviewResponseLinks; body: string; commit_id: string; - created_at: string; - diff_hunk: string; html_url: string; id: number; node_id: string; - original_commit_id: string; - original_position: number; - path: string; - position: number; - pull_request_review_id: number; pull_request_url: string; - updated_at: string; - url: string; - user: PullsCreateReviewCommentReplyResponseUser; + state: string; + user: PullsDismissReviewResponseUser; }; -type PullsCreateReviewResponseUser = { +type PullsDeletePendingReviewResponseUser = { avatar_url: string; events_url: string; followers_url: string; @@ -12815,14 +9932,14 @@ type PullsCreateReviewResponseUser = { type: string; url: string; }; -type PullsCreateReviewResponseLinksPullRequest = { href: string }; -type PullsCreateReviewResponseLinksHtml = { href: string }; -type PullsCreateReviewResponseLinks = { - html: PullsCreateReviewResponseLinksHtml; - pull_request: PullsCreateReviewResponseLinksPullRequest; +type PullsDeletePendingReviewResponseLinksPullRequest = { href: string }; +type PullsDeletePendingReviewResponseLinksHtml = { href: string }; +type PullsDeletePendingReviewResponseLinks = { + html: PullsDeletePendingReviewResponseLinksHtml; + pull_request: PullsDeletePendingReviewResponseLinksPullRequest; }; -type PullsCreateReviewResponse = { - _links: PullsCreateReviewResponseLinks; +type PullsDeletePendingReviewResponse = { + _links: PullsDeletePendingReviewResponseLinks; body: string; commit_id: string; html_url: string; @@ -12830,9 +9947,9 @@ type PullsCreateReviewResponse = { node_id: string; pull_request_url: string; state: string; - user: PullsCreateReviewResponseUser; + user: PullsDeletePendingReviewResponseUser; }; -type PullsCreateFromIssueResponseUser = { +type PullsCreateReviewRequestResponseUser = { avatar_url: string; events_url: string; followers_url: string; @@ -12852,7 +9969,7 @@ type PullsCreateFromIssueResponseUser = { type: string; url: string; }; -type PullsCreateFromIssueResponseRequestedTeamsItem = { +type PullsCreateReviewRequestResponseRequestedTeamsItem = { description: string; html_url: string; id: number; @@ -12866,7 +9983,7 @@ type PullsCreateFromIssueResponseRequestedTeamsItem = { slug: string; url: string; }; -type PullsCreateFromIssueResponseRequestedReviewersItem = { +type PullsCreateReviewRequestResponseRequestedReviewersItem = { avatar_url: string; events_url: string; followers_url: string; @@ -12886,7 +10003,7 @@ type PullsCreateFromIssueResponseRequestedReviewersItem = { type: string; url: string; }; -type PullsCreateFromIssueResponseMilestoneCreator = { +type PullsCreateReviewRequestResponseMilestoneCreator = { avatar_url: string; events_url: string; followers_url: string; @@ -12906,11 +10023,11 @@ type PullsCreateFromIssueResponseMilestoneCreator = { type: string; url: string; }; -type PullsCreateFromIssueResponseMilestone = { +type PullsCreateReviewRequestResponseMilestone = { closed_at: string; closed_issues: number; created_at: string; - creator: PullsCreateFromIssueResponseMilestoneCreator; + creator: PullsCreateReviewRequestResponseMilestoneCreator; description: string; due_on: string; html_url: string; @@ -12924,27 +10041,7 @@ type PullsCreateFromIssueResponseMilestone = { updated_at: string; url: string; }; -type PullsCreateFromIssueResponseMergedBy = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type PullsCreateFromIssueResponseLabelsItem = { +type PullsCreateReviewRequestResponseLabelsItem = { color: string; default: boolean; description: string; @@ -12953,7 +10050,7 @@ type PullsCreateFromIssueResponseLabelsItem = { node_id: string; url: string; }; -type PullsCreateFromIssueResponseHeadUser = { +type PullsCreateReviewRequestResponseHeadUser = { avatar_url: string; events_url: string; followers_url: string; @@ -12973,12 +10070,12 @@ type PullsCreateFromIssueResponseHeadUser = { type: string; url: string; }; -type PullsCreateFromIssueResponseHeadRepoPermissions = { +type PullsCreateReviewRequestResponseHeadRepoPermissions = { admin: boolean; pull: boolean; push: boolean; }; -type PullsCreateFromIssueResponseHeadRepoOwner = { +type PullsCreateReviewRequestResponseHeadRepoOwner = { avatar_url: string; events_url: string; followers_url: string; @@ -12998,7 +10095,7 @@ type PullsCreateFromIssueResponseHeadRepoOwner = { type: string; url: string; }; -type PullsCreateFromIssueResponseHeadRepo = { +type PullsCreateReviewRequestResponseHeadRepo = { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; @@ -13054,8 +10151,8 @@ type PullsCreateFromIssueResponseHeadRepo = { node_id: string; notifications_url: string; open_issues_count: number; - owner: PullsCreateFromIssueResponseHeadRepoOwner; - permissions: PullsCreateFromIssueResponseHeadRepoPermissions; + owner: PullsCreateReviewRequestResponseHeadRepoOwner; + permissions: PullsCreateReviewRequestResponseHeadRepoPermissions; private: boolean; pulls_url: string; pushed_at: string; @@ -13080,14 +10177,14 @@ type PullsCreateFromIssueResponseHeadRepo = { visibility: string; watchers_count: number; }; -type PullsCreateFromIssueResponseHead = { +type PullsCreateReviewRequestResponseHead = { label: string; ref: string; - repo: PullsCreateFromIssueResponseHeadRepo; + repo: PullsCreateReviewRequestResponseHeadRepo; sha: string; - user: PullsCreateFromIssueResponseHeadUser; + user: PullsCreateReviewRequestResponseHeadUser; }; -type PullsCreateFromIssueResponseBaseUser = { +type PullsCreateReviewRequestResponseBaseUser = { avatar_url: string; events_url: string; followers_url: string; @@ -13107,12 +10204,12 @@ type PullsCreateFromIssueResponseBaseUser = { type: string; url: string; }; -type PullsCreateFromIssueResponseBaseRepoPermissions = { +type PullsCreateReviewRequestResponseBaseRepoPermissions = { admin: boolean; pull: boolean; push: boolean; }; -type PullsCreateFromIssueResponseBaseRepoOwner = { +type PullsCreateReviewRequestResponseBaseRepoOwner = { avatar_url: string; events_url: string; followers_url: string; @@ -13132,7 +10229,7 @@ type PullsCreateFromIssueResponseBaseRepoOwner = { type: string; url: string; }; -type PullsCreateFromIssueResponseBaseRepo = { +type PullsCreateReviewRequestResponseBaseRepo = { allow_merge_commit: boolean; allow_rebase_merge: boolean; allow_squash_merge: boolean; @@ -13188,8 +10285,8 @@ type PullsCreateFromIssueResponseBaseRepo = { node_id: string; notifications_url: string; open_issues_count: number; - owner: PullsCreateFromIssueResponseBaseRepoOwner; - permissions: PullsCreateFromIssueResponseBaseRepoPermissions; + owner: PullsCreateReviewRequestResponseBaseRepoOwner; + permissions: PullsCreateReviewRequestResponseBaseRepoPermissions; private: boolean; pulls_url: string; pushed_at: string; @@ -13214,14 +10311,14 @@ type PullsCreateFromIssueResponseBaseRepo = { visibility: string; watchers_count: number; }; -type PullsCreateFromIssueResponseBase = { +type PullsCreateReviewRequestResponseBase = { label: string; ref: string; - repo: PullsCreateFromIssueResponseBaseRepo; + repo: PullsCreateReviewRequestResponseBaseRepo; sha: string; - user: PullsCreateFromIssueResponseBaseUser; + user: PullsCreateReviewRequestResponseBaseUser; }; -type PullsCreateFromIssueResponseAssigneesItem = { +type PullsCreateReviewRequestResponseAssigneesItem = { avatar_url: string; events_url: string; followers_url: string; @@ -13241,7 +10338,7 @@ type PullsCreateFromIssueResponseAssigneesItem = { type: string; url: string; }; -type PullsCreateFromIssueResponseAssignee = { +type PullsCreateReviewRequestResponseAssignee = { avatar_url: string; events_url: string; followers_url: string; @@ -13261,76 +10358,64 @@ type PullsCreateFromIssueResponseAssignee = { type: string; url: string; }; -type PullsCreateFromIssueResponseLinksStatuses = { href: string }; -type PullsCreateFromIssueResponseLinksSelf = { href: string }; -type PullsCreateFromIssueResponseLinksReviewComments = { href: string }; -type PullsCreateFromIssueResponseLinksReviewComment = { href: string }; -type PullsCreateFromIssueResponseLinksIssue = { href: string }; -type PullsCreateFromIssueResponseLinksHtml = { href: string }; -type PullsCreateFromIssueResponseLinksCommits = { href: string }; -type PullsCreateFromIssueResponseLinksComments = { href: string }; -type PullsCreateFromIssueResponseLinks = { - comments: PullsCreateFromIssueResponseLinksComments; - commits: PullsCreateFromIssueResponseLinksCommits; - html: PullsCreateFromIssueResponseLinksHtml; - issue: PullsCreateFromIssueResponseLinksIssue; - review_comment: PullsCreateFromIssueResponseLinksReviewComment; - review_comments: PullsCreateFromIssueResponseLinksReviewComments; - self: PullsCreateFromIssueResponseLinksSelf; - statuses: PullsCreateFromIssueResponseLinksStatuses; +type PullsCreateReviewRequestResponseLinksStatuses = { href: string }; +type PullsCreateReviewRequestResponseLinksSelf = { href: string }; +type PullsCreateReviewRequestResponseLinksReviewComments = { href: string }; +type PullsCreateReviewRequestResponseLinksReviewComment = { href: string }; +type PullsCreateReviewRequestResponseLinksIssue = { href: string }; +type PullsCreateReviewRequestResponseLinksHtml = { href: string }; +type PullsCreateReviewRequestResponseLinksCommits = { href: string }; +type PullsCreateReviewRequestResponseLinksComments = { href: string }; +type PullsCreateReviewRequestResponseLinks = { + comments: PullsCreateReviewRequestResponseLinksComments; + commits: PullsCreateReviewRequestResponseLinksCommits; + html: PullsCreateReviewRequestResponseLinksHtml; + issue: PullsCreateReviewRequestResponseLinksIssue; + review_comment: PullsCreateReviewRequestResponseLinksReviewComment; + review_comments: PullsCreateReviewRequestResponseLinksReviewComments; + self: PullsCreateReviewRequestResponseLinksSelf; + statuses: PullsCreateReviewRequestResponseLinksStatuses; }; -type PullsCreateFromIssueResponse = { - _links: PullsCreateFromIssueResponseLinks; +type PullsCreateReviewRequestResponse = { + _links: PullsCreateReviewRequestResponseLinks; active_lock_reason: string; - additions: number; - assignee: PullsCreateFromIssueResponseAssignee; - assignees: Array; + assignee: PullsCreateReviewRequestResponseAssignee; + assignees: Array; author_association: string; - base: PullsCreateFromIssueResponseBase; + base: PullsCreateReviewRequestResponseBase; body: string; - changed_files: number; closed_at: string; - comments: number; comments_url: string; - commits: number; commits_url: string; created_at: string; - deletions: number; diff_url: string; draft: boolean; - head: PullsCreateFromIssueResponseHead; + head: PullsCreateReviewRequestResponseHead; html_url: string; id: number; issue_url: string; - labels: Array; + labels: Array; locked: boolean; - maintainer_can_modify: boolean; merge_commit_sha: string; - mergeable: boolean; - mergeable_state: string; - merged: boolean; merged_at: string; - merged_by: PullsCreateFromIssueResponseMergedBy; - milestone: PullsCreateFromIssueResponseMilestone; + milestone: PullsCreateReviewRequestResponseMilestone; node_id: string; number: number; patch_url: string; - rebaseable: boolean; requested_reviewers: Array< - PullsCreateFromIssueResponseRequestedReviewersItem + PullsCreateReviewRequestResponseRequestedReviewersItem >; - requested_teams: Array; + requested_teams: Array; review_comment_url: string; - review_comments: number; review_comments_url: string; state: string; statuses_url: string; title: string; updated_at: string; url: string; - user: PullsCreateFromIssueResponseUser; + user: PullsCreateReviewRequestResponseUser; }; -type PullsCreateCommentReplyResponseUser = { +type PullsCreateReviewCommentReplyResponseUser = { avatar_url: string; events_url: string; followers_url: string; @@ -13350,16 +10435,16 @@ type PullsCreateCommentReplyResponseUser = { type: string; url: string; }; -type PullsCreateCommentReplyResponseLinksSelf = { href: string }; -type PullsCreateCommentReplyResponseLinksPullRequest = { href: string }; -type PullsCreateCommentReplyResponseLinksHtml = { href: string }; -type PullsCreateCommentReplyResponseLinks = { - html: PullsCreateCommentReplyResponseLinksHtml; - pull_request: PullsCreateCommentReplyResponseLinksPullRequest; - self: PullsCreateCommentReplyResponseLinksSelf; +type PullsCreateReviewCommentReplyResponseLinksSelf = { href: string }; +type PullsCreateReviewCommentReplyResponseLinksPullRequest = { href: string }; +type PullsCreateReviewCommentReplyResponseLinksHtml = { href: string }; +type PullsCreateReviewCommentReplyResponseLinks = { + html: PullsCreateReviewCommentReplyResponseLinksHtml; + pull_request: PullsCreateReviewCommentReplyResponseLinksPullRequest; + self: PullsCreateReviewCommentReplyResponseLinksSelf; }; -type PullsCreateCommentReplyResponse = { - _links: PullsCreateCommentReplyResponseLinks; +type PullsCreateReviewCommentReplyResponse = { + _links: PullsCreateReviewCommentReplyResponseLinks; author_association: string; body: string; commit_id: string; @@ -13367,23 +10452,53 @@ type PullsCreateCommentReplyResponse = { diff_hunk: string; html_url: string; id: number; - in_reply_to_id: number; - line: number; node_id: string; original_commit_id: string; - original_line: number; original_position: number; - original_start_line: number; path: string; position: number; pull_request_review_id: number; pull_request_url: string; - side: string; - start_line: number; - start_side: string; updated_at: string; url: string; - user: PullsCreateCommentReplyResponseUser; + user: PullsCreateReviewCommentReplyResponseUser; +}; +type PullsCreateReviewResponseUser = { + avatar_url: string; + events_url: string; + followers_url: string; + following_url: string; + gists_url: string; + gravatar_id: string; + html_url: string; + id: number; + login: string; + node_id: string; + organizations_url: string; + received_events_url: string; + repos_url: string; + site_admin: boolean; + starred_url: string; + subscriptions_url: string; + type: string; + url: string; +}; +type PullsCreateReviewResponseLinksPullRequest = { href: string }; +type PullsCreateReviewResponseLinksHtml = { href: string }; +type PullsCreateReviewResponseLinks = { + html: PullsCreateReviewResponseLinksHtml; + pull_request: PullsCreateReviewResponseLinksPullRequest; +}; +type PullsCreateReviewResponse = { + _links: PullsCreateReviewResponseLinks; + body: string; + commit_id: string; + html_url: string; + id: number; + node_id: string; + pull_request_url: string; + state: string; + user: PullsCreateReviewResponseUser; }; type PullsCreateCommentResponseUser = { avatar_url: string; @@ -15038,245 +12153,6 @@ type OrgsAddOrUpdateMembershipResponse = { url: string; user: OrgsAddOrUpdateMembershipResponseUser; }; -type OauthAuthorizationsUpdateAuthorizationResponseApp = { - client_id: string; - name: string; - url: string; -}; -type OauthAuthorizationsUpdateAuthorizationResponse = { - app: OauthAuthorizationsUpdateAuthorizationResponseApp; - created_at: string; - fingerprint: string; - hashed_token: string; - id: number; - note: string; - note_url: string; - scopes: Array; - token: string; - token_last_eight: string; - updated_at: string; - url: string; -}; -type OauthAuthorizationsResetAuthorizationResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type OauthAuthorizationsResetAuthorizationResponseApp = { - client_id: string; - name: string; - url: string; -}; -type OauthAuthorizationsResetAuthorizationResponse = { - app: OauthAuthorizationsResetAuthorizationResponseApp; - created_at: string; - fingerprint: string; - hashed_token: string; - id: number; - note: string; - note_url: string; - scopes: Array; - token: string; - token_last_eight: string; - updated_at: string; - url: string; - user: OauthAuthorizationsResetAuthorizationResponseUser; -}; -type OauthAuthorizationsListGrantsResponseItemApp = { - client_id: string; - name: string; - url: string; -}; -type OauthAuthorizationsListGrantsResponseItem = { - app: OauthAuthorizationsListGrantsResponseItemApp; - created_at: string; - id: number; - scopes: Array; - updated_at: string; - url: string; -}; -type OauthAuthorizationsListAuthorizationsResponseItemApp = { - client_id: string; - name: string; - url: string; -}; -type OauthAuthorizationsListAuthorizationsResponseItem = { - app: OauthAuthorizationsListAuthorizationsResponseItemApp; - created_at: string; - fingerprint: string; - hashed_token: string; - id: number; - note: string; - note_url: string; - scopes: Array; - token: string; - token_last_eight: string; - updated_at: string; - url: string; -}; -type OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintResponseApp = { - client_id: string; - name: string; - url: string; -}; -type OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintResponse = { - app: OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintResponseApp; - created_at: string; - fingerprint: string; - hashed_token: string; - id: number; - note: string; - note_url: string; - scopes: Array; - token: string; - token_last_eight: string; - updated_at: string; - url: string; -}; -type OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintResponseApp = { - client_id: string; - name: string; - url: string; -}; -type OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintResponse = { - app: OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintResponseApp; - created_at: string; - fingerprint: string; - hashed_token: string; - id: number; - note: string; - note_url: string; - scopes: Array; - token: string; - token_last_eight: string; - updated_at: string; - url: string; -}; -type OauthAuthorizationsGetOrCreateAuthorizationForAppResponseApp = { - client_id: string; - name: string; - url: string; -}; -type OauthAuthorizationsGetOrCreateAuthorizationForAppResponse = { - app: OauthAuthorizationsGetOrCreateAuthorizationForAppResponseApp; - created_at: string; - fingerprint: string; - hashed_token: string; - id: number; - note: string; - note_url: string; - scopes: Array; - token: string; - token_last_eight: string; - updated_at: string; - url: string; -}; -type OauthAuthorizationsGetGrantResponseApp = { - client_id: string; - name: string; - url: string; -}; -type OauthAuthorizationsGetGrantResponse = { - app: OauthAuthorizationsGetGrantResponseApp; - created_at: string; - id: number; - scopes: Array; - updated_at: string; - url: string; -}; -type OauthAuthorizationsGetAuthorizationResponseApp = { - client_id: string; - name: string; - url: string; -}; -type OauthAuthorizationsGetAuthorizationResponse = { - app: OauthAuthorizationsGetAuthorizationResponseApp; - created_at: string; - fingerprint: string; - hashed_token: string; - id: number; - note: string; - note_url: string; - scopes: Array; - token: string; - token_last_eight: string; - updated_at: string; - url: string; -}; -type OauthAuthorizationsCreateAuthorizationResponseApp = { - client_id: string; - name: string; - url: string; -}; -type OauthAuthorizationsCreateAuthorizationResponse = { - app: OauthAuthorizationsCreateAuthorizationResponseApp; - created_at: string; - fingerprint: string; - hashed_token: string; - id: number; - note: string; - note_url: string; - scopes: Array; - token: string; - token_last_eight: string; - updated_at: string; - url: string; -}; -type OauthAuthorizationsCheckAuthorizationResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type OauthAuthorizationsCheckAuthorizationResponseApp = { - client_id: string; - name: string; - url: string; -}; -type OauthAuthorizationsCheckAuthorizationResponse = { - app: OauthAuthorizationsCheckAuthorizationResponseApp; - created_at: string; - fingerprint: string; - hashed_token: string; - id: number; - note: string; - note_url: string; - scopes: Array; - token: string; - token_last_eight: string; - updated_at: string; - url: string; - user: OauthAuthorizationsCheckAuthorizationResponseUser; -}; type MigrationsUpdateImportResponse = { authors_url: string; html_url: string; @@ -16435,13 +13311,6 @@ type LicensesListCommonlyUsedResponseItem = { spdx_id: string; url: string; }; -type LicensesListResponseItem = { - key: string; - name: string; - node_id?: string; - spdx_id: string; - url: string; -}; type LicensesGetForRepoResponseLicense = { key: string; name: string; @@ -21199,46 +18068,6 @@ type AppsResetTokenResponse = { url: string; user: AppsResetTokenResponseUser; }; -type AppsResetAuthorizationResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type AppsResetAuthorizationResponseApp = { - client_id: string; - name: string; - url: string; -}; -type AppsResetAuthorizationResponse = { - app: AppsResetAuthorizationResponseApp; - created_at: string; - fingerprint: string; - hashed_token: string; - id: number; - note: string; - note_url: string; - scopes: Array; - token: string; - token_last_eight: string; - updated_at: string; - url: string; - user: AppsResetAuthorizationResponseUser; -}; type AppsListReposResponseRepositoriesItemOwner = { avatar_url: string; events_url: string; @@ -21971,127 +18800,6 @@ type AppsGetAuthenticatedResponse = { slug: string; updated_at: string; }; -type AppsFindUserInstallationResponsePermissions = { - checks: string; - contents: string; - metadata: string; -}; -type AppsFindUserInstallationResponseAccount = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type AppsFindUserInstallationResponse = { - access_tokens_url: string; - account: AppsFindUserInstallationResponseAccount; - app_id: number; - created_at: string; - events: Array; - html_url: string; - id: number; - permissions: AppsFindUserInstallationResponsePermissions; - repositories_url: string; - repository_selection: string; - single_file_name: null; - target_id: number; - target_type: string; - updated_at: string; -}; -type AppsFindRepoInstallationResponsePermissions = { - checks: string; - contents: string; - metadata: string; -}; -type AppsFindRepoInstallationResponseAccount = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type AppsFindRepoInstallationResponse = { - access_tokens_url: string; - account: AppsFindRepoInstallationResponseAccount; - app_id: number; - created_at: string; - events: Array; - html_url: string; - id: number; - permissions: AppsFindRepoInstallationResponsePermissions; - repositories_url: string; - repository_selection: string; - single_file_name: null; - target_id: number; - target_type: string; - updated_at: string; -}; -type AppsFindOrgInstallationResponsePermissions = { - checks: string; - contents: string; - metadata: string; -}; -type AppsFindOrgInstallationResponseAccount = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type AppsFindOrgInstallationResponse = { - access_tokens_url: string; - account: AppsFindOrgInstallationResponseAccount; - app_id: number; - created_at: string; - events: Array; - html_url: string; - id: number; - permissions: AppsFindOrgInstallationResponsePermissions; - repositories_url: string; - repository_selection: string; - single_file_name: null; - target_id: number; - target_type: string; - updated_at: string; -}; type AppsCreateInstallationTokenResponseRepositoriesItemPermissions = { admin: boolean; pull: boolean; @@ -22289,46 +18997,6 @@ type AppsCheckTokenResponse = { url: string; user: AppsCheckTokenResponseUser; }; -type AppsCheckAuthorizationResponseUser = { - avatar_url: string; - events_url: string; - followers_url: string; - following_url: string; - gists_url: string; - gravatar_id: string; - html_url: string; - id: number; - login: string; - node_id: string; - organizations_url: string; - received_events_url: string; - repos_url: string; - site_admin: boolean; - starred_url: string; - subscriptions_url: string; - type: string; - url: string; -}; -type AppsCheckAuthorizationResponseApp = { - client_id: string; - name: string; - url: string; -}; -type AppsCheckAuthorizationResponse = { - app: AppsCheckAuthorizationResponseApp; - created_at: string; - fingerprint: string; - hashed_token: string; - id: number; - note: string; - note_url: string; - scopes: Array; - token: string; - token_last_eight: string; - updated_at: string; - url: string; - user: AppsCheckAuthorizationResponseUser; -}; type AppsCheckAccountIsAssociatedWithAnyStubbedResponseMarketplacePurchasePlan = { accounts_url: string; bullets: Array; @@ -24025,7 +20693,6 @@ type IssuesListMilestonesForRepoResponse = Array< >; type IssuesRemoveLabelResponse = Array; type IssuesReplaceLabelsResponse = Array; -type LicensesListResponse = Array; type LicensesListCommonlyUsedResponse = Array< LicensesListCommonlyUsedResponseItem >; @@ -24045,12 +20712,6 @@ type MigrationsListReposForOrgResponse = Array< type MigrationsListReposForUserResponse = Array< MigrationsListReposForUserResponseItem >; -type OauthAuthorizationsListAuthorizationsResponse = Array< - OauthAuthorizationsListAuthorizationsResponseItem ->; -type OauthAuthorizationsListGrantsResponse = Array< - OauthAuthorizationsListGrantsResponseItem ->; type OrgsListResponse = Array; type OrgsListBlockedUsersResponse = Array; type OrgsListForAuthenticatedUserResponse = Array< @@ -24099,24 +20760,12 @@ type ReactionsListForIssueCommentResponse = Array< type ReactionsListForPullRequestReviewCommentResponse = Array< ReactionsListForPullRequestReviewCommentResponseItem >; -type ReactionsListForTeamDiscussionResponse = Array< - ReactionsListForTeamDiscussionResponseItem ->; -type ReactionsListForTeamDiscussionCommentResponse = Array< - ReactionsListForTeamDiscussionCommentResponseItem ->; type ReactionsListForTeamDiscussionCommentInOrgResponse = Array< ReactionsListForTeamDiscussionCommentInOrgResponseItem >; -type ReactionsListForTeamDiscussionCommentLegacyResponse = Array< - ReactionsListForTeamDiscussionCommentLegacyResponseItem ->; type ReactionsListForTeamDiscussionInOrgResponse = Array< ReactionsListForTeamDiscussionInOrgResponseItem >; -type ReactionsListForTeamDiscussionLegacyResponse = Array< - ReactionsListForTeamDiscussionLegacyResponseItem ->; type ReposAddProtectedBranchAppRestrictionsResponse = Array< ReposAddProtectedBranchAppRestrictionsResponseItem >; @@ -24148,9 +20797,6 @@ type ReposGetTopReferrersResponse = Array; type ReposGetUsersWithAccessToProtectedBranchResponse = Array< ReposGetUsersWithAccessToProtectedBranchResponseItem >; -type ReposListAppsWithAccessToProtectedBranchResponse = Array< - ReposListAppsWithAccessToProtectedBranchResponseItem ->; type ReposListAssetsForReleaseResponse = Array< ReposListAssetsForReleaseResponseItem >; @@ -24184,12 +20830,6 @@ type ReposListPagesBuildsResponse = Array; type ReposListProtectedBranchRequiredStatusChecksContextsResponse = Array< string >; -type ReposListProtectedBranchTeamRestrictionsResponse = Array< - ReposListProtectedBranchTeamRestrictionsResponseItem ->; -type ReposListProtectedBranchUserRestrictionsResponse = Array< - ReposListProtectedBranchUserRestrictionsResponseItem ->; type ReposListPublicResponse = Array; type ReposListPullRequestsAssociatedWithCommitResponse = Array< ReposListPullRequestsAssociatedWithCommitResponseItem @@ -24200,12 +20840,6 @@ type ReposListStatusesForRefResponse = Array< >; type ReposListTagsResponse = Array; type ReposListTeamsResponse = Array; -type ReposListTeamsWithAccessToProtectedBranchResponse = Array< - ReposListTeamsWithAccessToProtectedBranchResponseItem ->; -type ReposListUsersWithAccessToProtectedBranchResponse = Array< - ReposListUsersWithAccessToProtectedBranchResponseItem ->; type ReposRemoveProtectedBranchAppRestrictionsResponse = Array< ReposRemoveProtectedBranchAppRestrictionsResponseItem >; @@ -24231,48 +20865,22 @@ type ReposReplaceProtectedBranchUserRestrictionsResponse = Array< ReposReplaceProtectedBranchUserRestrictionsResponseItem >; type TeamsListResponse = Array; -type TeamsListChildResponse = Array; type TeamsListChildInOrgResponse = Array; -type TeamsListChildLegacyResponse = Array; -type TeamsListDiscussionCommentsResponse = Array< - TeamsListDiscussionCommentsResponseItem ->; type TeamsListDiscussionCommentsInOrgResponse = Array< TeamsListDiscussionCommentsInOrgResponseItem >; -type TeamsListDiscussionCommentsLegacyResponse = Array< - TeamsListDiscussionCommentsLegacyResponseItem ->; -type TeamsListDiscussionsResponse = Array; type TeamsListDiscussionsInOrgResponse = Array< TeamsListDiscussionsInOrgResponseItem >; -type TeamsListDiscussionsLegacyResponse = Array< - TeamsListDiscussionsLegacyResponseItem ->; type TeamsListForAuthenticatedUserResponse = Array< TeamsListForAuthenticatedUserResponseItem >; -type TeamsListMembersResponse = Array; type TeamsListMembersInOrgResponse = Array; -type TeamsListMembersLegacyResponse = Array; -type TeamsListPendingInvitationsResponse = Array< - TeamsListPendingInvitationsResponseItem ->; type TeamsListPendingInvitationsInOrgResponse = Array< TeamsListPendingInvitationsInOrgResponseItem >; -type TeamsListPendingInvitationsLegacyResponse = Array< - TeamsListPendingInvitationsLegacyResponseItem ->; -type TeamsListProjectsResponse = Array; type TeamsListProjectsInOrgResponse = Array; -type TeamsListProjectsLegacyResponse = Array< - TeamsListProjectsLegacyResponseItem ->; -type TeamsListReposResponse = Array; type TeamsListReposInOrgResponse = Array; -type TeamsListReposLegacyResponse = Array; type UsersAddEmailsResponse = Array; type UsersListResponse = Array; type UsersListBlockedResponse = Array; @@ -24870,10 +21478,6 @@ export type AppsCheckAccountIsAssociatedWithAnyParams = { export type AppsCheckAccountIsAssociatedWithAnyStubbedParams = { account_id: number; }; -export type AppsCheckAuthorizationParams = { - access_token: string; - client_id: string; -}; export type AppsCheckTokenParams = { /** * The OAuth access token used to authenticate to the GitHub API. @@ -24923,16 +21527,6 @@ export type AppsDeleteTokenParams = { access_token?: string; client_id: string; }; -export type AppsFindOrgInstallationParams = { - org: string; -}; -export type AppsFindRepoInstallationParams = { - owner: string; - repo: string; -}; -export type AppsFindUserInstallationParams = { - username: string; -}; export type AppsGetBySlugParams = { app_slug: string; }; @@ -25072,10 +21666,6 @@ export type AppsRemoveRepoFromInstallationParams = { installation_id: number; repository_id: number; }; -export type AppsResetAuthorizationParams = { - access_token: string; - client_id: string; -}; export type AppsResetTokenParams = { /** * The OAuth access token used to authenticate to the GitHub API. @@ -25083,14 +21673,6 @@ export type AppsResetTokenParams = { access_token?: string; client_id: string; }; -export type AppsRevokeAuthorizationForApplicationParams = { - access_token: string; - client_id: string; -}; -export type AppsRevokeGrantForApplicationParams = { - access_token: string; - client_id: string; -}; export type ChecksCreateParams = { /** * Displays a button on GitHub that can be clicked to alert your app to do additional tasks. For example, a code linting app can display a button that automatically fixes detected errors. The button created in this object is displayed after the check run completes. When a user clicks the button, GitHub sends the [`check_run.requested_action` webhook](https://developer.github.com/v3/activity/events/types/#checkrunevent) to your app. Each action includes a `label`, `identifier` and `description`. A maximum of three actions are accepted. See the [`actions` object](https://developer.github.com/v3/checks/runs/#actions-object) description. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions)." To learn more about check runs and requested actions, see "[Check runs and requested actions](https://developer.github.com/v3/checks/runs/#check-runs-and-requested-actions)." @@ -25102,7 +21684,7 @@ export type ChecksCreateParams = { completed_at?: string; /** * **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, or `action_required`. When the conclusion is `action_required`, additional details should be provided on the site specified by `details_url`. - * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. + * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`. */ conclusion?: | "success" @@ -25269,7 +21851,7 @@ export type ChecksUpdateParams = { completed_at?: string; /** * **Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, or `action_required`. - * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. + * **Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. Only GitHub can change a check run conclusion to `stale`. */ conclusion?: | "success" @@ -25604,16 +22186,6 @@ export type GitListMatchingRefsParams = { ref: string; repo: string; }; -export type GitListRefsParams = { - /** - * Filter by sub-namespace (reference prefix). Most commen examples would be `'heads/'` and `'tags/'` to retrieve branches or tags - */ - namespace?: string; - owner: string; - page?: number; - per_page?: number; - repo: string; -}; export type GitUpdateRefParams = { /** * Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work. @@ -25659,18 +22231,6 @@ export type InteractionsRemoveRestrictionsForRepoParams = { owner: string; repo: string; }; -export type IssuesAddAssigneesParamsDeprecatedNumber = { - /** - * Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._ - */ - assignees?: string[]; - /** - * @deprecated "number" parameter renamed to "issue_number" - */ - number: number; - owner: string; - repo: string; -}; export type IssuesAddAssigneesParams = { /** * Usernames of people to assign this issue to. _NOTE: Only users with push access can add assignees to an issue. Assignees are silently ignored otherwise._ @@ -25680,18 +22240,6 @@ export type IssuesAddAssigneesParams = { owner: string; repo: string; }; -export type IssuesAddLabelsParamsDeprecatedNumber = { - /** - * The name of the label to add to the issue. Must contain at least one label. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. - */ - labels: string[]; - /** - * @deprecated "number" parameter renamed to "issue_number" - */ - number: number; - owner: string; - repo: string; -}; export type IssuesAddLabelsParams = { issue_number: number; /** @@ -25759,18 +22307,6 @@ export type IssuesCreateParams = { */ title: string; }; -export type IssuesCreateCommentParamsDeprecatedNumber = { - /** - * The contents of the comment. - */ - body: string; - /** - * @deprecated "number" parameter renamed to "issue_number" - */ - number: number; - owner: string; - repo: string; -}; export type IssuesCreateCommentParams = { /** * The contents of the comment. @@ -25826,27 +22362,11 @@ export type IssuesDeleteLabelParams = { owner: string; repo: string; }; -export type IssuesDeleteMilestoneParamsDeprecatedNumber = { - /** - * @deprecated "number" parameter renamed to "milestone_number" - */ - number: number; - owner: string; - repo: string; -}; export type IssuesDeleteMilestoneParams = { milestone_number: number; owner: string; repo: string; }; -export type IssuesGetParamsDeprecatedNumber = { - /** - * @deprecated "number" parameter renamed to "issue_number" - */ - number: number; - owner: string; - repo: string; -}; export type IssuesGetParams = { issue_number: number; owner: string; @@ -25867,14 +22387,6 @@ export type IssuesGetLabelParams = { owner: string; repo: string; }; -export type IssuesGetMilestoneParamsDeprecatedNumber = { - /** - * @deprecated "number" parameter renamed to "milestone_number" - */ - number: number; - owner: string; - repo: string; -}; export type IssuesGetMilestoneParams = { milestone_number: number; owner: string; @@ -25931,26 +22443,6 @@ export type IssuesListAssigneesParams = { per_page?: number; repo: string; }; -export type IssuesListCommentsParamsDeprecatedNumber = { - /** - * @deprecated "number" parameter renamed to "issue_number" - */ - number: number; - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - repo: string; - /** - * Only comments updated at or after this time are returned. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - since?: string; -}; export type IssuesListCommentsParams = { issue_number: number; owner: string; @@ -25984,22 +22476,6 @@ export type IssuesListCommentsForRepoParams = { */ sort?: "created" | "updated"; }; -export type IssuesListEventsParamsDeprecatedNumber = { - /** - * @deprecated "number" parameter renamed to "issue_number" - */ - number: number; - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - repo: string; -}; export type IssuesListEventsParams = { issue_number: number; owner: string; @@ -26025,22 +22501,6 @@ export type IssuesListEventsForRepoParams = { per_page?: number; repo: string; }; -export type IssuesListEventsForTimelineParamsDeprecatedNumber = { - /** - * @deprecated "number" parameter renamed to "issue_number" - */ - number: number; - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - repo: string; -}; export type IssuesListEventsForTimelineParams = { issue_number: number; owner: string; @@ -26181,22 +22641,6 @@ export type IssuesListForRepoParams = { */ state?: "open" | "closed" | "all"; }; -export type IssuesListLabelsForMilestoneParamsDeprecatedNumber = { - /** - * @deprecated "number" parameter renamed to "milestone_number" - */ - number: number; - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - repo: string; -}; export type IssuesListLabelsForMilestoneParams = { milestone_number: number; owner: string; @@ -26222,22 +22666,6 @@ export type IssuesListLabelsForRepoParams = { per_page?: number; repo: string; }; -export type IssuesListLabelsOnIssueParamsDeprecatedNumber = { - /** - * @deprecated "number" parameter renamed to "issue_number" - */ - number: number; - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - repo: string; -}; export type IssuesListLabelsOnIssueParams = { issue_number: number; owner: string; @@ -26275,22 +22703,6 @@ export type IssuesListMilestonesForRepoParams = { */ state?: "open" | "closed" | "all"; }; -export type IssuesLockParamsDeprecatedNumber = { - /** - * The reason for locking the issue or pull request conversation. Lock will fail if you don't use one of these reasons: - * \* `off-topic` - * \* `too heated` - * \* `resolved` - * \* `spam` - */ - lock_reason?: "off-topic" | "too heated" | "resolved" | "spam"; - /** - * @deprecated "number" parameter renamed to "issue_number" - */ - number: number; - owner: string; - repo: string; -}; export type IssuesLockParams = { issue_number: number; /** @@ -26304,18 +22716,6 @@ export type IssuesLockParams = { owner: string; repo: string; }; -export type IssuesRemoveAssigneesParamsDeprecatedNumber = { - /** - * Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._ - */ - assignees?: string[]; - /** - * @deprecated "number" parameter renamed to "issue_number" - */ - number: number; - owner: string; - repo: string; -}; export type IssuesRemoveAssigneesParams = { /** * Usernames of assignees to remove from an issue. _NOTE: Only users with push access can remove assignees from an issue. Assignees are silently ignored otherwise._ @@ -26325,46 +22725,17 @@ export type IssuesRemoveAssigneesParams = { owner: string; repo: string; }; -export type IssuesRemoveLabelParamsDeprecatedNumber = { - name: string; - /** - * @deprecated "number" parameter renamed to "issue_number" - */ - number: number; - owner: string; - repo: string; -}; export type IssuesRemoveLabelParams = { issue_number: number; name: string; owner: string; repo: string; }; -export type IssuesRemoveLabelsParamsDeprecatedNumber = { - /** - * @deprecated "number" parameter renamed to "issue_number" - */ - number: number; - owner: string; - repo: string; -}; export type IssuesRemoveLabelsParams = { issue_number: number; owner: string; repo: string; }; -export type IssuesReplaceLabelsParamsDeprecatedNumber = { - /** - * The names of the labels to add to the issue. You can pass an empty array to remove all labels. **Note:** Alternatively, you can pass a single label as a `string` or an `array` of labels directly, but GitHub recommends passing an object with the `labels` key. - */ - labels?: string[]; - /** - * @deprecated "number" parameter renamed to "issue_number" - */ - number: number; - owner: string; - repo: string; -}; export type IssuesReplaceLabelsParams = { issue_number: number; /** @@ -26374,51 +22745,11 @@ export type IssuesReplaceLabelsParams = { owner: string; repo: string; }; -export type IssuesUnlockParamsDeprecatedNumber = { - /** - * @deprecated "number" parameter renamed to "issue_number" - */ - number: number; - owner: string; - repo: string; -}; export type IssuesUnlockParams = { issue_number: number; owner: string; repo: string; }; -export type IssuesUpdateParamsDeprecatedNumber = { - /** - * Logins for Users to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this Issue. Send an empty array (`[]`) to clear all assignees from the Issue. _NOTE: Only users with push access can set assignees for new issues. Assignees are silently dropped otherwise._ - */ - assignees?: string[]; - /** - * The contents of the issue. - */ - body?: string; - /** - * Labels to associate with this issue. Pass one or more Labels to _replace_ the set of Labels on this Issue. Send an empty array (`[]`) to clear all Labels from the Issue. _NOTE: Only users with push access can set labels for issues. Labels are silently dropped otherwise._ - */ - labels?: string[]; - /** - * The `number` of the milestone to associate this issue with or `null` to remove current. _NOTE: Only users with push access can set the milestone for issues. The milestone is silently dropped otherwise._ - */ - milestone?: number | null; - /** - * @deprecated "number" parameter renamed to "issue_number" - */ - number: number; - owner: string; - repo: string; - /** - * State of the issue. Either `open` or `closed`. - */ - state?: "open" | "closed"; - /** - * The title of the issue. - */ - title?: string; -}; export type IssuesUpdateParamsDeprecatedAssignee = { /** * Login for the user that this issue should be assigned to. **This field is deprecated.** @@ -26496,41 +22827,17 @@ export type IssuesUpdateLabelParams = { * The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`. */ color?: string; - current_name: string; /** * A short description of the label. */ description?: string; + name: string; /** * The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji ![:strawberry:](https://github.githubassets.com/images/icons/emoji/unicode/1f353.png ":strawberry:"). For a full list of available emoji and codes, see [emoji-cheat-sheet.com](http://emoji-cheat-sheet.com/). */ - name?: string; - owner: string; - repo: string; -}; -export type IssuesUpdateMilestoneParamsDeprecatedNumber = { - /** - * A description of the milestone. - */ - description?: string; - /** - * The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. - */ - due_on?: string; - /** - * @deprecated "number" parameter renamed to "milestone_number" - */ - number: number; + new_name?: string; owner: string; repo: string; - /** - * The state of the milestone. Either `open` or `closed`. - */ - state?: "open" | "closed"; - /** - * The title of the milestone. - */ - title?: string; }; export type IssuesUpdateMilestoneParams = { /** @@ -26597,10 +22904,6 @@ export type MigrationsDownloadArchiveForOrgParams = { export type MigrationsGetArchiveForAuthenticatedUserParams = { migration_id: number; }; -export type MigrationsGetArchiveForOrgParams = { - migration_id: number; - org: string; -}; export type MigrationsGetCommitAuthorsParams = { owner: string; repo: string; @@ -26763,170 +23066,6 @@ export type MigrationsUpdateImportParams = { */ vcs_username?: string; }; -export type OauthAuthorizationsCheckAuthorizationParams = { - access_token: string; - client_id: string; -}; -export type OauthAuthorizationsCreateAuthorizationParams = { - /** - * The 20 character OAuth app client key for which to create the token. - */ - client_id?: string; - /** - * The 40 character OAuth app client secret for which to create the token. - */ - client_secret?: string; - /** - * A unique string to distinguish an authorization from others created for the same client ID and user. - */ - fingerprint?: string; - /** - * A note to remind you what the OAuth token is for. Tokens not associated with a specific OAuth application (i.e. personal access tokens) must have a unique note. - */ - note: string; - /** - * A URL to remind you what app the OAuth token is for. - */ - note_url?: string; - /** - * A list of scopes that this authorization is in. - */ - scopes?: string[]; -}; -export type OauthAuthorizationsDeleteAuthorizationParams = { - authorization_id: number; -}; -export type OauthAuthorizationsDeleteGrantParams = { - grant_id: number; -}; -export type OauthAuthorizationsGetAuthorizationParams = { - authorization_id: number; -}; -export type OauthAuthorizationsGetGrantParams = { - grant_id: number; -}; -export type OauthAuthorizationsGetOrCreateAuthorizationForAppParams = { - client_id: string; - /** - * The 40 character OAuth app client secret associated with the client ID specified in the URL. - */ - client_secret: string; - /** - * A unique string to distinguish an authorization from others created for the same client and user. If provided, this API is functionally equivalent to [Get-or-create an authorization for a specific app and fingerprint](https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint). - */ - fingerprint?: string; - /** - * A note to remind you what the OAuth token is for. - */ - note?: string; - /** - * A URL to remind you what app the OAuth token is for. - */ - note_url?: string; - /** - * A list of scopes that this authorization is in. - */ - scopes?: string[]; -}; -export type OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintParams = { - client_id: string; - /** - * The 40 character OAuth app client secret associated with the client ID specified in the URL. - */ - client_secret: string; - fingerprint: string; - /** - * A note to remind you what the OAuth token is for. - */ - note?: string; - /** - * A URL to remind you what app the OAuth token is for. - */ - note_url?: string; - /** - * A list of scopes that this authorization is in. - */ - scopes?: string[]; -}; -export type OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintParams = { - client_id: string; - /** - * The 40 character OAuth app client secret associated with the client ID specified in the URL. - */ - client_secret: string; - fingerprint: string; - /** - * A note to remind you what the OAuth token is for. - */ - note?: string; - /** - * A URL to remind you what app the OAuth token is for. - */ - note_url?: string; - /** - * A list of scopes that this authorization is in. - */ - scopes?: string[]; -}; -export type OauthAuthorizationsListAuthorizationsParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; -}; -export type OauthAuthorizationsListGrantsParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; -}; -export type OauthAuthorizationsResetAuthorizationParams = { - access_token: string; - client_id: string; -}; -export type OauthAuthorizationsRevokeAuthorizationForApplicationParams = { - access_token: string; - client_id: string; -}; -export type OauthAuthorizationsRevokeGrantForApplicationParams = { - access_token: string; - client_id: string; -}; -export type OauthAuthorizationsUpdateAuthorizationParams = { - /** - * A list of scopes to add to this authorization. - */ - add_scopes?: string[]; - authorization_id: number; - /** - * A unique string to distinguish an authorization from others created for the same client ID and user. - */ - fingerprint?: string; - /** - * A note to remind you what the OAuth token is for. Tokens not associated with a specific OAuth application (i.e. personal access tokens) must have a unique note. - */ - note?: string; - /** - * A URL to remind you what app the OAuth token is for. - */ - note_url?: string; - /** - * A list of scopes to remove from this authorization. - */ - remove_scopes?: string[]; - /** - * Replaces the authorization scopes with these. - */ - scopes?: string[]; -}; export type OrgsAddOrUpdateMembershipParams = { org: string; /** @@ -27614,258 +23753,49 @@ export type ProjectsUpdateCardParams = { /** * The card's note content. Only valid for cards without another type of content, so this cannot be specified if the card already has a `content_id` and `content_type`. */ - note?: string; -}; -export type ProjectsUpdateColumnParams = { - column_id: number; - /** - * The new name of the column. - */ - name: string; -}; -export type PullsCheckIfMergedParamsDeprecatedNumber = { - /** - * @deprecated "number" parameter renamed to "pull_number" - */ - number: number; - owner: string; - repo: string; -}; -export type PullsCheckIfMergedParams = { - owner: string; - pull_number: number; - repo: string; -}; -export type PullsCreateParams = { - /** - * The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository. - */ - base: string; - /** - * The contents of the pull request. - */ - body?: string; - /** - * Indicates whether the pull request is a draft. See "[Draft Pull Requests](https://help.github.com/en/articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more. - */ - draft?: boolean; - /** - * The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`. - */ - head: string; - /** - * Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. - */ - maintainer_can_modify?: boolean; - owner: string; - repo: string; - /** - * The title of the new pull request. - */ - title: string; -}; -export type PullsCreateCommentParamsDeprecatedNumber = { - /** - * The text of the review comment. - */ - body: string; - /** - * The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`. - */ - commit_id: string; - /** - * **Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to. - */ - line?: number; - /** - * @deprecated "number" parameter renamed to "pull_number" - */ - number: number; - owner: string; - /** - * The relative path to the file that necessitates a comment. - */ - path: string; - /** - * **Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above. - */ - position?: number; - repo: string; - /** - * **Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. - */ - side?: "LEFT" | "RIGHT"; - /** - * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. - */ - start_line?: number; - /** - * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context. - */ - start_side?: "LEFT" | "RIGHT" | "side"; -}; -export type PullsCreateCommentParamsDeprecatedInReplyTo = { - /** - * The text of the review comment. - */ - body: string; - /** - * The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`. - */ - commit_id: string; - /** - * The comment ID to reply to. **Note**: This must be the ID of a top-level comment, not a reply to that comment. Replies to replies are not supported. - * @deprecated "in_reply_to" parameter has been deprecated and will be removed in future - */ - in_reply_to?: number; - /** - * **Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to. - */ - line?: number; - owner: string; - /** - * The relative path to the file that necessitates a comment. - */ - path: string; - /** - * **Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above. - */ - position?: number; - pull_number: number; - repo: string; - /** - * **Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. - */ - side?: "LEFT" | "RIGHT"; - /** - * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. - */ - start_line?: number; - /** - * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context. - */ - start_side?: "LEFT" | "RIGHT" | "side"; -}; -export type PullsCreateCommentParams = { - /** - * The text of the review comment. - */ - body: string; - /** - * The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`. - */ - commit_id: string; - /** - * **Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to. - */ - line?: number; - owner: string; - /** - * The relative path to the file that necessitates a comment. - */ - path: string; - /** - * **Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above. - */ - position?: number; - pull_number: number; - repo: string; - /** - * **Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. - */ - side?: "LEFT" | "RIGHT"; - /** - * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. - */ - start_line?: number; - /** - * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context. - */ - start_side?: "LEFT" | "RIGHT" | "side"; -}; -export type PullsCreateCommentReplyParamsDeprecatedNumber = { - /** - * The text of the review comment. - */ - body: string; - /** - * The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`. - */ - commit_id: string; - /** - * **Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to. - */ - line?: number; - /** - * @deprecated "number" parameter renamed to "pull_number" - */ - number: number; - owner: string; - /** - * The relative path to the file that necessitates a comment. - */ - path: string; - /** - * **Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above. - */ - position?: number; - repo: string; - /** - * **Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. - */ - side?: "LEFT" | "RIGHT"; - /** - * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. - */ - start_line?: number; - /** - * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context. - */ - start_side?: "LEFT" | "RIGHT" | "side"; -}; -export type PullsCreateCommentReplyParamsDeprecatedInReplyTo = { - /** - * The text of the review comment. - */ - body: string; - /** - * The SHA of the commit needing a comment. Not using the latest commit SHA may render your comment outdated if a subsequent commit modifies the line you specify as the `position`. - */ - commit_id: string; - /** - * The comment ID to reply to. **Note**: This must be the ID of a top-level comment, not a reply to that comment. Replies to replies are not supported. - * @deprecated "in_reply_to" parameter has been deprecated and will be removed in future - */ - in_reply_to?: number; + note?: string; +}; +export type ProjectsUpdateColumnParams = { + column_id: number; /** - * **Required with `comfort-fade` preview**. The line of the blob in the pull request diff that the comment applies to. For a multi-line comment, the last line of the range that your comment applies to. + * The new name of the column. */ - line?: number; + name: string; +}; +export type PullsCheckIfMergedParams = { owner: string; + pull_number: number; + repo: string; +}; +export type PullsCreateParams = { /** - * The relative path to the file that necessitates a comment. + * The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository. */ - path: string; + base: string; /** - * **Required without `comfort-fade` preview**. The position in the diff where you want to add a review comment. Note this value is not the same as the line number in the file. For help finding the position value, read the note above. + * The contents of the pull request. */ - position?: number; - pull_number: number; - repo: string; + body?: string; /** - * **Required with `comfort-fade` preview**. In a split diff view, the side of the diff that the pull request's changes appear on. Can be `LEFT` or `RIGHT`. Use `LEFT` for deletions that appear in red. Use `RIGHT` for additions that appear in green or unchanged lines that appear in white and are shown for context. For a multi-line comment, side represents whether the last line of the comment range is a deletion or addition. For more information, see "[Diff view options](https://help.github.com/en/articles/about-comparing-branches-in-pull-requests#diff-view-options)" in the GitHub Help documentation. + * Indicates whether the pull request is a draft. See "[Draft Pull Requests](https://help.github.com/en/articles/about-pull-requests#draft-pull-requests)" in the GitHub Help documentation to learn more. */ - side?: "LEFT" | "RIGHT"; + draft?: boolean; /** - * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_line` is the first line in the pull request diff that your multi-line comment applies to. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. + * The name of the branch where your changes are implemented. For cross-repository pull requests in the same network, namespace `head` with a user like this: `username:branch`. */ - start_line?: number; + head: string; /** - * **Required when using multi-line comments**. To create multi-line comments, you must use the `comfort-fade` preview header. The `start_side` is the starting side of the diff that the comment applies to. Can be `LEFT` or `RIGHT`. To learn more about multi-line comments, see "[Commenting on a pull request](https://help.github.com/en/articles/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)" in the GitHub Help documentation. See `side` in this table for additional context. + * Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. */ - start_side?: "LEFT" | "RIGHT" | "side"; + maintainer_can_modify?: boolean; + owner: string; + repo: string; + /** + * The title of the new pull request. + */ + title: string; }; -export type PullsCreateCommentReplyParams = { +export type PullsCreateCommentParams = { /** * The text of the review comment. */ @@ -27902,39 +23832,6 @@ export type PullsCreateCommentReplyParams = { */ start_side?: "LEFT" | "RIGHT" | "side"; }; -export type PullsCreateFromIssueParams = { - base: string; - draft?: boolean; - head: string; - issue: number; - maintainer_can_modify?: boolean; - owner: string; - repo: string; -}; -export type PullsCreateReviewParamsDeprecatedNumber = { - /** - * **Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review. - */ - body?: string; - /** - * Use the following table to specify the location, destination, and contents of the draft review comment. - */ - comments?: PullsCreateReviewParamsComments[]; - /** - * The SHA of the commit that needs a review. Not using the latest commit SHA may render your review comment outdated if a subsequent commit modifies the line you specify as the `position`. Defaults to the most recent commit in the pull request when you do not specify a value. - */ - commit_id?: string; - /** - * The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. By leaving this blank, you set the review action state to `PENDING`, which means you will need to [submit the pull request review](https://developer.github.com/v3/pulls/reviews/#submit-a-pull-request-review) when you are ready. - */ - event?: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; - /** - * @deprecated "number" parameter renamed to "pull_number" - */ - number: number; - owner: string; - repo: string; -}; export type PullsCreateReviewParams = { /** * **Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review. @@ -27966,22 +23863,6 @@ export type PullsCreateReviewCommentReplyParams = { pull_number: number; repo: string; }; -export type PullsCreateReviewRequestParamsDeprecatedNumber = { - /** - * @deprecated "number" parameter renamed to "pull_number" - */ - number: number; - owner: string; - repo: string; - /** - * An array of user `login`s that will be requested. - */ - reviewers?: string[]; - /** - * An array of team `slug`s that will be requested. - */ - team_reviewers?: string[]; -}; export type PullsCreateReviewRequestParams = { owner: string; pull_number: number; @@ -28000,37 +23881,12 @@ export type PullsDeleteCommentParams = { owner: string; repo: string; }; -export type PullsDeletePendingReviewParamsDeprecatedNumber = { - /** - * @deprecated "number" parameter renamed to "pull_number" - */ - number: number; - owner: string; - repo: string; - review_id: number; -}; export type PullsDeletePendingReviewParams = { owner: string; pull_number: number; repo: string; review_id: number; }; -export type PullsDeleteReviewRequestParamsDeprecatedNumber = { - /** - * @deprecated "number" parameter renamed to "pull_number" - */ - number: number; - owner: string; - repo: string; - /** - * An array of user `login`s that will be removed. - */ - reviewers?: string[]; - /** - * An array of team `slug`s that will be removed. - */ - team_reviewers?: string[]; -}; export type PullsDeleteReviewRequestParams = { owner: string; pull_number: number; @@ -28044,19 +23900,6 @@ export type PullsDeleteReviewRequestParams = { */ team_reviewers?: string[]; }; -export type PullsDismissReviewParamsDeprecatedNumber = { - /** - * The message for the pull request review dismissal - */ - message: string; - /** - * @deprecated "number" parameter renamed to "pull_number" - */ - number: number; - owner: string; - repo: string; - review_id: number; -}; export type PullsDismissReviewParams = { /** * The message for the pull request review dismissal @@ -28067,14 +23910,6 @@ export type PullsDismissReviewParams = { repo: string; review_id: number; }; -export type PullsGetParamsDeprecatedNumber = { - /** - * @deprecated "number" parameter renamed to "pull_number" - */ - number: number; - owner: string; - repo: string; -}; export type PullsGetParams = { owner: string; pull_number: number; @@ -28085,23 +23920,6 @@ export type PullsGetCommentParams = { owner: string; repo: string; }; -export type PullsGetCommentsForReviewParamsDeprecatedNumber = { - /** - * @deprecated "number" parameter renamed to "pull_number" - */ - number: number; - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - repo: string; - review_id: number; -}; export type PullsGetCommentsForReviewParams = { owner: string; /** @@ -28116,15 +23934,6 @@ export type PullsGetCommentsForReviewParams = { repo: string; review_id: number; }; -export type PullsGetReviewParamsDeprecatedNumber = { - /** - * @deprecated "number" parameter renamed to "pull_number" - */ - number: number; - owner: string; - repo: string; - review_id: number; -}; export type PullsGetReviewParams = { owner: string; pull_number: number; @@ -28163,34 +23972,6 @@ export type PullsListParams = { */ state?: "open" | "closed" | "all"; }; -export type PullsListCommentsParamsDeprecatedNumber = { - /** - * Can be either `asc` or `desc`. Ignored without `sort` parameter. - */ - direction?: "asc" | "desc"; - /** - * @deprecated "number" parameter renamed to "pull_number" - */ - number: number; - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - repo: string; - /** - * This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`. Only returns comments `updated` at or after this time. - */ - since?: string; - /** - * Can be either `created` or `updated` comments. - */ - sort?: "created" | "updated"; -}; export type PullsListCommentsParams = { /** * Can be either `asc` or `desc`. Ignored without `sort` parameter. @@ -28240,22 +24021,6 @@ export type PullsListCommentsForRepoParams = { */ sort?: "created" | "updated"; }; -export type PullsListCommitsParamsDeprecatedNumber = { - /** - * @deprecated "number" parameter renamed to "pull_number" - */ - number: number; - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - repo: string; -}; export type PullsListCommitsParams = { owner: string; /** @@ -28269,22 +24034,6 @@ export type PullsListCommitsParams = { pull_number: number; repo: string; }; -export type PullsListFilesParamsDeprecatedNumber = { - /** - * @deprecated "number" parameter renamed to "pull_number" - */ - number: number; - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - repo: string; -}; export type PullsListFilesParams = { owner: string; /** @@ -28298,22 +24047,6 @@ export type PullsListFilesParams = { pull_number: number; repo: string; }; -export type PullsListReviewRequestsParamsDeprecatedNumber = { - /** - * @deprecated "number" parameter renamed to "pull_number" - */ - number: number; - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - repo: string; -}; export type PullsListReviewRequestsParams = { owner: string; /** @@ -28327,22 +24060,6 @@ export type PullsListReviewRequestsParams = { pull_number: number; repo: string; }; -export type PullsListReviewsParamsDeprecatedNumber = { - /** - * @deprecated "number" parameter renamed to "pull_number" - */ - number: number; - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - repo: string; -}; export type PullsListReviewsParams = { owner: string; /** @@ -28356,30 +24073,6 @@ export type PullsListReviewsParams = { pull_number: number; repo: string; }; -export type PullsMergeParamsDeprecatedNumber = { - /** - * Extra detail to append to automatic commit message. - */ - commit_message?: string; - /** - * Title for the automatic commit message. - */ - commit_title?: string; - /** - * Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`. - */ - merge_method?: "merge" | "squash" | "rebase"; - /** - * @deprecated "number" parameter renamed to "pull_number" - */ - number: number; - owner: string; - repo: string; - /** - * SHA that pull request head must match to allow merge. - */ - sha?: string; -}; export type PullsMergeParams = { /** * Extra detail to append to automatic commit message. @@ -28401,23 +24094,6 @@ export type PullsMergeParams = { */ sha?: string; }; -export type PullsSubmitReviewParamsDeprecatedNumber = { - /** - * The body text of the pull request review - */ - body?: string; - /** - * The review action you want to perform. The review actions include: `APPROVE`, `REQUEST_CHANGES`, or `COMMENT`. When you leave this blank, the API returns _HTTP 422 (Unrecognizable entity)_ and sets the review action state to `PENDING`, which means you will need to re-submit the pull request review using a review action. - */ - event: "APPROVE" | "REQUEST_CHANGES" | "COMMENT"; - /** - * @deprecated "number" parameter renamed to "pull_number" - */ - number: number; - owner: string; - repo: string; - review_id: number; -}; export type PullsSubmitReviewParams = { /** * The body text of the pull request review @@ -28432,34 +24108,6 @@ export type PullsSubmitReviewParams = { repo: string; review_id: number; }; -export type PullsUpdateParamsDeprecatedNumber = { - /** - * The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository. - */ - base?: string; - /** - * The contents of the pull request. - */ - body?: string; - /** - * Indicates whether [maintainers can modify](https://help.github.com/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request. - */ - maintainer_can_modify?: boolean; - /** - * @deprecated "number" parameter renamed to "pull_number" - */ - number: number; - owner: string; - repo: string; - /** - * State of this Pull Request. Either `open` or `closed`. - */ - state?: "open" | "closed"; - /** - * The title of the pull request. - */ - title?: string; -}; export type PullsUpdateParams = { /** * The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository. @@ -28503,19 +24151,6 @@ export type PullsUpdateCommentParams = { owner: string; repo: string; }; -export type PullsUpdateReviewParamsDeprecatedNumber = { - /** - * The body text of the pull request review. - */ - body: string; - /** - * @deprecated "number" parameter renamed to "pull_number" - */ - number: number; - owner: string; - repo: string; - review_id: number; -}; export type PullsUpdateReviewParams = { /** * The body text of the pull request review. @@ -28543,26 +24178,6 @@ export type ReactionsCreateForCommitCommentParams = { owner: string; repo: string; }; -export type ReactionsCreateForIssueParamsDeprecatedNumber = { - /** - * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the issue. - */ - content: - | "+1" - | "-1" - | "laugh" - | "confused" - | "heart" - | "hooray" - | "rocket" - | "eyes"; - /** - * @deprecated "number" parameter renamed to "issue_number" - */ - number: number; - owner: string; - repo: string; -}; export type ReactionsCreateForIssueParams = { /** * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the issue. @@ -28614,39 +24229,6 @@ export type ReactionsCreateForPullRequestReviewCommentParams = { owner: string; repo: string; }; -export type ReactionsCreateForTeamDiscussionParams = { - /** - * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion. - */ - content: - | "+1" - | "-1" - | "laugh" - | "confused" - | "heart" - | "hooray" - | "rocket" - | "eyes"; - discussion_number: number; - team_id: number; -}; -export type ReactionsCreateForTeamDiscussionCommentParams = { - comment_number: number; - /** - * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion comment. - */ - content: - | "+1" - | "-1" - | "laugh" - | "confused" - | "heart" - | "hooray" - | "rocket" - | "eyes"; - discussion_number: number; - team_id: number; -}; export type ReactionsCreateForTeamDiscussionCommentInOrgParams = { comment_number: number; /** @@ -28665,23 +24247,6 @@ export type ReactionsCreateForTeamDiscussionCommentInOrgParams = { org: string; team_slug: string; }; -export type ReactionsCreateForTeamDiscussionCommentLegacyParams = { - comment_number: number; - /** - * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion comment. - */ - content: - | "+1" - | "-1" - | "laugh" - | "confused" - | "heart" - | "hooray" - | "rocket" - | "eyes"; - discussion_number: number; - team_id: number; -}; export type ReactionsCreateForTeamDiscussionInOrgParams = { /** * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion. @@ -28699,22 +24264,6 @@ export type ReactionsCreateForTeamDiscussionInOrgParams = { org: string; team_slug: string; }; -export type ReactionsCreateForTeamDiscussionLegacyParams = { - /** - * The [reaction type](https://developer.github.com/v3/reactions/#reaction-types) to add to the team discussion. - */ - content: - | "+1" - | "-1" - | "laugh" - | "confused" - | "heart" - | "hooray" - | "rocket" - | "eyes"; - discussion_number: number; - team_id: number; -}; export type ReactionsDeleteParams = { reaction_id: number; }; @@ -28743,34 +24292,6 @@ export type ReactionsListForCommitCommentParams = { per_page?: number; repo: string; }; -export type ReactionsListForIssueParamsDeprecatedNumber = { - /** - * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue. - */ - content?: - | "+1" - | "-1" - | "laugh" - | "confused" - | "heart" - | "hooray" - | "rocket" - | "eyes"; - /** - * @deprecated "number" parameter renamed to "issue_number" - */ - number: number; - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - repo: string; -}; export type ReactionsListForIssueParams = { /** * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue. @@ -28846,55 +24367,6 @@ export type ReactionsListForPullRequestReviewCommentParams = { per_page?: number; repo: string; }; -export type ReactionsListForTeamDiscussionParams = { - /** - * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion. - */ - content?: - | "+1" - | "-1" - | "laugh" - | "confused" - | "heart" - | "hooray" - | "rocket" - | "eyes"; - discussion_number: number; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - team_id: number; -}; -export type ReactionsListForTeamDiscussionCommentParams = { - comment_number: number; - /** - * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion comment. - */ - content?: - | "+1" - | "-1" - | "laugh" - | "confused" - | "heart" - | "hooray" - | "rocket" - | "eyes"; - discussion_number: number; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - team_id: number; -}; export type ReactionsListForTeamDiscussionCommentInOrgParams = { comment_number: number; /** @@ -28921,31 +24393,6 @@ export type ReactionsListForTeamDiscussionCommentInOrgParams = { per_page?: number; team_slug: string; }; -export type ReactionsListForTeamDiscussionCommentLegacyParams = { - comment_number: number; - /** - * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion comment. - */ - content?: - | "+1" - | "-1" - | "laugh" - | "confused" - | "heart" - | "hooray" - | "rocket" - | "eyes"; - discussion_number: number; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - team_id: number; -}; export type ReactionsListForTeamDiscussionInOrgParams = { /** * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion. @@ -28971,30 +24418,6 @@ export type ReactionsListForTeamDiscussionInOrgParams = { per_page?: number; team_slug: string; }; -export type ReactionsListForTeamDiscussionLegacyParams = { - /** - * Returns a single [reaction type](https://developer.github.com/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion. - */ - content?: - | "+1" - | "-1" - | "laugh" - | "confused" - | "heart" - | "hooray" - | "rocket" - | "eyes"; - discussion_number: number; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - team_id: number; -}; export type ReposAcceptInvitationParams = { invitation_id: number; }; @@ -29077,26 +24500,6 @@ export type ReposCompareCommitsParams = { owner: string; repo: string; }; -export type ReposCreateCommitCommentParamsDeprecatedSha = { - /** - * The contents of the comment. - */ - body: string; - owner: string; - /** - * Relative path of the file to comment on. - */ - path?: string; - /** - * Line index in the diff to comment on. - */ - position?: number; - repo: string; - /** - * @deprecated "sha" parameter renamed to "commit_sha" - */ - sha: string; -}; export type ReposCreateCommitCommentParamsDeprecatedLine = { /** * The contents of the comment. @@ -29234,35 +24637,6 @@ export type ReposCreateDispatchEventParams = { owner: string; repo: string; }; -export type ReposCreateFileParams = { - /** - * The author of the file. Default: The `committer` or the authenticated user if you omit `committer`. - */ - author?: ReposCreateFileParamsAuthor; - /** - * The branch name. Default: the repository’s default branch (usually `master`) - */ - branch?: string; - /** - * The person that committed the file. Default: the authenticated user. - */ - committer?: ReposCreateFileParamsCommitter; - /** - * The new file content, using Base64 encoding. - */ - content: string; - /** - * The commit message. - */ - message: string; - owner: string; - path: string; - repo: string; - /** - * **Required if you are updating a file**. The blob SHA of the file being replaced. - */ - sha?: string; -}; export type ReposCreateForAuthenticatedUserParams = { /** * Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits. @@ -29668,22 +25042,6 @@ export type ReposGetCombinedStatusForRefParams = { ref: string; repo: string; }; -export type ReposGetCommitParamsDeprecatedSha = { - owner: string; - repo: string; - /** - * @deprecated "sha" parameter renamed to "ref" - */ - sha: string; -}; -export type ReposGetCommitParamsDeprecatedCommitSha = { - /** - * @deprecated "commit_sha" parameter renamed to "ref" - */ - commit_sha: string; - owner: string; - repo: string; -}; export type ReposGetCommitParams = { owner: string; ref: string; @@ -29698,11 +25056,6 @@ export type ReposGetCommitCommentParams = { owner: string; repo: string; }; -export type ReposGetCommitRefShaParams = { - owner: string; - ref: string; - repo: string; -}; export type ReposGetContentsParams = { owner: string; path: string; @@ -29876,11 +25229,6 @@ export type ReposListParams = { */ visibility?: "all" | "public" | "private"; }; -export type ReposListAppsWithAccessToProtectedBranchParams = { - branch: string; - owner: string; - repo: string; -}; export type ReposListAssetsForReleaseParams = { owner: string; /** @@ -29934,22 +25282,6 @@ export type ReposListCollaboratorsParams = { per_page?: number; repo: string; }; -export type ReposListCommentsForCommitParamsDeprecatedRef = { - owner: string; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * @deprecated "ref" parameter renamed to "commit_sha" - */ - ref: string; - repo: string; -}; export type ReposListCommentsForCommitParams = { commit_sha: string; owner: string; @@ -30212,16 +25544,6 @@ export type ReposListProtectedBranchRequiredStatusChecksContextsParams = { owner: string; repo: string; }; -export type ReposListProtectedBranchTeamRestrictionsParams = { - branch: string; - owner: string; - repo: string; -}; -export type ReposListProtectedBranchUserRestrictionsParams = { - branch: string; - owner: string; - repo: string; -}; export type ReposListPublicParams = { /** * Page number of the results to fetch. @@ -30298,20 +25620,10 @@ export type ReposListTeamsParams = { per_page?: number; repo: string; }; -export type ReposListTeamsWithAccessToProtectedBranchParams = { - branch: string; - owner: string; - repo: string; -}; export type ReposListTopicsParams = { owner: string; repo: string; }; -export type ReposListUsersWithAccessToProtectedBranchParams = { - branch: string; - owner: string; - repo: string; -}; export type ReposMergeParams = { /** * The name of the base branch that the head will be merged into. @@ -30561,35 +25873,6 @@ export type ReposUpdateCommitCommentParams = { owner: string; repo: string; }; -export type ReposUpdateFileParams = { - /** - * The author of the file. Default: The `committer` or the authenticated user if you omit `committer`. - */ - author?: ReposUpdateFileParamsAuthor; - /** - * The branch name. Default: the repository’s default branch (usually `master`) - */ - branch?: string; - /** - * The person that committed the file. Default: the authenticated user. - */ - committer?: ReposUpdateFileParamsCommitter; - /** - * The new file content, using Base64 encoding. - */ - content: string; - /** - * The commit message. - */ - message: string; - owner: string; - path: string; - repo: string; - /** - * **Required if you are updating a file**. The blob SHA of the file being replaced. - */ - sha?: string; -}; export type ReposUpdateHookParams = { /** * Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications. @@ -30712,40 +25995,17 @@ export type ReposUpdateReleaseAssetParams = { owner: string; repo: string; }; -export type ReposUploadReleaseAssetParamsDeprecatedFile = { - /** - * @deprecated "file" parameter renamed to "data" - */ - file: string | object; - headers: ReposUploadReleaseAssetParamsHeaders; - /** - * An alternate short description of the asset. Used in place of the filename. This should be set in a URI query parameter. - */ - label?: string; - /** - * The file name of the asset. This should be set in a URI query parameter. - */ - name: string; - /** - * The `upload_url` key returned from creating or getting a release - */ - url: string; -}; export type ReposUploadReleaseAssetParams = { - data: string | object; - headers: ReposUploadReleaseAssetParamsHeaders; /** - * An alternate short description of the asset. Used in place of the filename. This should be set in a URI query parameter. + * The raw file data */ + data: string; + headers: ReposUploadReleaseAssetParamsHeaders; label?: string; - /** - * The file name of the asset. This should be set in a URI query parameter. - */ - name: string; - /** - * The `upload_url` key returned from creating or getting a release - */ - url: string; + name?: string; + owner: string; + release_id: number; + repo: string; }; export type SearchCodeParams = { /** @@ -30791,45 +26051,6 @@ export type SearchCommitsParams = { */ sort?: "author-date" | "committer-date"; }; -export type SearchEmailLegacyParams = { - /** - * The email address. - */ - email: string; -}; -export type SearchIssuesParams = { - /** - * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. - */ - order?: "desc" | "asc"; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). See "[Searching issues and pull requests](https://help.github.com/articles/searching-issues-and-pull-requests/)" for a detailed list of qualifiers. - */ - q: string; - /** - * Sorts the results of your query by the number of `comments`, `reactions`, `reactions-+1`, `reactions--1`, `reactions-smile`, `reactions-thinking_face`, `reactions-heart`, `reactions-tada`, or `interactions`. You can also sort results by how recently the items were `created` or `updated`, Default: [best match](https://developer.github.com/v3/search/#ranking-search-results) - */ - sort?: - | "comments" - | "reactions" - | "reactions-+1" - | "reactions--1" - | "reactions-smile" - | "reactions-thinking_face" - | "reactions-heart" - | "reactions-tada" - | "interactions" - | "created" - | "updated"; -}; export type SearchIssuesAndPullRequestsParams = { /** * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. @@ -30863,18 +26084,6 @@ export type SearchIssuesAndPullRequestsParams = { | "created" | "updated"; }; -export type SearchIssuesLegacyParams = { - /** - * The search term. - */ - keyword: string; - owner: string; - repository: string; - /** - * Indicates the state of the issues to return. Can be either `open` or `closed`. - */ - state: "open" | "closed"; -}; export type SearchLabelsParams = { /** * Determines whether the first search result returned is the highest number of matches (`desc`) or lowest number of matches (`asc`). This parameter is ignored unless you provide `sort`. @@ -30915,28 +26124,6 @@ export type SearchReposParams = { */ sort?: "stars" | "forks" | "help-wanted-issues" | "updated"; }; -export type SearchReposLegacyParams = { - /** - * The search term. - */ - keyword: string; - /** - * Filter results by language. - */ - language?: string; - /** - * The sort field. if `sort` param is provided. Can be either `asc` or `desc`. - */ - order?: "asc" | "desc"; - /** - * The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match. - */ - sort?: "stars" | "forks" | "updated"; - /** - * The page number to fetch. - */ - start_page?: string; -}; export type SearchTopicsParams = { /** * The query contains one or more search keywords and qualifiers. Qualifiers allow you to limit your search to specific areas of GitHub. The REST API supports the same qualifiers as GitHub.com. To learn more about the format of the query, see [Constructing a search query](https://developer.github.com/v3/search/#constructing-a-search-query). @@ -30965,42 +26152,6 @@ export type SearchUsersParams = { */ sort?: "followers" | "repositories" | "joined"; }; -export type SearchUsersLegacyParams = { - /** - * The search term. - */ - keyword: string; - /** - * The sort field. if `sort` param is provided. Can be either `asc` or `desc`. - */ - order?: "asc" | "desc"; - /** - * The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match. - */ - sort?: "stars" | "forks" | "updated"; - /** - * The page number to fetch. - */ - start_page?: string; -}; -export type TeamsAddMemberParams = { - team_id: number; - username: string; -}; -export type TeamsAddMemberLegacyParams = { - team_id: number; - username: string; -}; -export type TeamsAddOrUpdateMembershipParams = { - /** - * The role that this user should have in the team. Can be one of: - * \* `member` - a normal member of the team. - * \* `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description. - */ - role?: "member" | "maintainer"; - team_id: number; - username: string; -}; export type TeamsAddOrUpdateMembershipInOrgParams = { org: string; /** @@ -31012,28 +26163,6 @@ export type TeamsAddOrUpdateMembershipInOrgParams = { team_slug: string; username: string; }; -export type TeamsAddOrUpdateMembershipLegacyParams = { - /** - * The role that this user should have in the team. Can be one of: - * \* `member` - a normal member of the team. - * \* `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description. - */ - role?: "member" | "maintainer"; - team_id: number; - username: string; -}; -export type TeamsAddOrUpdateProjectParams = { - /** - * The permission to grant to the team for this project. Can be one of: - * \* `read` - team members can read, but not write to or administer this project. - * \* `write` - team members can read and write, but not administer this project. - * \* `admin` - team members can read, write and administer this project. - * Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://developer.github.com/v3/#http-verbs)." - */ - permission?: "read" | "write" | "admin"; - project_id: number; - team_id: number; -}; export type TeamsAddOrUpdateProjectInOrgParams = { org: string; /** @@ -31047,32 +26176,6 @@ export type TeamsAddOrUpdateProjectInOrgParams = { project_id: number; team_slug: string; }; -export type TeamsAddOrUpdateProjectLegacyParams = { - /** - * The permission to grant to the team for this project. Can be one of: - * \* `read` - team members can read, but not write to or administer this project. - * \* `write` - team members can read and write, but not administer this project. - * \* `admin` - team members can read, write and administer this project. - * Default: the team's `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://developer.github.com/v3/#http-verbs)." - */ - permission?: "read" | "write" | "admin"; - project_id: number; - team_id: number; -}; -export type TeamsAddOrUpdateRepoParams = { - owner: string; - /** - * The permission to grant the team on this repository. Can be one of: - * \* `pull` - team members can pull, but not push to or administer this repository. - * \* `push` - team members can pull and push, but not administer this repository. - * \* `admin` - team members can pull, push and administer this repository. - * - * If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. - */ - permission?: "pull" | "push" | "admin"; - repo: string; - team_id: number; -}; export type TeamsAddOrUpdateRepoInOrgParams = { org: string; owner: string; @@ -31088,36 +26191,12 @@ export type TeamsAddOrUpdateRepoInOrgParams = { repo: string; team_slug: string; }; -export type TeamsAddOrUpdateRepoLegacyParams = { - owner: string; - /** - * The permission to grant the team on this repository. Can be one of: - * \* `pull` - team members can pull, but not push to or administer this repository. - * \* `push` - team members can pull and push, but not administer this repository. - * \* `admin` - team members can pull, push and administer this repository. - * - * If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository. - */ - permission?: "pull" | "push" | "admin"; - repo: string; - team_id: number; -}; -export type TeamsCheckManagesRepoParams = { - owner: string; - repo: string; - team_id: number; -}; export type TeamsCheckManagesRepoInOrgParams = { org: string; owner: string; repo: string; team_slug: string; }; -export type TeamsCheckManagesRepoLegacyParams = { - owner: string; - repo: string; - team_id: number; -}; export type TeamsCreateParamsDeprecatedPermission = { /** * The description of the team. @@ -31194,29 +26273,6 @@ export type TeamsCreateParams = { */ repo_names?: string[]; }; -export type TeamsCreateDiscussionParams = { - /** - * The discussion post's body text. - */ - body: string; - /** - * Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. - */ - private?: boolean; - team_id: number; - /** - * The discussion post's title. - */ - title: string; -}; -export type TeamsCreateDiscussionCommentParams = { - /** - * The discussion comment's body text. - */ - body: string; - discussion_number: number; - team_id: number; -}; export type TeamsCreateDiscussionCommentInOrgParams = { /** * The discussion comment's body text. @@ -31226,14 +26282,6 @@ export type TeamsCreateDiscussionCommentInOrgParams = { org: string; team_slug: string; }; -export type TeamsCreateDiscussionCommentLegacyParams = { - /** - * The discussion comment's body text. - */ - body: string; - discussion_number: number; - team_id: number; -}; export type TeamsCreateDiscussionInOrgParams = { /** * The discussion post's body text. @@ -31250,120 +26298,41 @@ export type TeamsCreateDiscussionInOrgParams = { */ title: string; }; -export type TeamsCreateDiscussionLegacyParams = { - /** - * The discussion post's body text. - */ - body: string; - /** - * Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post. - */ - private?: boolean; - team_id: number; - /** - * The discussion post's title. - */ - title: string; -}; -export type TeamsDeleteParams = { - team_id: number; -}; -export type TeamsDeleteDiscussionParams = { - discussion_number: number; - team_id: number; -}; -export type TeamsDeleteDiscussionCommentParams = { - comment_number: number; - discussion_number: number; - team_id: number; -}; export type TeamsDeleteDiscussionCommentInOrgParams = { comment_number: number; discussion_number: number; org: string; team_slug: string; }; -export type TeamsDeleteDiscussionCommentLegacyParams = { - comment_number: number; - discussion_number: number; - team_id: number; -}; export type TeamsDeleteDiscussionInOrgParams = { discussion_number: number; org: string; team_slug: string; }; -export type TeamsDeleteDiscussionLegacyParams = { - discussion_number: number; - team_id: number; -}; export type TeamsDeleteInOrgParams = { org: string; team_slug: string; }; -export type TeamsDeleteLegacyParams = { - team_id: number; -}; -export type TeamsGetParams = { - team_id: number; -}; export type TeamsGetByNameParams = { org: string; team_slug: string; }; -export type TeamsGetDiscussionParams = { - discussion_number: number; - team_id: number; -}; -export type TeamsGetDiscussionCommentParams = { - comment_number: number; - discussion_number: number; - team_id: number; -}; export type TeamsGetDiscussionCommentInOrgParams = { comment_number: number; discussion_number: number; org: string; team_slug: string; }; -export type TeamsGetDiscussionCommentLegacyParams = { - comment_number: number; - discussion_number: number; - team_id: number; -}; export type TeamsGetDiscussionInOrgParams = { discussion_number: number; org: string; team_slug: string; }; -export type TeamsGetDiscussionLegacyParams = { - discussion_number: number; - team_id: number; -}; -export type TeamsGetLegacyParams = { - team_id: number; -}; -export type TeamsGetMemberParams = { - team_id: number; - username: string; -}; -export type TeamsGetMemberLegacyParams = { - team_id: number; - username: string; -}; -export type TeamsGetMembershipParams = { - team_id: number; - username: string; -}; export type TeamsGetMembershipInOrgParams = { org: string; team_slug: string; username: string; }; -export type TeamsGetMembershipLegacyParams = { - team_id: number; - username: string; -}; export type TeamsListParams = { org: string; /** @@ -31375,17 +26344,6 @@ export type TeamsListParams = { */ per_page?: number; }; -export type TeamsListChildParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - team_id: number; -}; export type TeamsListChildInOrgParams = { org: string; /** @@ -31398,33 +26356,6 @@ export type TeamsListChildInOrgParams = { per_page?: number; team_slug: string; }; -export type TeamsListChildLegacyParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - team_id: number; -}; -export type TeamsListDiscussionCommentsParams = { - /** - * Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`. - */ - direction?: "asc" | "desc"; - discussion_number: number; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - team_id: number; -}; export type TeamsListDiscussionCommentsInOrgParams = { /** * Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`. @@ -31442,37 +26373,6 @@ export type TeamsListDiscussionCommentsInOrgParams = { per_page?: number; team_slug: string; }; -export type TeamsListDiscussionCommentsLegacyParams = { - /** - * Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`. - */ - direction?: "asc" | "desc"; - discussion_number: number; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - team_id: number; -}; -export type TeamsListDiscussionsParams = { - /** - * Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`. - */ - direction?: "asc" | "desc"; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - team_id: number; -}; export type TeamsListDiscussionsInOrgParams = { /** * Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`. @@ -31489,21 +26389,6 @@ export type TeamsListDiscussionsInOrgParams = { per_page?: number; team_slug: string; }; -export type TeamsListDiscussionsLegacyParams = { - /** - * Sorts the discussion comments by the date they were created. To return the oldest comments first, set to `asc`. Can be one of `asc` or `desc`. - */ - direction?: "asc" | "desc"; - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - team_id: number; -}; export type TeamsListForAuthenticatedUserParams = { /** * Page number of the results to fetch. @@ -31514,24 +26399,6 @@ export type TeamsListForAuthenticatedUserParams = { */ per_page?: number; }; -export type TeamsListMembersParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Filters members returned by their role in the team. Can be one of: - * \* `member` - normal members of the team. - * \* `maintainer` - team maintainers. - * \* `all` - all members of the team. - */ - role?: "member" | "maintainer" | "all"; - team_id: number; -}; export type TeamsListMembersInOrgParams = { org: string; /** @@ -31551,35 +26418,6 @@ export type TeamsListMembersInOrgParams = { role?: "member" | "maintainer" | "all"; team_slug: string; }; -export type TeamsListMembersLegacyParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - /** - * Filters members returned by their role in the team. Can be one of: - * \* `member` - normal members of the team. - * \* `maintainer` - team maintainers. - * \* `all` - all members of the team. - */ - role?: "member" | "maintainer" | "all"; - team_id: number; -}; -export type TeamsListPendingInvitationsParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - team_id: number; -}; export type TeamsListPendingInvitationsInOrgParams = { org: string; /** @@ -31592,28 +26430,6 @@ export type TeamsListPendingInvitationsInOrgParams = { per_page?: number; team_slug: string; }; -export type TeamsListPendingInvitationsLegacyParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - team_id: number; -}; -export type TeamsListProjectsParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - team_id: number; -}; export type TeamsListProjectsInOrgParams = { org: string; /** @@ -31626,28 +26442,6 @@ export type TeamsListProjectsInOrgParams = { per_page?: number; team_slug: string; }; -export type TeamsListProjectsLegacyParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - team_id: number; -}; -export type TeamsListReposParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - team_id: number; -}; export type TeamsListReposInOrgParams = { org: string; /** @@ -31660,157 +26454,27 @@ export type TeamsListReposInOrgParams = { per_page?: number; team_slug: string; }; -export type TeamsListReposLegacyParams = { - /** - * Page number of the results to fetch. - */ - page?: number; - /** - * Results per page (max 100) - */ - per_page?: number; - team_id: number; -}; -export type TeamsRemoveMemberParams = { - team_id: number; - username: string; -}; -export type TeamsRemoveMemberLegacyParams = { - team_id: number; - username: string; -}; -export type TeamsRemoveMembershipParams = { - team_id: number; - username: string; -}; export type TeamsRemoveMembershipInOrgParams = { org: string; team_slug: string; username: string; }; -export type TeamsRemoveMembershipLegacyParams = { - team_id: number; - username: string; -}; -export type TeamsRemoveProjectParams = { - project_id: number; - team_id: number; -}; export type TeamsRemoveProjectInOrgParams = { org: string; project_id: number; team_slug: string; }; -export type TeamsRemoveProjectLegacyParams = { - project_id: number; - team_id: number; -}; -export type TeamsRemoveRepoParams = { - owner: string; - repo: string; - team_id: number; -}; export type TeamsRemoveRepoInOrgParams = { org: string; owner: string; repo: string; team_slug: string; }; -export type TeamsRemoveRepoLegacyParams = { - owner: string; - repo: string; - team_id: number; -}; -export type TeamsReviewProjectParams = { - project_id: number; - team_id: number; -}; export type TeamsReviewProjectInOrgParams = { org: string; project_id: number; team_slug: string; }; -export type TeamsReviewProjectLegacyParams = { - project_id: number; - team_id: number; -}; -export type TeamsUpdateParamsDeprecatedPermission = { - /** - * The description of the team. - */ - description?: string; - /** - * The name of the team. - */ - name: string; - /** - * The ID of a team to set as the parent team. - */ - parent_team_id?: number; - /** - * **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: - * \* `pull` - team members can pull, but not push to or administer newly-added repositories. - * \* `push` - team members can pull and push, but not administer newly-added repositories. - * \* `admin` - team members can pull, push and administer newly-added repositories. - * @deprecated "permission" parameter has been deprecated and will be removed in future - */ - permission?: string; - /** - * The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: - * **For a non-nested team:** - * \* `secret` - only visible to organization owners and members of this team. - * \* `closed` - visible to all members of this organization. - * **For a parent or child team:** - * \* `closed` - visible to all members of this organization. - */ - privacy?: "secret" | "closed"; - team_id: number; -}; -export type TeamsUpdateParams = { - /** - * The description of the team. - */ - description?: string; - /** - * The name of the team. - */ - name: string; - /** - * The ID of a team to set as the parent team. - */ - parent_team_id?: number; - /** - * The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: - * **For a non-nested team:** - * \* `secret` - only visible to organization owners and members of this team. - * \* `closed` - visible to all members of this organization. - * **For a parent or child team:** - * \* `closed` - visible to all members of this organization. - */ - privacy?: "secret" | "closed"; - team_id: number; -}; -export type TeamsUpdateDiscussionParams = { - /** - * The discussion post's body text. - */ - body?: string; - discussion_number: number; - team_id: number; - /** - * The discussion post's title. - */ - title?: string; -}; -export type TeamsUpdateDiscussionCommentParams = { - /** - * The discussion comment's body text. - */ - body: string; - comment_number: number; - discussion_number: number; - team_id: number; -}; export type TeamsUpdateDiscussionCommentInOrgParams = { /** * The discussion comment's body text. @@ -31821,15 +26485,6 @@ export type TeamsUpdateDiscussionCommentInOrgParams = { org: string; team_slug: string; }; -export type TeamsUpdateDiscussionCommentLegacyParams = { - /** - * The discussion comment's body text. - */ - body: string; - comment_number: number; - discussion_number: number; - team_id: number; -}; export type TeamsUpdateDiscussionInOrgParams = { /** * The discussion post's body text. @@ -31843,18 +26498,6 @@ export type TeamsUpdateDiscussionInOrgParams = { */ title?: string; }; -export type TeamsUpdateDiscussionLegacyParams = { - /** - * The discussion post's body text. - */ - body?: string; - discussion_number: number; - team_id: number; - /** - * The discussion post's title. - */ - title?: string; -}; export type TeamsUpdateInOrgParamsDeprecatedPermission = { /** * The description of the team. @@ -31913,62 +26556,6 @@ export type TeamsUpdateInOrgParams = { privacy?: "secret" | "closed"; team_slug: string; }; -export type TeamsUpdateLegacyParamsDeprecatedPermission = { - /** - * The description of the team. - */ - description?: string; - /** - * The name of the team. - */ - name: string; - /** - * The ID of a team to set as the parent team. - */ - parent_team_id?: number; - /** - * **Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: - * \* `pull` - team members can pull, but not push to or administer newly-added repositories. - * \* `push` - team members can pull and push, but not administer newly-added repositories. - * \* `admin` - team members can pull, push and administer newly-added repositories. - * @deprecated "permission" parameter has been deprecated and will be removed in future - */ - permission?: string; - /** - * The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: - * **For a non-nested team:** - * \* `secret` - only visible to organization owners and members of this team. - * \* `closed` - visible to all members of this organization. - * **For a parent or child team:** - * \* `closed` - visible to all members of this organization. - */ - privacy?: "secret" | "closed"; - team_id: number; -}; -export type TeamsUpdateLegacyParams = { - /** - * The description of the team. - */ - description?: string; - /** - * The name of the team. - */ - name: string; - /** - * The ID of a team to set as the parent team. - */ - parent_team_id?: number; - /** - * The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: - * **For a non-nested team:** - * \* `secret` - only visible to organization owners and members of this team. - * \* `closed` - visible to all members of this organization. - * **For a parent or child team:** - * \* `closed` - visible to all members of this organization. - */ - privacy?: "secret" | "closed"; - team_id: number; -}; export type UsersAddEmailsParams = { /** * Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key. @@ -32527,26 +27114,6 @@ export type PullsCreateReviewParamsComments = { position: number; }; export type ReposCreateDispatchEventParamsClientPayload = {}; -export type ReposCreateFileParamsAuthor = { - /** - * The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted. - */ - email: string; - /** - * The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted. - */ - name: string; -}; -export type ReposCreateFileParamsCommitter = { - /** - * The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted. - */ - email: string; - /** - * The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted. - */ - name: string; -}; export type ReposCreateHookParamsConfig = { /** * The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`. @@ -32667,26 +27234,6 @@ export type ReposUpdateBranchProtectionParamsRestrictions = { */ users: string[]; }; -export type ReposUpdateFileParamsAuthor = { - /** - * The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted. - */ - email: string; - /** - * The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted. - */ - name: string; -}; -export type ReposUpdateFileParamsCommitter = { - /** - * The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted. - */ - email: string; - /** - * The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted. - */ - name: string; -}; export type ReposUpdateHookParamsConfig = { /** * The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`. @@ -32716,7 +27263,6 @@ export type ReposUpdateProtectedBranchPullRequestReviewEnforcementParamsDismissa users?: string[]; }; export type ReposUploadReleaseAssetParamsHeaders = { - "content-length": number; "content-type": string; }; @@ -33403,19 +27949,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * **Deprecation Notice:** GitHub will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. - * @deprecated octokit.apps.checkAuthorization() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#check-an-authorization - */ - checkAuthorization: { - (params?: RequestParameters & AppsCheckAuthorizationParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; /** * OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) to use this endpoint, where the username is the OAuth application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`. */ @@ -33500,45 +28033,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * Enables an authenticated GitHub App to find the organization's installation information. - * - * You must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - * @deprecated octokit.apps.findOrgInstallation() has been renamed to octokit.apps.getOrgInstallation() (2019-04-10) - */ - findOrgInstallation: { - (params?: RequestParameters & AppsFindOrgInstallationParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; - /** - * Enables an authenticated GitHub App to find the repository's installation information. The installation's account type will be either an organization or a user account, depending which account the repository belongs to. - * - * You must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - * @deprecated octokit.apps.findRepoInstallation() has been renamed to octokit.apps.getRepoInstallation() (2019-04-10) - */ - findRepoInstallation: { - (params?: RequestParameters & AppsFindRepoInstallationParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; - /** - * Enables an authenticated GitHub App to find the user’s installation information. - * - * You must use a [JWT](https://developer.github.com/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint. - * @deprecated octokit.apps.findUserInstallation() has been renamed to octokit.apps.getUserInstallation() (2019-04-10) - */ - findUserInstallation: { - (params?: RequestParameters & AppsFindUserInstallationParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; /** * Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the "[List installations](https://developer.github.com/v3/apps/#list-installations)" endpoint. * @@ -33760,19 +28254,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * **Deprecation Notice:** GitHub will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. - * @deprecated octokit.apps.resetAuthorization() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#reset-an-authorization - */ - resetAuthorization: { - (params?: RequestParameters & AppsResetAuthorizationParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; /** * OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. */ @@ -33783,34 +28264,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * **Deprecation Notice:** GitHub will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * OAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. - * @deprecated octokit.apps.revokeAuthorizationForApplication() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#revoke-an-authorization-for-an-application - */ - revokeAuthorizationForApplication: { - ( - params?: RequestParameters & AppsRevokeAuthorizationForApplicationParams - ): Promise; - - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** GitHub will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid token as `:access_token` and the grant for the token's owner will be deleted. - * - * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the Applications settings page under "Authorized OAuth Apps" on GitHub](https://github.com/settings/applications#authorized). - * @deprecated octokit.apps.revokeGrantForApplication() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#revoke-a-grant-for-an-application - */ - revokeGrantForApplication: { - ( - params?: RequestParameters & AppsRevokeGrantForApplicationParams - ): Promise; - - endpoint: EndpointInterface; - }; /** * Revokes the installation token you're using to authenticate as an installation and access this endpoint. * @@ -34390,14 +28843,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * Returns an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just `heads` and `tags`. If there are no references to list, a `404` is returned. - */ - listRefs: { - (params?: RequestParameters & GitListRefsParams): Promise; - - endpoint: EndpointInterface; - }; updateRef: { (params?: RequestParameters & GitUpdateRefParams): Promise< @@ -34506,9 +28951,6 @@ export type RestEndpointMethods = { * This example adds two assignees to the existing `octocat` assignee. */ addAssignees: { - ( - params?: RequestParameters & IssuesAddAssigneesParamsDeprecatedNumber - ): Promise>; (params?: RequestParameters & IssuesAddAssigneesParams): Promise< OctokitResponse >; @@ -34517,9 +28959,6 @@ export type RestEndpointMethods = { }; addLabels: { - ( - params?: RequestParameters & IssuesAddLabelsParamsDeprecatedNumber - ): Promise>; (params?: RequestParameters & IssuesAddLabelsParams): Promise< OctokitResponse >; @@ -34559,9 +28998,6 @@ export type RestEndpointMethods = { * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. */ createComment: { - ( - params?: RequestParameters & IssuesCreateCommentParamsDeprecatedNumber - ): Promise>; (params?: RequestParameters & IssuesCreateCommentParams): Promise< OctokitResponse >; @@ -34602,9 +29038,6 @@ export type RestEndpointMethods = { }; deleteMilestone: { - ( - params?: RequestParameters & IssuesDeleteMilestoneParamsDeprecatedNumber - ): Promise; (params?: RequestParameters & IssuesDeleteMilestoneParams): Promise< AnyResponse >; @@ -34619,9 +29052,6 @@ export type RestEndpointMethods = { * Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://developer.github.com/v3/pulls/#list-pull-requests)" endpoint. */ get: { - (params?: RequestParameters & IssuesGetParamsDeprecatedNumber): Promise< - OctokitResponse - >; (params?: RequestParameters & IssuesGetParams): Promise< OctokitResponse >; @@ -34654,9 +29084,6 @@ export type RestEndpointMethods = { }; getMilestone: { - ( - params?: RequestParameters & IssuesGetMilestoneParamsDeprecatedNumber - ): Promise>; (params?: RequestParameters & IssuesGetMilestoneParams): Promise< OctokitResponse >; @@ -34689,9 +29116,6 @@ export type RestEndpointMethods = { * Issue Comments are ordered by ascending ID. */ listComments: { - ( - params?: RequestParameters & IssuesListCommentsParamsDeprecatedNumber - ): Promise>; (params?: RequestParameters & IssuesListCommentsParams): Promise< OctokitResponse >; @@ -34710,9 +29134,6 @@ export type RestEndpointMethods = { }; listEvents: { - ( - params?: RequestParameters & IssuesListEventsParamsDeprecatedNumber - ): Promise>; (params?: RequestParameters & IssuesListEventsParams): Promise< OctokitResponse >; @@ -34729,10 +29150,6 @@ export type RestEndpointMethods = { }; listEventsForTimeline: { - ( - params?: RequestParameters & - IssuesListEventsForTimelineParamsDeprecatedNumber - ): Promise>; (params?: RequestParameters & IssuesListEventsForTimelineParams): Promise< OctokitResponse >; @@ -34777,10 +29194,6 @@ export type RestEndpointMethods = { }; listLabelsForMilestone: { - ( - params?: RequestParameters & - IssuesListLabelsForMilestoneParamsDeprecatedNumber - ): Promise>; ( params?: RequestParameters & IssuesListLabelsForMilestoneParams ): Promise>; @@ -34797,10 +29210,6 @@ export type RestEndpointMethods = { }; listLabelsOnIssue: { - ( - params?: RequestParameters & - IssuesListLabelsOnIssueParamsDeprecatedNumber - ): Promise>; (params?: RequestParameters & IssuesListLabelsOnIssueParams): Promise< OctokitResponse >; @@ -34821,9 +29230,6 @@ export type RestEndpointMethods = { * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://developer.github.com/v3/#http-verbs)." */ lock: { - (params?: RequestParameters & IssuesLockParamsDeprecatedNumber): Promise< - AnyResponse - >; (params?: RequestParameters & IssuesLockParams): Promise; endpoint: EndpointInterface; @@ -34834,9 +29240,6 @@ export type RestEndpointMethods = { * This example removes two of three assignees, leaving the `octocat` assignee. */ removeAssignees: { - ( - params?: RequestParameters & IssuesRemoveAssigneesParamsDeprecatedNumber - ): Promise>; (params?: RequestParameters & IssuesRemoveAssigneesParams): Promise< OctokitResponse >; @@ -34847,9 +29250,6 @@ export type RestEndpointMethods = { * Removes the specified label from the issue, and returns the remaining labels on the issue. This endpoint returns a `404 Not Found` status if the label does not exist. */ removeLabel: { - ( - params?: RequestParameters & IssuesRemoveLabelParamsDeprecatedNumber - ): Promise>; (params?: RequestParameters & IssuesRemoveLabelParams): Promise< OctokitResponse >; @@ -34858,9 +29258,6 @@ export type RestEndpointMethods = { }; removeLabels: { - ( - params?: RequestParameters & IssuesRemoveLabelsParamsDeprecatedNumber - ): Promise; (params?: RequestParameters & IssuesRemoveLabelsParams): Promise< AnyResponse >; @@ -34869,9 +29266,6 @@ export type RestEndpointMethods = { }; replaceLabels: { - ( - params?: RequestParameters & IssuesReplaceLabelsParamsDeprecatedNumber - ): Promise>; (params?: RequestParameters & IssuesReplaceLabelsParams): Promise< OctokitResponse >; @@ -34882,9 +29276,6 @@ export type RestEndpointMethods = { * Users with push access can unlock an issue's conversation. */ unlock: { - ( - params?: RequestParameters & IssuesUnlockParamsDeprecatedNumber - ): Promise; (params?: RequestParameters & IssuesUnlockParams): Promise; endpoint: EndpointInterface; @@ -34893,9 +29284,6 @@ export type RestEndpointMethods = { * Issue owners and users with push access can edit an issue. */ update: { - ( - params?: RequestParameters & IssuesUpdateParamsDeprecatedNumber - ): Promise>; ( params?: RequestParameters & IssuesUpdateParamsDeprecatedAssignee ): Promise>; @@ -34923,9 +29311,6 @@ export type RestEndpointMethods = { }; updateMilestone: { - ( - params?: RequestParameters & IssuesUpdateMilestoneParamsDeprecatedNumber - ): Promise>; (params?: RequestParameters & IssuesUpdateMilestoneParams): Promise< OctokitResponse >; @@ -34953,16 +29338,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * @deprecated octokit.licenses.list() has been renamed to octokit.licenses.listCommonlyUsed() (2019-03-05) - */ - list: { - (params?: RequestParameters & EmptyParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; listCommonlyUsed: { (params?: RequestParameters & EmptyParams): Promise< @@ -35074,19 +29449,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * Fetches the URL to a migration archive. - * - * - * @deprecated octokit.migrations.getArchiveForOrg() has been renamed to octokit.migrations.downloadArchiveForOrg() (2020-01-27) - */ - getArchiveForOrg: { - (params?: RequestParameters & MigrationsGetArchiveForOrgParams): Promise< - AnyResponse - >; - - endpoint: EndpointInterface; - }; /** * Each type of source control system represents authors in a different way. For example, a Git commit author has a display name and an email address, but a Subversion commit author just has a username. The GitHub Importer will make the author information valid, but the author might not be correct. For example, it will change the bare Subversion username `hubot` into something like `hubot `. * @@ -35317,251 +29679,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; }; - oauthAuthorizations: { - /** - * **Deprecation Notice:** GitHub will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * OAuth applications can use a special API method for checking OAuth token validity without exceeding the normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. - * @deprecated octokit.oauthAuthorizations.checkAuthorization() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#check-an-authorization - */ - checkAuthorization: { - ( - params?: RequestParameters & OauthAuthorizationsCheckAuthorizationParams - ): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * **Warning:** Apps must use the [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * Creates OAuth tokens using [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication). If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://developer.github.com/v3/auth/#working-with-two-factor-authentication)." - * - * To create tokens for a particular OAuth application using this endpoint, you must authenticate as the user you want to create an authorization for and provide the app's client ID and secret, found on your OAuth application's settings page. If your OAuth application intends to create multiple tokens for one user, use `fingerprint` to differentiate between them. - * - * You can also create tokens on GitHub from the [personal access tokens settings](https://github.com/settings/tokens) page. Read more about these tokens in [the GitHub Help documentation](https://help.github.com/articles/creating-an-access-token-for-command-line-use). - * - * Organizations that enforce SAML SSO require personal access tokens to be whitelisted. Read more about whitelisting tokens in [the GitHub Help documentation](https://help.github.com/articles/about-identity-and-access-management-with-saml-single-sign-on). - * @deprecated octokit.oauthAuthorizations.createAuthorization() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization - */ - createAuthorization: { - ( - params?: RequestParameters & - OauthAuthorizationsCreateAuthorizationParams - ): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * @deprecated octokit.oauthAuthorizations.deleteAuthorization() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#delete-an-authorization - */ - deleteAuthorization: { - ( - params?: RequestParameters & - OauthAuthorizationsDeleteAuthorizationParams - ): Promise; - - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for your user. Once deleted, the application has no access to your account and is no longer listed on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). - * @deprecated octokit.oauthAuthorizations.deleteGrant() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#delete-a-grant - */ - deleteGrant: { - ( - params?: RequestParameters & OauthAuthorizationsDeleteGrantParams - ): Promise; - - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * @deprecated octokit.oauthAuthorizations.getAuthorization() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#get-a-single-authorization - */ - getAuthorization: { - ( - params?: RequestParameters & OauthAuthorizationsGetAuthorizationParams - ): Promise>; - - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * @deprecated octokit.oauthAuthorizations.getGrant() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#get-a-single-grant - */ - getGrant: { - (params?: RequestParameters & OauthAuthorizationsGetGrantParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * **Warning:** Apps must use the [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * Creates a new authorization for the specified OAuth application, only if an authorization for that application doesn't already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. - * - * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://developer.github.com/v3/auth/#working-with-two-factor-authentication)." - * - * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * @deprecated octokit.oauthAuthorizations.getOrCreateAuthorizationForApp() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app - */ - getOrCreateAuthorizationForApp: { - ( - params?: RequestParameters & - OauthAuthorizationsGetOrCreateAuthorizationForAppParams - ): Promise< - OctokitResponse< - OauthAuthorizationsGetOrCreateAuthorizationForAppResponse - > - >; - - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * **Warning:** Apps must use the [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. - * - * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://developer.github.com/v3/auth/#working-with-two-factor-authentication)." - * @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 - */ - getOrCreateAuthorizationForAppAndFingerprint: { - ( - params?: RequestParameters & - OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintParams - ): Promise< - OctokitResponse< - OauthAuthorizationsGetOrCreateAuthorizationForAppAndFingerprintResponse - > - >; - - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * **Warning:** Apps must use the [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow) to obtain OAuth tokens that work with GitHub SAML organizations. OAuth tokens created using the Authorizations API will be unable to access GitHub SAML organizations. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * This method will create a new authorization for the specified OAuth application, only if an authorization for that application and fingerprint do not already exist for the user. The URL includes the 20 character client ID for the OAuth app that is requesting the token. `fingerprint` is a unique string to distinguish an authorization from others created for the same client ID and user. It returns the user's existing authorization for the application if one is present. Otherwise, it creates and returns a new one. - * - * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://developer.github.com/v3/auth/#working-with-two-factor-authentication)." - * @deprecated octokit.oauthAuthorizations.getOrCreateAuthorizationForAppFingerprint() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint - */ - getOrCreateAuthorizationForAppFingerprint: { - ( - params?: RequestParameters & - OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintParams - ): Promise< - OctokitResponse< - OauthAuthorizationsGetOrCreateAuthorizationForAppFingerprintResponse - > - >; - - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * @deprecated octokit.oauthAuthorizations.listAuthorizations() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#list-your-authorizations - */ - listAuthorizations: { - ( - params?: RequestParameters & OauthAuthorizationsListAuthorizationsParams - ): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * You can use this API to list the set of OAuth applications that have been granted access to your account. Unlike the [list your authorizations](https://developer.github.com/v3/oauth_authorizations/#list-your-authorizations) API, this API does not manage individual tokens. This API will return one entry for each OAuth application that has been granted access to your account, regardless of the number of tokens an application has generated for your user. The list of OAuth applications returned matches what is shown on [the application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized). The `scopes` returned are the union of scopes authorized for the application. For example, if an application has one token with `repo` scope and another token with `user` scope, the grant will return `["repo", "user"]`. - * @deprecated octokit.oauthAuthorizations.listGrants() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#list-your-grants - */ - listGrants: { - ( - params?: RequestParameters & OauthAuthorizationsListGrantsParams - ): Promise>; - - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** GitHub will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * OAuth applications can use this API method to reset a valid OAuth token without end-user involvement. Applications must save the "token" property in the response because changes take effect immediately. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. Invalid tokens will return `404 NOT FOUND`. - * @deprecated octokit.oauthAuthorizations.resetAuthorization() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#reset-an-authorization - */ - resetAuthorization: { - ( - params?: RequestParameters & OauthAuthorizationsResetAuthorizationParams - ): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** GitHub will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * OAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. - * @deprecated octokit.oauthAuthorizations.revokeAuthorizationForApplication() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#revoke-an-authorization-for-an-application - */ - revokeAuthorizationForApplication: { - ( - params?: RequestParameters & - OauthAuthorizationsRevokeAuthorizationForApplicationParams - ): Promise; - - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** GitHub will replace and discontinue OAuth endpoints containing `access_token` in the path parameter. We are introducing new endpoints that allow you to securely manage tokens for OAuth Apps by using `access_token` as an input parameter. For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://developer.github.com/v3/auth#basic-authentication) when accessing this endpoint, using the OAuth application's `client_id` and `client_secret` as the username and password. You must also provide a valid token as `:access_token` and the grant for the token's owner will be deleted. - * - * Deleting an OAuth application's grant will also delete all OAuth tokens associated with the application for the user. Once deleted, the application will have no access to the user's account and will no longer be listed on [the Applications settings page under "Authorized OAuth Apps" on GitHub](https://github.com/settings/applications#authorized). - * @deprecated octokit.oauthAuthorizations.revokeGrantForApplication() is deprecated, see https://developer.github.com/v3/apps/oauth_applications/#revoke-a-grant-for-an-application - */ - revokeGrantForApplication: { - ( - params?: RequestParameters & - OauthAuthorizationsRevokeGrantForApplicationParams - ): Promise; - - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** GitHub will discontinue the [OAuth Authorizations API](https://developer.github.com/v3/oauth_authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://developer.github.com/apps/building-oauth-apps/authorizing-oauth-apps/#web-application-flow). For more information, see the [blog post](https://developer.github.com/changes/2019-11-05-deprecated-passwords-and-authorizations-api). - * - * If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://developer.github.com/v3/auth/#working-with-two-factor-authentication)." - * - * You can only send one of these scope keys at a time. - * @deprecated octokit.oauthAuthorizations.updateAuthorization() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#update-an-existing-authorization - */ - updateAuthorization: { - ( - params?: RequestParameters & - OauthAuthorizationsUpdateAuthorizationParams - ): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; - }; orgs: { /** * Only authenticated organization owners can add a member to the organization or update the member's role. @@ -36153,9 +30270,6 @@ export type RestEndpointMethods = { }; pulls: { checkIfMerged: { - ( - params?: RequestParameters & PullsCheckIfMergedParamsDeprecatedNumber - ): Promise; (params?: RequestParameters & PullsCheckIfMergedParams): Promise< AnyResponse >; @@ -36206,69 +30320,12 @@ export type RestEndpointMethods = { * * For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://developer.github.com/v3/pulls/comments/#parameters-2) table. */ createComment: { - ( - params?: RequestParameters & PullsCreateCommentParamsDeprecatedNumber - ): Promise>; - ( - params?: RequestParameters & PullsCreateCommentParamsDeprecatedInReplyTo - ): Promise>; (params?: RequestParameters & PullsCreateCommentParams): Promise< OctokitResponse >; endpoint: EndpointInterface; }; - /** - * **Note:** Multi-line comments on pull requests are currently in public beta and subject to change. - * - * Creates a review comment in the pull request diff. To add a regular comment to a pull request timeline, see "[Comments](https://developer.github.com/v3/issues/comments/#create-a-comment)." We recommend creating a review comment using `line`, `side`, and optionally `start_line` and `start_side` if your comment applies to more than one line in the pull request diff. - * - * You can still create a review comment using the `position` parameter. When you use `position`, the `line`, `side`, `start_line`, and `start_side` parameters are not required. For more information, see [Multi-line comment summary](https://developer.github.com/v3/pulls/comments/#multi-line-comment-summary-3). - * - * **Note:** The position value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. - * - * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. - * - * **Multi-line comment summary** - * - * **Note:** New parameters and response fields are available for developers to preview. During the preview period, these response fields may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2019-10-03-multi-line-comments) for full details. - * - * Use the `comfort-fade` preview header and the `line` parameter to show multi-line comment-supported fields in the response. - * - * If you use the `comfort-fade` preview header, your response will show: - * - * * For multi-line comments, values for `start_line`, `original_start_line`, `start_side`, `line`, `original_line`, and `side`. - * * For single-line comments, values for `line`, `original_line`, and `side` and a `null` value for `start_line`, `original_start_line`, and `start_side`. - * - * If you don't use the `comfort-fade` preview header, multi-line and single-line comments will appear the same way in the response with a single `position` attribute. Your response will show: - * - * * For multi-line comments, the last line of the comment range for the `position` attribute. - * * For single-line comments, the diff-positioned way of referencing comments for the `position` attribute. For more information, see `position` in the [input parameters](https://developer.github.com/v3/pulls/comments/#parameters-2) table. - * @deprecated octokit.pulls.createCommentReply() has been renamed to octokit.pulls.createComment() (2019-09-09) - */ - createCommentReply: { - ( - params?: RequestParameters & - PullsCreateCommentReplyParamsDeprecatedNumber - ): Promise>; - ( - params?: RequestParameters & - PullsCreateCommentReplyParamsDeprecatedInReplyTo - ): Promise>; - (params?: RequestParameters & PullsCreateCommentReplyParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; - - createFromIssue: { - (params?: RequestParameters & PullsCreateFromIssueParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; /** * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. * @@ -36277,9 +30334,6 @@ export type RestEndpointMethods = { * The `position` value equals the number of lines down from the first "@@" hunk header in the file you want to add a comment. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks until the beginning of a new file. */ createReview: { - ( - params?: RequestParameters & PullsCreateReviewParamsDeprecatedNumber - ): Promise>; (params?: RequestParameters & PullsCreateReviewParams): Promise< OctokitResponse >; @@ -36302,10 +30356,6 @@ export type RestEndpointMethods = { * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. */ createReviewRequest: { - ( - params?: RequestParameters & - PullsCreateReviewRequestParamsDeprecatedNumber - ): Promise>; (params?: RequestParameters & PullsCreateReviewRequestParams): Promise< OctokitResponse >; @@ -36324,10 +30374,6 @@ export type RestEndpointMethods = { }; deletePendingReview: { - ( - params?: RequestParameters & - PullsDeletePendingReviewParamsDeprecatedNumber - ): Promise>; (params?: RequestParameters & PullsDeletePendingReviewParams): Promise< OctokitResponse >; @@ -36336,10 +30382,6 @@ export type RestEndpointMethods = { }; deleteReviewRequest: { - ( - params?: RequestParameters & - PullsDeleteReviewRequestParamsDeprecatedNumber - ): Promise; (params?: RequestParameters & PullsDeleteReviewRequestParams): Promise< AnyResponse >; @@ -36350,9 +30392,6 @@ export type RestEndpointMethods = { * **Note:** To dismiss a pull request review on a [protected branch](https://developer.github.com/v3/repos/branches/), you must be a repository administrator or be included in the list of people or teams who can dismiss pull request reviews. */ dismissReview: { - ( - params?: RequestParameters & PullsDismissReviewParamsDeprecatedNumber - ): Promise>; (params?: RequestParameters & PullsDismissReviewParams): Promise< OctokitResponse >; @@ -36377,9 +30416,6 @@ export type RestEndpointMethods = { * Pass the appropriate [media type](https://developer.github.com/v3/media/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats. */ get: { - (params?: RequestParameters & PullsGetParamsDeprecatedNumber): Promise< - OctokitResponse - >; (params?: RequestParameters & PullsGetParams): Promise< OctokitResponse >; @@ -36418,10 +30454,6 @@ export type RestEndpointMethods = { }; getCommentsForReview: { - ( - params?: RequestParameters & - PullsGetCommentsForReviewParamsDeprecatedNumber - ): Promise>; (params?: RequestParameters & PullsGetCommentsForReviewParams): Promise< OctokitResponse >; @@ -36430,9 +30462,6 @@ export type RestEndpointMethods = { }; getReview: { - ( - params?: RequestParameters & PullsGetReviewParamsDeprecatedNumber - ): Promise>; (params?: RequestParameters & PullsGetReviewParams): Promise< OctokitResponse >; @@ -36473,9 +30502,6 @@ export type RestEndpointMethods = { * The `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://developer.github.com/v3/reactions) reactions. */ listComments: { - ( - params?: RequestParameters & PullsListCommentsParamsDeprecatedNumber - ): Promise>; (params?: RequestParameters & PullsListCommentsParams): Promise< OctokitResponse >; @@ -36516,9 +30542,6 @@ export type RestEndpointMethods = { * Lists a maximum of 250 commits for a pull request. To receive a complete commit list for pull requests with more than 250 commits, use the [Commit List API](https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository). */ listCommits: { - ( - params?: RequestParameters & PullsListCommitsParamsDeprecatedNumber - ): Promise>; (params?: RequestParameters & PullsListCommitsParams): Promise< OctokitResponse >; @@ -36529,9 +30552,6 @@ export type RestEndpointMethods = { * **Note:** Responses include a maximum of 3000 files. The paginated response returns 30 files per page by default. */ listFiles: { - ( - params?: RequestParameters & PullsListFilesParamsDeprecatedNumber - ): Promise>; (params?: RequestParameters & PullsListFilesParams): Promise< OctokitResponse >; @@ -36540,10 +30560,6 @@ export type RestEndpointMethods = { }; listReviewRequests: { - ( - params?: RequestParameters & - PullsListReviewRequestsParamsDeprecatedNumber - ): Promise>; (params?: RequestParameters & PullsListReviewRequestsParams): Promise< OctokitResponse >; @@ -36554,9 +30570,6 @@ export type RestEndpointMethods = { * The list of reviews returns in chronological order. */ listReviews: { - ( - params?: RequestParameters & PullsListReviewsParamsDeprecatedNumber - ): Promise>; (params?: RequestParameters & PullsListReviewsParams): Promise< OctokitResponse >; @@ -36567,9 +30580,6 @@ export type RestEndpointMethods = { * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. */ merge: { - (params?: RequestParameters & PullsMergeParamsDeprecatedNumber): Promise< - OctokitResponse - >; (params?: RequestParameters & PullsMergeParams): Promise< OctokitResponse >; @@ -36578,9 +30588,6 @@ export type RestEndpointMethods = { }; submitReview: { - ( - params?: RequestParameters & PullsSubmitReviewParamsDeprecatedNumber - ): Promise>; (params?: RequestParameters & PullsSubmitReviewParams): Promise< OctokitResponse >; @@ -36593,9 +30600,6 @@ export type RestEndpointMethods = { * To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request. */ update: { - (params?: RequestParameters & PullsUpdateParamsDeprecatedNumber): Promise< - OctokitResponse - >; (params?: RequestParameters & PullsUpdateParams): Promise< OctokitResponse >; @@ -36644,9 +30648,6 @@ export type RestEndpointMethods = { * Update the review summary comment with new text. */ updateReview: { - ( - params?: RequestParameters & PullsUpdateReviewParamsDeprecatedNumber - ): Promise>; (params?: RequestParameters & PullsUpdateReviewParams): Promise< OctokitResponse >; @@ -36698,10 +30699,6 @@ export type RestEndpointMethods = { * Create a reaction to an [issue](https://developer.github.com/v3/issues/). A response with a `Status: 200 OK` means that you already added the reaction type to this issue. */ createForIssue: { - ( - params?: RequestParameters & - ReactionsCreateForIssueParamsDeprecatedNumber - ): Promise>; (params?: RequestParameters & ReactionsCreateForIssueParams): Promise< OctokitResponse >; @@ -36731,35 +30728,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion) endpoint. - * - * Create a reaction to a [team discussion](https://developer.github.com/v3/teams/discussions/). OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion. - * @deprecated octokit.reactions.createForTeamDiscussion() is deprecated, see https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-legacy - */ - createForTeamDiscussion: { - ( - params?: RequestParameters & ReactionsCreateForTeamDiscussionParams - ): Promise>; - - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion comment`](https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-comment) endpoint. - * - * Create a reaction to a [team discussion comment](https://developer.github.com/v3/teams/discussion_comments/). OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment. - * @deprecated octokit.reactions.createForTeamDiscussionComment() is deprecated, see https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-comment-legacy - */ - createForTeamDiscussionComment: { - ( - params?: RequestParameters & - ReactionsCreateForTeamDiscussionCommentParams - ): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; /** * Create a reaction to a [team discussion comment](https://developer.github.com/v3/teams/discussion_comments/). OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment. * @@ -36775,22 +30743,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion comment`](https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-comment) endpoint. - * - * Create a reaction to a [team discussion comment](https://developer.github.com/v3/teams/discussion_comments/). OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment. - * @deprecated octokit.reactions.createForTeamDiscussionCommentLegacy() is deprecated, see https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-comment-legacy - */ - createForTeamDiscussionCommentLegacy: { - ( - params?: RequestParameters & - ReactionsCreateForTeamDiscussionCommentLegacyParams - ): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; /** * Create a reaction to a [team discussion](https://developer.github.com/v3/teams/discussions/). OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion. * @@ -36805,22 +30757,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create reaction for a team discussion`](https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion) endpoint. - * - * Create a reaction to a [team discussion](https://developer.github.com/v3/teams/discussions/). OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion. - * @deprecated octokit.reactions.createForTeamDiscussionLegacy() is deprecated, see https://developer.github.com/v3/reactions/#create-reaction-for-a-team-discussion-legacy - */ - createForTeamDiscussionLegacy: { - ( - params?: RequestParameters & - ReactionsCreateForTeamDiscussionLegacyParams - ): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; /** * OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), when deleting a [team discussion](https://developer.github.com/v3/teams/discussions/) or [team discussion comment](https://developer.github.com/v3/teams/discussion_comments/). */ @@ -36845,9 +30781,6 @@ export type RestEndpointMethods = { * List the reactions to an [issue](https://developer.github.com/v3/issues/). */ listForIssue: { - ( - params?: RequestParameters & ReactionsListForIssueParamsDeprecatedNumber - ): Promise>; (params?: RequestParameters & ReactionsListForIssueParams): Promise< OctokitResponse >; @@ -36877,34 +30810,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion) endpoint. - * - * List the reactions to a [team discussion](https://developer.github.com/v3/teams/discussions/). OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - * @deprecated octokit.reactions.listForTeamDiscussion() is deprecated, see https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-legacy - */ - listForTeamDiscussion: { - ( - params?: RequestParameters & ReactionsListForTeamDiscussionParams - ): Promise>; - - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-comment) endpoint. - * - * List the reactions to a [team discussion comment](https://developer.github.com/v3/teams/discussion_comments/). OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - * @deprecated octokit.reactions.listForTeamDiscussionComment() is deprecated, see https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-comment-legacy - */ - listForTeamDiscussionComment: { - ( - params?: RequestParameters & ReactionsListForTeamDiscussionCommentParams - ): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; /** * List the reactions to a [team discussion comment](https://developer.github.com/v3/teams/discussion_comments/). OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @@ -36920,22 +30825,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion comment`](https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-comment) endpoint. - * - * List the reactions to a [team discussion comment](https://developer.github.com/v3/teams/discussion_comments/). OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - * @deprecated octokit.reactions.listForTeamDiscussionCommentLegacy() is deprecated, see https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-comment-legacy - */ - listForTeamDiscussionCommentLegacy: { - ( - params?: RequestParameters & - ReactionsListForTeamDiscussionCommentLegacyParams - ): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; /** * List the reactions to a [team discussion](https://developer.github.com/v3/teams/discussions/). OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @@ -36946,19 +30835,6 @@ export type RestEndpointMethods = { params?: RequestParameters & ReactionsListForTeamDiscussionInOrgParams ): Promise>; - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List reactions for a team discussion`](https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion) endpoint. - * - * List the reactions to a [team discussion](https://developer.github.com/v3/teams/discussions/). OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - * @deprecated octokit.reactions.listForTeamDiscussionLegacy() is deprecated, see https://developer.github.com/v3/reactions/#list-reactions-for-a-team-discussion-legacy - */ - listForTeamDiscussionLegacy: { - ( - params?: RequestParameters & ReactionsListForTeamDiscussionLegacyParams - ): Promise>; - endpoint: EndpointInterface; }; }; @@ -37170,9 +31046,6 @@ export type RestEndpointMethods = { * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. */ createCommitComment: { - ( - params?: RequestParameters & ReposCreateCommitCommentParamsDeprecatedSha - ): Promise>; ( params?: RequestParameters & ReposCreateCommitCommentParamsDeprecatedLine @@ -37251,17 +31124,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * Creates a new file or updates an existing file in a repository. - * @deprecated octokit.repos.createFile() has been renamed to octokit.repos.createOrUpdateFile() (2019-06-07) - */ - createFile: { - (params?: RequestParameters & ReposCreateFileParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; /** * Creates a new repository for the authenticated user. * @@ -37650,12 +31512,6 @@ export type RestEndpointMethods = { * | `valid` | None of the above errors applied, so the signature is considered to be verified. | */ getCommit: { - (params?: RequestParameters & ReposGetCommitParamsDeprecatedSha): Promise< - OctokitResponse - >; - ( - params?: RequestParameters & ReposGetCommitParamsDeprecatedCommitSha - ): Promise>; (params?: RequestParameters & ReposGetCommitParams): Promise< OctokitResponse >; @@ -37680,21 +31536,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * **Note:** To access this endpoint, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header: - * ``` - * application/vnd.github.VERSION.sha - * ``` - * Returns the SHA-1 of the commit reference. You must have `read` access for the repository to get the SHA-1 of a commit reference. You can use this endpoint to check if a remote reference's SHA-1 is the same as your local reference's SHA-1 by providing the local SHA-1 reference as the ETag. - * @deprecated "Get the SHA-1 of a commit reference" will be removed. Use "Get a single commit" instead with media type format set to "sha" instead. - */ - getCommitRefSha: { - (params?: RequestParameters & ReposGetCommitRefShaParams): Promise< - AnyResponse - >; - - endpoint: EndpointInterface; - }; /** * Gets the contents of a file or directory in a repository. Specify the file path or directory in `:path`. If you omit `:path`, you will receive the contents of all files in the repository. * @@ -38032,22 +31873,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Lists the GitHub Apps that have push access to this branch. Only installed GitHub Apps with `write` access to the `contents` permission can be added as authorized actors on a protected branch. - * @deprecated octokit.repos.listAppsWithAccessToProtectedBranch() has been renamed to octokit.repos.getAppsWithAccessToProtectedBranch() (2019-09-13) - */ - listAppsWithAccessToProtectedBranch: { - ( - params?: RequestParameters & - ReposListAppsWithAccessToProtectedBranchParams - ): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; listAssetsForRelease: { (params?: RequestParameters & ReposListAssetsForReleaseParams): Promise< @@ -38092,10 +31917,6 @@ export type RestEndpointMethods = { * Use the `:commit_sha` to specify the commit that will have its comments listed. */ listCommentsForCommit: { - ( - params?: RequestParameters & - ReposListCommentsForCommitParamsDeprecatedRef - ): Promise>; (params?: RequestParameters & ReposListCommentsForCommitParams): Promise< OctokitResponse >; @@ -38284,38 +32105,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Lists the teams who have push access to this branch. The list includes child teams. - * @deprecated octokit.repos.listProtectedBranchTeamRestrictions() has been renamed to octokit.repos.getTeamsWithAccessToProtectedBranch() (2019-09-09) - */ - listProtectedBranchTeamRestrictions: { - ( - params?: RequestParameters & - ReposListProtectedBranchTeamRestrictionsParams - ): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Lists the people who have push access to this branch. - * @deprecated octokit.repos.listProtectedBranchUserRestrictions() has been renamed to octokit.repos.getUsersWithAccessToProtectedBranch() (2019-09-09) - */ - listProtectedBranchUserRestrictions: { - ( - params?: RequestParameters & - ReposListProtectedBranchUserRestrictionsParams - ): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; /** * Lists all public repositories in the order that they were created. * @@ -38381,22 +32170,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Lists the teams who have push access to this branch. The list includes child teams. - * @deprecated octokit.repos.listTeamsWithAccessToProtectedBranch() has been renamed to octokit.repos.getTeamsWithAccessToProtectedBranch() (2019-09-13) - */ - listTeamsWithAccessToProtectedBranch: { - ( - params?: RequestParameters & - ReposListTeamsWithAccessToProtectedBranchParams - ): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; listTopics: { (params?: RequestParameters & ReposListTopicsParams): Promise< @@ -38405,22 +32178,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * Protected branches are available in public repositories with GitHub Free, and in public and private repositories with GitHub Pro, GitHub Team, and GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Lists the people who have push access to this branch. - * @deprecated octokit.repos.listUsersWithAccessToProtectedBranch() has been renamed to octokit.repos.getUsersWithAccessToProtectedBranch() (2019-09-13) - */ - listUsersWithAccessToProtectedBranch: { - ( - params?: RequestParameters & - ReposListUsersWithAccessToProtectedBranchParams - ): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; merge: { (params?: RequestParameters & ReposMergeParams): Promise< @@ -38754,17 +32511,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * Creates a new file or updates an existing file in a repository. - * @deprecated octokit.repos.updateFile() has been renamed to octokit.repos.createOrUpdateFile() (2019-06-07) - */ - updateFile: { - (params?: RequestParameters & ReposUpdateFileParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; updateHook: { (params?: RequestParameters & ReposUpdateHookParams): Promise< @@ -38853,11 +32599,15 @@ export type RestEndpointMethods = { * `application/zip` * * GitHub expects the asset data in its raw binary form, rather than JSON. You will send the raw binary content of the asset as the request body. Everything else about the endpoint is the same as the rest of the API. For example, you'll still need to pass your authentication to be able to upload an asset. + * + * **Notes:** + * + * * GitHub renames asset filenames that have special characters, non-alphanumeric characters, and leading or trailing periods. The "[List assets for a release](https://developer.github.com/v3/repos/releases/#list-assets-for-a-release)" endpoint lists the renamed filenames. For more information and help, contact [GitHub Support](https://github.com/contact). + * * If you upload an asset with the same filename as another uploaded asset, you'll receive an error and must delete the old file before you can re-upload the new asset. + * + * This may leave an empty asset with a state of `starter`. It can be safely deleted. */ uploadReleaseAsset: { - ( - params?: RequestParameters & ReposUploadReleaseAssetParamsDeprecatedFile - ): Promise>; (params?: RequestParameters & ReposUploadReleaseAssetParams): Promise< OctokitResponse >; @@ -38910,34 +32660,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * This API call is added for compatibility reasons only. There's no guarantee that full email searches will always be available. The `@` character in the address must be left unencoded. Searches only against public email addresses (as configured on the user's GitHub profile). - * @deprecated octokit.search.emailLegacy() is deprecated, see https://developer.github.com/v3/search/legacy/#email-search - */ - emailLegacy: { - (params?: RequestParameters & SearchEmailLegacyParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; - /** - * Find issues by state and keyword. This method returns up to 100 results [per page](https://developer.github.com/v3/#pagination). - * - * When searching for issues, you can get text match metadata for the issue **title**, issue **body**, and issue **comment body** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://developer.github.com/v3/search/#text-match-metadata). - * - * Let's say you want to find the oldest unresolved Python bugs on Windows. Your query might look something like this. - * - * In this query, we're searching for the keyword `windows`, within any open issue that's labeled as `bug`. The search runs across repositories whose primary language is Python. We’re sorting by creation date in ascending order, so that the oldest issues appear first in the search results. - * @deprecated octokit.search.issues() has been renamed to octokit.search.issuesAndPullRequests() (2018-12-27) - */ - issues: { - (params?: RequestParameters & SearchIssuesParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; /** * Find issues by state and keyword. This method returns up to 100 results [per page](https://developer.github.com/v3/#pagination). * @@ -38954,17 +32676,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * Find issues by state and keyword. - * @deprecated octokit.search.issuesLegacy() is deprecated, see https://developer.github.com/v3/search/legacy/#search-issues - */ - issuesLegacy: { - (params?: RequestParameters & SearchIssuesLegacyParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; /** * Find labels in a repository with names or descriptions that match search keywords. Returns up to 100 results [per page](https://developer.github.com/v3/#pagination). * @@ -38999,17 +32710,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * Find repositories by keyword. Note, this legacy method does not follow the v3 pagination pattern. This method returns up to 100 results per page and pages can be fetched using the `start_page` parameter. - * @deprecated octokit.search.reposLegacy() is deprecated, see https://developer.github.com/v3/search/legacy/#search-repositories - */ - reposLegacy: { - (params?: RequestParameters & SearchReposLegacyParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; /** * Find topics via various criteria. Results are sorted by best match. This method returns up to 100 results [per page](https://developer.github.com/v3/#pagination). * @@ -39044,135 +32744,27 @@ export type RestEndpointMethods = { OctokitResponse >; - endpoint: EndpointInterface; - }; - /** - * Find users by keyword. - * @deprecated octokit.search.usersLegacy() is deprecated, see https://developer.github.com/v3/search/legacy/#search-users - */ - usersLegacy: { - (params?: RequestParameters & SearchUsersLegacyParams): Promise< - OctokitResponse - >; - endpoint: EndpointInterface; }; }; teams: { /** - * The "Add team member" endpoint (described below) is deprecated. - * - * We recommend using the [Add team membership](https://developer.github.com/v3/teams/members/#add-or-update-team-membership) endpoint instead. It allows you to invite new organization members to your teams. - * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. - * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." - * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://developer.github.com/v3/#http-verbs)." - * @deprecated octokit.teams.addMember() is deprecated, see https://developer.github.com/v3/teams/members/#add-team-member-legacy - */ - addMember: { - (params?: RequestParameters & TeamsAddMemberParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; - /** - * The "Add team member" endpoint (described below) is deprecated. - * - * We recommend using the [Add team membership](https://developer.github.com/v3/teams/members/#add-or-update-team-membership) endpoint instead. It allows you to invite new organization members to your teams. - * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * To add someone to a team, the authenticated user must be an organization owner or a team maintainer in the team they're changing. The person being added to the team must be a member of the team's organization. - * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." - * - * Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://developer.github.com/v3/#http-verbs)." - * @deprecated octokit.teams.addMemberLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#add-team-member-legacy - */ - addMemberLegacy: { - (params?: RequestParameters & TeamsAddMemberLegacyParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Add or update team membership`](https://developer.github.com/v3/teams/members/#add-or-update-team-membership) endpoint. - * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. - * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." - * - * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. - * - * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. - * @deprecated octokit.teams.addOrUpdateMembership() is deprecated, see https://developer.github.com/v3/teams/members/#add-or-update-team-membership-legacy - */ - addOrUpdateMembership: { - (params?: RequestParameters & TeamsAddOrUpdateMembershipParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; - /** - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team. - * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." - * - * An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. - * - * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. - * - * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/:org_id/team/:team_id/memberships/:username`. - */ - addOrUpdateMembershipInOrg: { - ( - params?: RequestParameters & TeamsAddOrUpdateMembershipInOrgParams - ): Promise>; - - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Add or update team membership`](https://developer.github.com/v3/teams/members/#add-or-update-team-membership) endpoint. - * * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * - * If the user is already a member of the team's organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer. + * Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team. * * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." * - * If the user is unaffiliated with the team's organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner. + * An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. * * If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer. - * @deprecated octokit.teams.addOrUpdateMembershipLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#add-or-update-team-membership-legacy - */ - addOrUpdateMembershipLegacy: { - ( - params?: RequestParameters & TeamsAddOrUpdateMembershipLegacyParams - ): Promise>; - - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Add or update team project`](https://developer.github.com/v3/teams/#add-or-update-team-project) endpoint. * - * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. - * @deprecated octokit.teams.addOrUpdateProject() is deprecated, see https://developer.github.com/v3/teams/#add-or-update-team-project-legacy + * **Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/:org_id/team/:team_id/memberships/:username`. */ - addOrUpdateProject: { - (params?: RequestParameters & TeamsAddOrUpdateProjectParams): Promise< - OctokitResponse - >; + addOrUpdateMembershipInOrg: { + ( + params?: RequestParameters & TeamsAddOrUpdateMembershipInOrgParams + ): Promise>; endpoint: EndpointInterface; }; @@ -39188,34 +32780,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Add or update team project`](https://developer.github.com/v3/teams/#add-or-update-team-project) endpoint. - * - * Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization. - * @deprecated octokit.teams.addOrUpdateProjectLegacy() is deprecated, see https://developer.github.com/v3/teams/#add-or-update-team-project-legacy - */ - addOrUpdateProjectLegacy: { - ( - params?: RequestParameters & TeamsAddOrUpdateProjectLegacyParams - ): Promise>; - - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Add or update team repository`](https://developer.github.com/v3/teams/#add-or-update-team-repository) endpoint. - * - * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. - * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://developer.github.com/v3/#http-verbs)." - * @deprecated octokit.teams.addOrUpdateRepo() is deprecated, see https://developer.github.com/v3/teams/#add-or-update-team-repository-legacy - */ - addOrUpdateRepo: { - (params?: RequestParameters & TeamsAddOrUpdateRepoParams): Promise< - AnyResponse - >; - - endpoint: EndpointInterface; - }; /** * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://developer.github.com/v3/#http-verbs)." * @@ -39228,36 +32792,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Add or update team repository`](https://developer.github.com/v3/teams/#add-or-update-team-repository) endpoint. - * - * To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. - * - * Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP verbs](https://developer.github.com/v3/#http-verbs)." - * @deprecated octokit.teams.addOrUpdateRepoLegacy() is deprecated, see https://developer.github.com/v3/teams/#add-or-update-team-repository-legacy - */ - addOrUpdateRepoLegacy: { - (params?: RequestParameters & TeamsAddOrUpdateRepoLegacyParams): Promise< - AnyResponse - >; - - endpoint: EndpointInterface; - }; - /** - * **Note**: Repositories inherited through a parent team will also be checked. - * - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Check if a team manages a repository`](https://developer.github.com/v3/teams/#check-if-a-team-manages-a-repository) endpoint. - * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://developer.github.com/v3/media/) via the `Accept` header: - * @deprecated octokit.teams.checkManagesRepo() is deprecated, see https://developer.github.com/v3/teams/#check-if-a-team-manages-a-repository-legacy - */ - checkManagesRepo: { - (params?: RequestParameters & TeamsCheckManagesRepoParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; /** * Checks whether a team has `admin`, `push`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked. * @@ -39272,21 +32806,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * **Note**: Repositories inherited through a parent team will also be checked. - * - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Check if a team manages a repository`](https://developer.github.com/v3/teams/#check-if-a-team-manages-a-repository) endpoint. - * - * You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://developer.github.com/v3/media/) via the `Accept` header: - * @deprecated octokit.teams.checkManagesRepoLegacy() is deprecated, see https://developer.github.com/v3/teams/#check-if-a-team-manages-a-repository-legacy - */ - checkManagesRepoLegacy: { - (params?: RequestParameters & TeamsCheckManagesRepoLegacyParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; /** * To create a team, the authenticated user must be a member or owner of `:org`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see "[Setting team creation permissions](https://help.github.com/en/articles/setting-team-creation-permissions-in-your-organization)." * @@ -39302,36 +32821,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://developer.github.com/v3/teams/discussions/#create-a-discussion) endpoint. - * - * Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - * - * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. - * @deprecated octokit.teams.createDiscussion() is deprecated, see https://developer.github.com/v3/teams/discussions/#create-a-discussion-legacy - */ - createDiscussion: { - (params?: RequestParameters & TeamsCreateDiscussionParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a comment`](https://developer.github.com/v3/teams/discussion_comments/#create-a-comment) endpoint. - * - * Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - * - * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. - * @deprecated octokit.teams.createDiscussionComment() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#create-a-comment-legacy - */ - createDiscussionComment: { - ( - params?: RequestParameters & TeamsCreateDiscussionCommentParams - ): Promise>; - - endpoint: EndpointInterface; - }; /** * Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @@ -39346,21 +32835,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a comment`](https://developer.github.com/v3/teams/discussion_comments/#create-a-comment) endpoint. - * - * Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - * - * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. - * @deprecated octokit.teams.createDiscussionCommentLegacy() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#create-a-comment-legacy - */ - createDiscussionCommentLegacy: { - ( - params?: RequestParameters & TeamsCreateDiscussionCommentLegacyParams - ): Promise>; - - endpoint: EndpointInterface; - }; /** * Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @@ -39375,60 +32849,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Create a discussion`](https://developer.github.com/v3/teams/discussions/#create-a-discussion) endpoint. - * - * Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - * - * This endpoint triggers [notifications](https://help.github.com/articles/about-notifications/). Creating content too quickly using this endpoint may result in abuse rate limiting. See "[Abuse rate limits](https://developer.github.com/v3/#abuse-rate-limits)" and "[Dealing with abuse rate limits](https://developer.github.com/v3/guides/best-practices-for-integrators/#dealing-with-abuse-rate-limits)" for details. - * @deprecated octokit.teams.createDiscussionLegacy() is deprecated, see https://developer.github.com/v3/teams/discussions/#create-a-discussion-legacy - */ - createDiscussionLegacy: { - (params?: RequestParameters & TeamsCreateDiscussionLegacyParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete team`](https://developer.github.com/v3/teams/#delete-team) endpoint. - * - * To delete a team, the authenticated user must be an organization owner or team maintainer. - * - * If you are an organization owner, deleting a parent team will delete all of its child teams as well. - * @deprecated octokit.teams.delete() is deprecated, see https://developer.github.com/v3/teams/#delete-team-legacy - */ - delete: { - (params?: RequestParameters & TeamsDeleteParams): Promise; - - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://developer.github.com/v3/teams/discussions/#delete-a-discussion) endpoint. - * - * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - * @deprecated octokit.teams.deleteDiscussion() is deprecated, see https://developer.github.com/v3/teams/discussions/#delete-a-discussion-legacy - */ - deleteDiscussion: { - (params?: RequestParameters & TeamsDeleteDiscussionParams): Promise< - AnyResponse - >; - - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a comment`](https://developer.github.com/v3/teams/discussion_comments/#delete-a-comment) endpoint. - * - * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - * @deprecated octokit.teams.deleteDiscussionComment() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#delete-a-comment-legacy - */ - deleteDiscussionComment: { - ( - params?: RequestParameters & TeamsDeleteDiscussionCommentParams - ): Promise; - - endpoint: EndpointInterface; - }; /** * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @@ -39441,19 +32861,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a comment`](https://developer.github.com/v3/teams/discussion_comments/#delete-a-comment) endpoint. - * - * Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - * @deprecated octokit.teams.deleteDiscussionCommentLegacy() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#delete-a-comment-legacy - */ - deleteDiscussionCommentLegacy: { - ( - params?: RequestParameters & TeamsDeleteDiscussionCommentLegacyParams - ): Promise; - - endpoint: EndpointInterface; - }; /** * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @@ -39466,19 +32873,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete a discussion`](https://developer.github.com/v3/teams/discussions/#delete-a-discussion) endpoint. - * - * Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - * @deprecated octokit.teams.deleteDiscussionLegacy() is deprecated, see https://developer.github.com/v3/teams/discussions/#delete-a-discussion-legacy - */ - deleteDiscussionLegacy: { - (params?: RequestParameters & TeamsDeleteDiscussionLegacyParams): Promise< - AnyResponse - >; - - endpoint: EndpointInterface; - }; /** * To delete a team, the authenticated user must be an organization owner or team maintainer. * @@ -39493,32 +32887,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Delete team`](https://developer.github.com/v3/teams/#delete-team) endpoint. - * - * To delete a team, the authenticated user must be an organization owner or team maintainer. - * - * If you are an organization owner, deleting a parent team will delete all of its child teams as well. - * @deprecated octokit.teams.deleteLegacy() is deprecated, see https://developer.github.com/v3/teams/#delete-team-legacy - */ - deleteLegacy: { - (params?: RequestParameters & TeamsDeleteLegacyParams): Promise< - AnyResponse - >; - - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [`Get team by name`](https://developer.github.com/v3/teams/#get-team-by-name) endpoint. - * @deprecated octokit.teams.get() is deprecated, see https://developer.github.com/v3/teams/#get-team-legacy - */ - get: { - (params?: RequestParameters & TeamsGetParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; /** * Gets a team using the team's `slug`. GitHub generates the `slug` from the team `name`. * @@ -39531,32 +32899,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Get a single discussion`](https://developer.github.com/v3/teams/discussions/#get-a-single-discussion) endpoint. - * - * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - * @deprecated octokit.teams.getDiscussion() is deprecated, see https://developer.github.com/v3/teams/discussions/#get-a-single-discussion-legacy - */ - getDiscussion: { - (params?: RequestParameters & TeamsGetDiscussionParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Get a single comment`](https://developer.github.com/v3/teams/discussion_comments/#get-a-single-comment) endpoint. - * - * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - * @deprecated octokit.teams.getDiscussionComment() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#get-a-single-comment-legacy - */ - getDiscussionComment: { - (params?: RequestParameters & TeamsGetDiscussionCommentParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; /** * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @@ -39569,19 +32911,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Get a single comment`](https://developer.github.com/v3/teams/discussion_comments/#get-a-single-comment) endpoint. - * - * Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - * @deprecated octokit.teams.getDiscussionCommentLegacy() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#get-a-single-comment-legacy - */ - getDiscussionCommentLegacy: { - ( - params?: RequestParameters & TeamsGetDiscussionCommentLegacyParams - ): Promise>; - - endpoint: EndpointInterface; - }; /** * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @@ -39594,75 +32923,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Get a single discussion`](https://developer.github.com/v3/teams/discussions/#get-a-single-discussion) endpoint. - * - * Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - * @deprecated octokit.teams.getDiscussionLegacy() is deprecated, see https://developer.github.com/v3/teams/discussions/#get-a-single-discussion-legacy - */ - getDiscussionLegacy: { - (params?: RequestParameters & TeamsGetDiscussionLegacyParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the [`Get team by name`](https://developer.github.com/v3/teams/#get-team-by-name) endpoint. - * @deprecated octokit.teams.getLegacy() is deprecated, see https://developer.github.com/v3/teams/#get-team-legacy - */ - getLegacy: { - (params?: RequestParameters & TeamsGetLegacyParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; - /** - * The "Get team member" endpoint (described below) is deprecated. - * - * We recommend using the [Get team membership](https://developer.github.com/v3/teams/members/#get-team-membership) endpoint instead. It allows you to get both active and pending memberships. - * - * To list members in a team, the team must be visible to the authenticated user. - * @deprecated octokit.teams.getMember() is deprecated, see https://developer.github.com/v3/teams/members/#get-team-member-legacy - */ - getMember: { - (params?: RequestParameters & TeamsGetMemberParams): Promise; - - endpoint: EndpointInterface; - }; - /** - * The "Get team member" endpoint (described below) is deprecated. - * - * We recommend using the [Get team membership](https://developer.github.com/v3/teams/members/#get-team-membership) endpoint instead. It allows you to get both active and pending memberships. - * - * To list members in a team, the team must be visible to the authenticated user. - * @deprecated octokit.teams.getMemberLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#get-team-member-legacy - */ - getMemberLegacy: { - (params?: RequestParameters & TeamsGetMemberLegacyParams): Promise< - AnyResponse - >; - - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Get team membership`](https://developer.github.com/v3/teams/members/#get-team-membership) endpoint. - * - * Team members will include the members of child teams. - * - * To get a user's membership with a team, the team must be visible to the authenticated user. - * - * **Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create team](https://developer.github.com/v3/teams#create-team). - * @deprecated octokit.teams.getMembership() is deprecated, see https://developer.github.com/v3/teams/members/#get-team-membership-legacy - */ - getMembership: { - (params?: RequestParameters & TeamsGetMembershipParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; /** * Team members will include the members of child teams. * @@ -39679,23 +32939,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Get team membership`](https://developer.github.com/v3/teams/members/#get-team-membership) endpoint. - * - * Team members will include the members of child teams. - * - * To get a user's membership with a team, the team must be visible to the authenticated user. - * - * **Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create team](https://developer.github.com/v3/teams#create-team). - * @deprecated octokit.teams.getMembershipLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#get-team-membership-legacy - */ - getMembershipLegacy: { - (params?: RequestParameters & TeamsGetMembershipLegacyParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; /** * Lists all teams in an organization that are visible to the authenticated user. */ @@ -39706,19 +32949,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://developer.github.com/v3/teams/#list-child-teams) endpoint. - * - * - * @deprecated octokit.teams.listChild() is deprecated, see https://developer.github.com/v3/teams/#list-child-teams-legacy - */ - listChild: { - (params?: RequestParameters & TeamsListChildParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; /** * Lists the child teams of the team requested by `:team_slug`. * @@ -39731,32 +32961,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List child teams`](https://developer.github.com/v3/teams/#list-child-teams) endpoint. - * - * - * @deprecated octokit.teams.listChildLegacy() is deprecated, see https://developer.github.com/v3/teams/#list-child-teams-legacy - */ - listChildLegacy: { - (params?: RequestParameters & TeamsListChildLegacyParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List comments`](https://developer.github.com/v3/teams/discussion_comments/#list-comments) endpoint. - * - * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - * @deprecated octokit.teams.listDiscussionComments() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#list-comments-legacy - */ - listDiscussionComments: { - (params?: RequestParameters & TeamsListDiscussionCommentsParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; /** * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @@ -39769,32 +32973,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List comments`](https://developer.github.com/v3/teams/discussion_comments/#list-comments) endpoint. - * - * List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - * @deprecated octokit.teams.listDiscussionCommentsLegacy() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#list-comments-legacy - */ - listDiscussionCommentsLegacy: { - ( - params?: RequestParameters & TeamsListDiscussionCommentsLegacyParams - ): Promise>; - - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://developer.github.com/v3/teams/discussions/#list-discussions) endpoint. - * - * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - * @deprecated octokit.teams.listDiscussions() is deprecated, see https://developer.github.com/v3/teams/discussions/#list-discussions-legacy - */ - listDiscussions: { - (params?: RequestParameters & TeamsListDiscussionsParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; /** * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @@ -39807,19 +32985,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List discussions`](https://developer.github.com/v3/teams/discussions/#list-discussions) endpoint. - * - * List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - * @deprecated octokit.teams.listDiscussionsLegacy() is deprecated, see https://developer.github.com/v3/teams/discussions/#list-discussions-legacy - */ - listDiscussionsLegacy: { - (params?: RequestParameters & TeamsListDiscussionsLegacyParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; /** * List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://developer.github.com/apps/building-oauth-apps/). */ @@ -39830,19 +32995,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://developer.github.com/v3/teams/members/#list-team-members) endpoint. - * - * Team members will include the members of child teams. - * @deprecated octokit.teams.listMembers() is deprecated, see https://developer.github.com/v3/teams/members/#list-team-members-legacy - */ - listMembers: { - (params?: RequestParameters & TeamsListMembersParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; /** * Team members will include the members of child teams. * @@ -39855,32 +33007,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team members`](https://developer.github.com/v3/teams/members/#list-team-members) endpoint. - * - * Team members will include the members of child teams. - * @deprecated octokit.teams.listMembersLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#list-team-members-legacy - */ - listMembersLegacy: { - (params?: RequestParameters & TeamsListMembersLegacyParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://developer.github.com/v3/teams/members/#list-pending-team-invitations) endpoint. - * - * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. - * @deprecated octokit.teams.listPendingInvitations() is deprecated, see https://developer.github.com/v3/teams/members/#list-pending-team-invitations-legacy - */ - listPendingInvitations: { - (params?: RequestParameters & TeamsListPendingInvitationsParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; /** * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. * @@ -39893,32 +33019,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List pending team invitations`](https://developer.github.com/v3/teams/members/#list-pending-team-invitations) endpoint. - * - * The return hash contains a `role` field which refers to the Organization Invitation role and will be one of the following values: `direct_member`, `admin`, `billing_manager`, `hiring_manager`, or `reinstate`. If the invitee is not a GitHub member, the `login` field in the return hash will be `null`. - * @deprecated octokit.teams.listPendingInvitationsLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#list-pending-team-invitations-legacy - */ - listPendingInvitationsLegacy: { - ( - params?: RequestParameters & TeamsListPendingInvitationsLegacyParams - ): Promise>; - - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://developer.github.com/v3/teams/#list-team-projects) endpoint. - * - * Lists the organization projects for a team. - * @deprecated octokit.teams.listProjects() is deprecated, see https://developer.github.com/v3/teams/#list-team-projects-legacy - */ - listProjects: { - (params?: RequestParameters & TeamsListProjectsParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; /** * Lists the organization projects for a team. * @@ -39931,30 +33031,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team projects`](https://developer.github.com/v3/teams/#list-team-projects) endpoint. - * - * Lists the organization projects for a team. - * @deprecated octokit.teams.listProjectsLegacy() is deprecated, see https://developer.github.com/v3/teams/#list-team-projects-legacy - */ - listProjectsLegacy: { - (params?: RequestParameters & TeamsListProjectsLegacyParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team repos`](https://developer.github.com/v3/teams/#list-team-repos) endpoint. - * @deprecated octokit.teams.listRepos() is deprecated, see https://developer.github.com/v3/teams/#list-team-repos-legacy - */ - listRepos: { - (params?: RequestParameters & TeamsListReposParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; /** * Lists a team's repositories visible to the authenticated user. * @@ -39967,72 +33043,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`List team repos`](https://developer.github.com/v3/teams/#list-team-repos) endpoint. - * @deprecated octokit.teams.listReposLegacy() is deprecated, see https://developer.github.com/v3/teams/#list-team-repos-legacy - */ - listReposLegacy: { - (params?: RequestParameters & TeamsListReposLegacyParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; - /** - * The "Remove team member" endpoint (described below) is deprecated. - * - * We recommend using the [Remove team membership](https://developer.github.com/v3/teams/members/#remove-team-membership) endpoint instead. It allows you to remove both active and pending memberships. - * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. - * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." - * @deprecated octokit.teams.removeMember() is deprecated, see https://developer.github.com/v3/teams/members/#remove-team-member-legacy - */ - removeMember: { - (params?: RequestParameters & TeamsRemoveMemberParams): Promise< - AnyResponse - >; - - endpoint: EndpointInterface; - }; - /** - * The "Remove team member" endpoint (described below) is deprecated. - * - * We recommend using the [Remove team membership](https://developer.github.com/v3/teams/members/#remove-team-membership) endpoint instead. It allows you to remove both active and pending memberships. - * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * To remove a team member, the authenticated user must have 'admin' permissions to the team or be an owner of the org that the team is associated with. Removing a team member does not delete the user, it just removes them from the team. - * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." - * @deprecated octokit.teams.removeMemberLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#remove-team-member-legacy - */ - removeMemberLegacy: { - (params?: RequestParameters & TeamsRemoveMemberLegacyParams): Promise< - AnyResponse - >; - - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Remove team membership`](https://developer.github.com/v3/teams/members/#remove-team-membership) endpoint. - * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. - * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." - * @deprecated octokit.teams.removeMembership() is deprecated, see https://developer.github.com/v3/teams/members/#remove-team-membership-legacy - */ - removeMembership: { - (params?: RequestParameters & TeamsRemoveMembershipParams): Promise< - AnyResponse - >; - - endpoint: EndpointInterface; - }; /** * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. * @@ -40049,36 +33059,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Remove team membership`](https://developer.github.com/v3/teams/members/#remove-team-membership) endpoint. - * - * Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation. - * - * To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team. - * - * **Note:** When you have team synchronization set up for a team with your organization's identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team's membership. If you have access to manage group membership in your IdP, you can manage GitHub team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/)." - * @deprecated octokit.teams.removeMembershipLegacy() is deprecated, see https://developer.github.com/v3/teams/members/#remove-team-membership-legacy - */ - removeMembershipLegacy: { - (params?: RequestParameters & TeamsRemoveMembershipLegacyParams): Promise< - AnyResponse - >; - - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Remove team project`](https://developer.github.com/v3/teams/#remove-team-project) endpoint. - * - * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. - * @deprecated octokit.teams.removeProject() is deprecated, see https://developer.github.com/v3/teams/#remove-team-project-legacy - */ - removeProject: { - (params?: RequestParameters & TeamsRemoveProjectParams): Promise< - AnyResponse - >; - - endpoint: EndpointInterface; - }; /** * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project. * @@ -40091,32 +33071,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Remove team project`](https://developer.github.com/v3/teams/#remove-team-project) endpoint. - * - * Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. **Note:** This endpoint removes the project from the team, but does not delete it. - * @deprecated octokit.teams.removeProjectLegacy() is deprecated, see https://developer.github.com/v3/teams/#remove-team-project-legacy - */ - removeProjectLegacy: { - (params?: RequestParameters & TeamsRemoveProjectLegacyParams): Promise< - AnyResponse - >; - - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Remove team repository`](https://developer.github.com/v3/teams/#remove-team-repository) endpoint. - * - * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. - * @deprecated octokit.teams.removeRepo() is deprecated, see https://developer.github.com/v3/teams/#remove-team-repository-legacy - */ - removeRepo: { - (params?: RequestParameters & TeamsRemoveRepoParams): Promise< - AnyResponse - >; - - endpoint: EndpointInterface; - }; /** * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team. * @@ -40129,32 +33083,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Remove team repository`](https://developer.github.com/v3/teams/#remove-team-repository) endpoint. - * - * If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. NOTE: This does not delete the repository, it just removes it from the team. - * @deprecated octokit.teams.removeRepoLegacy() is deprecated, see https://developer.github.com/v3/teams/#remove-team-repository-legacy - */ - removeRepoLegacy: { - (params?: RequestParameters & TeamsRemoveRepoLegacyParams): Promise< - AnyResponse - >; - - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Review a team project`](https://developer.github.com/v3/teams/#review-a-team-project) endpoint. - * - * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. - * @deprecated octokit.teams.reviewProject() is deprecated, see https://developer.github.com/v3/teams/#review-a-team-project-legacy - */ - reviewProject: { - (params?: RequestParameters & TeamsReviewProjectParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; /** * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. * @@ -40167,63 +33095,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Review a team project`](https://developer.github.com/v3/teams/#review-a-team-project) endpoint. - * - * Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team. - * @deprecated octokit.teams.reviewProjectLegacy() is deprecated, see https://developer.github.com/v3/teams/#review-a-team-project-legacy - */ - reviewProjectLegacy: { - (params?: RequestParameters & TeamsReviewProjectLegacyParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Edit team`](https://developer.github.com/v3/teams/#edit-team) endpoint. - * - * To edit a team, the authenticated user must either be an organization owner or a team maintainer. - * - * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. - * @deprecated octokit.teams.update() is deprecated, see https://developer.github.com/v3/teams/#edit-team-legacy - */ - update: { - ( - params?: RequestParameters & TeamsUpdateParamsDeprecatedPermission - ): Promise>; - (params?: RequestParameters & TeamsUpdateParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Edit a discussion`](https://developer.github.com/v3/teams/discussions/#edit-a-discussion) endpoint. - * - * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - * @deprecated octokit.teams.updateDiscussion() is deprecated, see https://developer.github.com/v3/teams/discussions/#edit-a-discussion-legacy - */ - updateDiscussion: { - (params?: RequestParameters & TeamsUpdateDiscussionParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Edit a comment`](https://developer.github.com/v3/teams/discussion_comments/#edit-a-comment) endpoint. - * - * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - * @deprecated octokit.teams.updateDiscussionComment() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#edit-a-comment-legacy - */ - updateDiscussionComment: { - ( - params?: RequestParameters & TeamsUpdateDiscussionCommentParams - ): Promise>; - - endpoint: EndpointInterface; - }; /** * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @@ -40236,19 +33107,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Edit a comment`](https://developer.github.com/v3/teams/discussion_comments/#edit-a-comment) endpoint. - * - * Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - * @deprecated octokit.teams.updateDiscussionCommentLegacy() is deprecated, see https://developer.github.com/v3/teams/discussion_comments/#edit-a-comment-legacy - */ - updateDiscussionCommentLegacy: { - ( - params?: RequestParameters & TeamsUpdateDiscussionCommentLegacyParams - ): Promise>; - - endpoint: EndpointInterface; - }; /** * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). * @@ -40261,19 +33119,6 @@ export type RestEndpointMethods = { endpoint: EndpointInterface; }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Edit a discussion`](https://developer.github.com/v3/teams/discussions/#edit-a-discussion) endpoint. - * - * Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). - * @deprecated octokit.teams.updateDiscussionLegacy() is deprecated, see https://developer.github.com/v3/teams/discussions/#edit-a-discussion-legacy - */ - updateDiscussionLegacy: { - (params?: RequestParameters & TeamsUpdateDiscussionLegacyParams): Promise< - OctokitResponse - >; - - endpoint: EndpointInterface; - }; /** * To edit a team, the authenticated user must either be an organization owner or a team maintainer. * @@ -40287,24 +33132,6 @@ export type RestEndpointMethods = { OctokitResponse >; - endpoint: EndpointInterface; - }; - /** - * **Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [`Edit team`](https://developer.github.com/v3/teams/#edit-team) endpoint. - * - * To edit a team, the authenticated user must either be an organization owner or a team maintainer. - * - * **Note:** With nested teams, the `privacy` for parent teams cannot be `secret`. - * @deprecated octokit.teams.updateLegacy() is deprecated, see https://developer.github.com/v3/teams/#edit-team-legacy - */ - updateLegacy: { - ( - params?: RequestParameters & TeamsUpdateLegacyParamsDeprecatedPermission - ): Promise>; - (params?: RequestParameters & TeamsUpdateLegacyParams): Promise< - OctokitResponse - >; - endpoint: EndpointInterface; }; }; diff --git a/src/index.ts b/src/index.ts index 1577d1a4f..cdf08c70f 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1,10 +1,10 @@ import { Octokit } from "@octokit/core"; import { Deprecation } from "deprecation"; -import endpointsByScope from "./generated/endpoints"; +import ENDPOINTS from "./generated/endpoints"; import { VERSION } from "./version"; import { Api } from "./types"; -import { registerEndpoints } from "./register-endpoints"; +import { endpointsToMethods } from "./endpoints-to-methods"; /** * This plugin is a 1:1 copy of internal @octokit/rest plugins. The primary @@ -17,32 +17,6 @@ import { registerEndpoints } from "./register-endpoints"; * https://github.com/octokit/plugin-rest-endpoint-methods.js/pull/1 */ export function restEndpointMethods(octokit: Octokit): Api { - // @ts-ignore - octokit.registerEndpoints = registerEndpoints.bind(null, octokit); - - registerEndpoints(octokit, endpointsByScope); - - // Aliasing scopes for backward compatibility - // See https://github.com/octokit/rest.js/pull/1134 - [ - ["gitdata", "git"], - ["authorization", "oauthAuthorizations"], - ["pullRequests", "pulls"] - ].forEach(([deprecatedScope, scope]) => { - Object.defineProperty(octokit, deprecatedScope, { - get() { - octokit.log.warn( - // @ts-ignore - new Deprecation( - `[@octokit/plugin-rest-endpoint-methods] "octokit.${deprecatedScope}.*" methods are deprecated, use "octokit.${scope}.*" instead` - ) - ); - // @ts-ignore - return octokit[scope]; - } - }); - }); - - return {} as Api; + return endpointsToMethods(octokit, ENDPOINTS); } restEndpointMethods.VERSION = VERSION; diff --git a/src/register-endpoints.ts b/src/register-endpoints.ts deleted file mode 100644 index 45de41f4a..000000000 --- a/src/register-endpoints.ts +++ /dev/null @@ -1,106 +0,0 @@ -import { Deprecation } from "deprecation"; - -import { EndpointOptions } from "@octokit/types"; - -export function registerEndpoints(octokit: any, routes: any) { - Object.keys(routes).forEach(namespaceName => { - if (!octokit[namespaceName]) { - octokit[namespaceName] = {}; - } - - Object.keys(routes[namespaceName]).forEach(apiName => { - const apiOptions = routes[namespaceName][apiName]; - - const endpointDefaults = ["method", "url", "headers"].reduce( - (map, key) => { - if (typeof apiOptions[key] !== "undefined") { - map[key] = apiOptions[key]; - } - - return map; - }, - {} as EndpointOptions - ); - - endpointDefaults.request = { - validate: apiOptions.params - }; - - let request = octokit.request.defaults(endpointDefaults); - - // patch request & endpoint methods to support deprecated parameters. - // Not the most elegant solution, but we don’t want to move deprecation - // logic into octokit/endpoint.js as it’s out of scope - const hasDeprecatedParam = Object.keys(apiOptions.params || {}).find( - key => apiOptions.params[key].deprecated - ); - if (hasDeprecatedParam) { - const patch = patchForDeprecation.bind(null, octokit, apiOptions); - request = patch( - octokit.request.defaults(endpointDefaults), - `.${namespaceName}.${apiName}()` - ); - request.endpoint = patch( - request.endpoint, - `.${namespaceName}.${apiName}.endpoint()` - ); - request.endpoint.merge = patch( - request.endpoint.merge, - `.${namespaceName}.${apiName}.endpoint.merge()` - ); - } - - if (apiOptions.deprecated) { - octokit[namespaceName][apiName] = Object.assign( - function deprecatedEndpointMethod() { - octokit.log.warn( - new Deprecation(`[@octokit/rest] ${apiOptions.deprecated}`) - ); - octokit[namespaceName][apiName] = request; - return request.apply(null, arguments); - }, - request - ); - - return; - } - - octokit[namespaceName][apiName] = request; - }); - }); -} - -function patchForDeprecation( - octokit: any, - apiOptions: any, - method: any, - methodName: any -) { - const patchedMethod: any = (options: any) => { - options = Object.assign({}, options); - - Object.keys(options).forEach(key => { - if (apiOptions.params[key] && apiOptions.params[key].deprecated) { - const aliasKey = apiOptions.params[key].alias; - - octokit.log.warn( - new Deprecation( - `[@octokit/rest] "${key}" parameter is deprecated for "${methodName}". Use "${aliasKey}" instead` - ) - ); - - if (!(aliasKey in options)) { - options[aliasKey] = options[key]; - } - delete options[key]; - } - }); - - return method(options); - }; - Object.keys(method).forEach(key => { - patchedMethod[key] = method[key]; - }); - - return patchedMethod; -} diff --git a/src/types.ts b/src/types.ts index 69ce22728..55ead4082 100644 --- a/src/types.ts +++ b/src/types.ts @@ -1,5 +1,20 @@ -import { RestEndpointMethods } from "./generated/rest-endpoint-methods-types"; +import { Route, RequestParameters } from "@octokit/types"; -export type Api = { - registerEndpoints: (endpoints: any) => void; -} & RestEndpointMethods; +import { RestEndpointMethods } from "./generated/types"; + +export type Api = RestEndpointMethods; + +export type EndpointDecorations = { + mapToData?: string; + deprecated?: string; + renamed?: [string, string]; + renamedParameters?: { + [name: string]: string; + }; +}; + +export type EndpointsDefaultsAndDecorations = { + [scope: string]: { + [methodName: string]: [Route, RequestParameters?, EndpointDecorations?]; + }; +}; diff --git a/test/deprecations.test.ts b/test/deprecations.test.ts index 1eb7cc281..bef5aa30d 100644 --- a/test/deprecations.test.ts +++ b/test/deprecations.test.ts @@ -3,170 +3,125 @@ import { Octokit } from "@octokit/core"; import { restEndpointMethods } from "../src"; +// All the commented out tests are no longer valid as the methods/parameters +// have been removed. We keep them here for future reference describe("Deprecations", () => { - it("deprecated method", async () => { - const mock = fetchMock.sandbox().get("path:/licenses", []); - const MyOctokit = Octokit.plugin(restEndpointMethods); - let warnCalledCount = 0; - const octokit = new MyOctokit({ - request: { - fetch: mock - }, - log: { - warn: (deprecation: Error) => { - warnCalledCount++; - expect(deprecation.message).toMatch( - "octokit.licenses.list() has been renamed to octokit.licenses.listCommonlyUsed()" - ); - } - } - }); - - // See https://developer.github.com/v3/licenses/#list-commonly-used-licenses - const { data } = await octokit.licenses.list(); - - expect(data).toStrictEqual([]); - expect(warnCalledCount).toEqual(1); - }); - - it("deprecated parameter", async () => { - const mock = fetchMock.sandbox().post( - "path:/repos/octocat/hello-world/issues/123/comments", - { - ok: true - }, - { - body: { - body: "Hello there!" - } - } - ); - const MyOctokit = Octokit.plugin(restEndpointMethods); - - let warnCalledCount = 0; - const octokit = new MyOctokit({ - request: { - fetch: mock - }, - log: { - warn: (deprecation: Error) => { - warnCalledCount++; - expect(deprecation.message).toMatch( - '"number" parameter is deprecated for ".issues.createComment()". Use "issue_number" instead' - ); - } - } - }); - - // See https://developer.github.com/v3/issues/comments/#create-a-comment - const { data } = await octokit.issues.createComment({ - owner: "octocat", - repo: "hello-world", - number: 123, - body: "Hello there!" - }); - - expect(data).toStrictEqual({ ok: true }); - expect(warnCalledCount).toEqual(1); + it("There are no deprecations", () => { + expect("ok").toBeTruthy(); }); - it("deprecated parameter + new parameter", async () => { - const mock = fetchMock.sandbox().post( - "path:/repos/octocat/hello-world/issues/456/comments", - { - ok: true - }, - { - body: { - body: "Hello there!" - } - } - ); - const MyOctokit = Octokit.plugin(restEndpointMethods); - - let warnCalledCount = 0; - const octokit = new MyOctokit({ - request: { - fetch: mock - }, - log: { - warn: (deprecation: Error) => { - warnCalledCount++; - expect(deprecation.message).toMatch( - '"number" parameter is deprecated for ".issues.createComment()". Use "issue_number" instead' - ); - } - } - }); - - // See https://developer.github.com/v3/issues/comments/#create-a-comment - const { data } = await octokit.issues.createComment({ - owner: "octocat", - repo: "hello-world", - number: 123, - issue_number: 456, - body: "Hello there!" - }); - - expect(data).toStrictEqual({ ok: true }); - expect(warnCalledCount).toEqual(1); - }); - - it("octokit.pullRequests.get", () => { - const mock = fetchMock - .sandbox() - .getOnce("path:/repos/octocat/hello-world/pulls/123", { - ok: true - }); - const MyOctokit = Octokit.plugin(restEndpointMethods); - let warnCalledCount = 0; - const octokit = new MyOctokit({ - log: { - warn: (deprecation: Error) => { - warnCalledCount++; - expect(deprecation.message).toMatch( - `[@octokit/plugin-rest-endpoint-methods] "octokit.pullRequests.*" methods are deprecated, use "octokit.pulls.*" instead` - ); - } - }, - request: { - fetch: mock - } - }); - octokit.pullRequests.get({ - owner: "octocat", - repo: "hello-world", - pull_number: 123 - }); - expect(warnCalledCount).toEqual(1); - }); - - it("octokit.gitdata.getCommit", () => { - const mock = fetchMock - .sandbox() - .getOnce("path:/repos/octocat/hello-world/git/commits/sha123", { - ok: true - }); - const MyOctokit = Octokit.plugin(restEndpointMethods); - let warnCalledCount = 0; - const octokit = new MyOctokit({ - log: { - warn: (deprecation: Error) => { - warnCalledCount++; - expect(deprecation.message).toMatch( - `[@octokit/plugin-rest-endpoint-methods] "octokit.gitdata.*" methods are deprecated, use "octokit.git.*" instead` - ); - } - }, - request: { - fetch: mock - } - }); - octokit.gitdata.getCommit({ - owner: "octocat", - repo: "hello-world", - commit_sha: "sha123" - }); - expect(warnCalledCount).toEqual(1); - }); + // it("renamed method", async () => { + // const mock = fetchMock.sandbox().get("path:/licenses", []); + // const MyOctokit = Octokit.plugin(restEndpointMethods); + // let warnCalledCount = 0; + // const octokit = new MyOctokit({ + // request: { + // fetch: mock + // }, + // log: { + // warn: (deprecation: Error) => { + // warnCalledCount++; + // expect(deprecation).toMatch( + // "octokit.licenses.list() has been renamed to octokit.licenses.listCommonlyUsed()" + // ); + // } + // } + // }); + // // See https://developer.github.com/v3/licenses/#list-commonly-used-licenses + // const { data } = await octokit.licenses.list(); + // expect(data).toStrictEqual([]); + // expect(warnCalledCount).toEqual(1); + // }); + // it("deprecated method", async () => { + // const mock = fetchMock + // .sandbox() + // .postOnce("path:/authorizations", { ok: true }); + // const MyOctokit = Octokit.plugin(restEndpointMethods); + // let warnCalledCount = 0; + // const octokit = new MyOctokit({ + // request: { + // fetch: mock + // }, + // log: { + // warn: (deprecation: Error) => { + // warnCalledCount++; + // expect(deprecation).toMatch( + // "octokit.oauthAuthorizations.createAuthorization() is deprecated, see https://developer.github.com/v3/oauth_authorizations/#create-a-new-authorization" + // ); + // } + // } + // }); + // // See https://developer.github.com/v3/licenses/#list-commonly-used-licenses + // const { data } = await octokit.oauthAuthorizations.createAuthorization(); + // expect(data).toStrictEqual({ ok: true }); + // expect(warnCalledCount).toEqual(1); + // }); + // it("deprecated parameter", async () => { + // const mock = fetchMock + // .sandbox() + // .getOnce("path:/repos/octocat/hello-world/commits/sha123", { + // ok: true + // }); + // const MyOctokit = Octokit.plugin(restEndpointMethods); + // let warnCalledCount = 0; + // const octokit = new MyOctokit({ + // request: { + // fetch: mock + // }, + // log: { + // warn: (deprecation: Error) => { + // warnCalledCount++; + // expect(deprecation).toMatch( + // '"commit_sha" parameter is deprecated for "octokit.repos.getCommit()". Use "ref" instead' + // ); + // } + // } + // }); + // // See https://developer.github.com/v3/issues/comments/#create-a-comment + // const { data } = await octokit.repos.getCommit({ + // owner: "octocat", + // repo: "hello-world", + // commit_sha: "sha123" + // }); + // expect(data).toStrictEqual({ ok: true }); + // expect(warnCalledCount).toEqual(1); + // }); + // it("deprecated parameter + new parameter", async () => { + // const mock = fetchMock.sandbox().post( + // "path:/repos/octocat/hello-world/issues/456/comments", + // { + // ok: true + // }, + // { + // body: { + // body: "Hello there!" + // } + // } + // ); + // const MyOctokit = Octokit.plugin(restEndpointMethods); + // let warnCalledCount = 0; + // const octokit = new MyOctokit({ + // request: { + // fetch: mock + // }, + // log: { + // warn: (deprecation: Error) => { + // warnCalledCount++; + // expect(deprecation).toMatch( + // '"number" parameter is deprecated for "octokit.issues.createComment()". Use "issue_number" instead' + // ); + // } + // } + // }); + // // See https://developer.github.com/v3/issues/comments/#create-a-comment + // const { data } = await octokit.issues.createComment({ + // owner: "octocat", + // repo: "hello-world", + // number: 123, + // issue_number: 456, + // body: "Hello there!" + // }); + // expect(data).toStrictEqual({ ok: true }); + // expect(warnCalledCount).toEqual(1); + // }); }); diff --git a/test/register-endpoints.test.ts b/test/register-endpoints.test.ts deleted file mode 100644 index 2e4cac69d..000000000 --- a/test/register-endpoints.test.ts +++ /dev/null @@ -1,35 +0,0 @@ -import fetchMock from "fetch-mock"; -import { Octokit } from "@octokit/core"; - -import { restEndpointMethods } from "../src"; - -describe("Deprecations", () => { - it("deprecated method", async () => { - const mock = fetchMock.sandbox().get("path:/baz", { ok: true }); - const MyOctokit = Octokit.plugin(restEndpointMethods); - const octokit = new MyOctokit({ - request: { - fetch: mock - } - }); - - expect(typeof octokit.registerEndpoints).toBe("function"); - - octokit.registerEndpoints({ - issues: { - fooBar: { - method: "GET", - url: "/baz" - } - } - }); - - // make sure .registerEndpoints does not remove other methods on the same scope - expect(typeof octokit.issues.get).toBe("function"); - - // @ts-ignore - const { data } = await octokit.issues.fooBar(); - - expect(data).toStrictEqual({ ok: true }); - }); -}); diff --git a/test/rest-endpoint-methods.test.ts b/test/rest-endpoint-methods.test.ts index 2cb78af76..2c77ba0c4 100644 --- a/test/rest-endpoint-methods.test.ts +++ b/test/rest-endpoint-methods.test.ts @@ -62,9 +62,96 @@ describe("REST API endpoint methods", () => { expect(data).toStrictEqual({ ok: true }); }); - it("deprecated endpoint methods have .endpoint() method, too", () => { + it("octokit.repos.uploadReleaseAsset()", async () => { + const mock = fetchMock.sandbox().postOnce( + "https://uploads.github.com/repos/octocat/hello-world/releases/123/assets", + { ok: true }, + { + headers: { + "content-type": "text/plain" + }, + query: { + name: "test.txt", + label: "test" + }, + matcher: (url, { body }) => { + expect(body).toEqual("test 1, 2"); + return true; + } + } + ); + const MyOctokit = Octokit.plugin(restEndpointMethods); - const octokit = new MyOctokit(); - expect(typeof octokit.teams.listMembersLegacy.endpoint).toEqual("function"); + const octokit = new MyOctokit({ + auth: "secret123", + request: { + fetch: mock + } + }); + + return octokit.repos + .uploadReleaseAsset({ + headers: { + "content-type": "text/plain" + }, + owner: "octocat", + repo: "hello-world", + release_id: 123, + data: "test 1, 2", + name: "test.txt", + label: "test" + }) + .catch(error => { + console.log(error); + + throw error; + }); + }); + + it("octokit.repos.addProtectedBranchRequiredStatusChecksContexts(): `contexts` option value is sent as request body without namespace", async () => { + const mock = fetchMock.sandbox().postOnce( + "https://api.github.com/repos/octocat/hello-world/branches/latest/protection/required_status_checks/contexts", + { ok: true }, + { + body: ["myci1", "myci2"] + } + ); + + const MyOctokit = Octokit.plugin(restEndpointMethods); + const octokit = new MyOctokit({ + auth: "secret123", + request: { + fetch: mock + } + }); + + return octokit.repos + .addProtectedBranchRequiredStatusChecksContexts({ + owner: "octocat", + repo: "hello-world", + branch: "latest", + contexts: ["myci1", "myci2"] + }) + .catch(error => { + console.log(error); + + throw error; + }); + }); + + it("octokit.apps.listInstallations(): method without options (octokit/rest.js#818)", async () => { + const mock = fetchMock + .sandbox() + .getOnce("https://api.github.com/app/installations", { ok: true }); + + const MyOctokit = Octokit.plugin(restEndpointMethods); + const octokit = new MyOctokit({ + auth: "secret123", + request: { + fetch: mock + } + }); + + return octokit.apps.listInstallations(); }); });