From 57b054add750f465c253904a40752ea6b1f90cd0 Mon Sep 17 00:00:00 2001 From: Derek Date: Wed, 10 Jul 2019 17:34:55 +0200 Subject: [PATCH] feat(ghe): add ghe-2.14 openapi docs * add openapi root doc for ghe-2.14 * generate operations for ghe-2.14 * make all ghe-2.14 tests pass w/ current openapi-compatible route-building rules * more strictly determine openapi-compliant defaults * parse object[] parameters' descriptions above definition table * clean up badly parsed string/array defaults * add missed enums * update ghe-2.14 caches --- .../activity/events/types/checkrunevent.html | 2 +- .../2.14/v3/activity/events/types/index.html | 2 +- .../enterprise/2.14/v3/checks/index.html | 1 + .../v3/checks/runs/create-a-check-run.html | 2 +- .../enterprise/2.14/v3/checks/runs/index.html | 2 +- .../enterprise/2.14/v3/search/index.html | 55 +- openapi/ghe-2.14/index.json | 2109 +++++++++++++++++ .../activity/check-starring-repo.json | 62 + .../activity/check-watching-repo-legacy.json | 62 + .../activity/delete-repo-subscription.json | 62 + .../activity/delete-thread-subscription.json | 53 + .../activity/get-repo-subscription.json | 62 + .../activity/get-thread-subscription.json | 79 + .../operations/activity/get-thread.json | 298 +++ .../activity/list-events-for-org.json | 82 + .../activity/list-events-for-user.json | 73 + .../operations/activity/list-feeds.json | 161 ++ .../activity/list-notifications-for-repo.json | 125 + .../activity/list-notifications.json | 107 + .../activity/list-public-events-for-org.json | 73 + .../list-public-events-for-repo-network.json | 82 + .../activity/list-public-events-for-user.json | 73 + .../activity/list-public-events.json | 64 + .../list-received-events-for-user.json | 73 + .../list-received-public-events-for-user.json | 73 + .../operations/activity/list-repo-events.json | 82 + ...t-repos-starred-by-authenticated-user.json | 97 + .../activity/list-repos-starred-by-user.json | 106 + .../activity/list-repos-watched-by-user.json | 78 + .../activity/list-stargazers-for-repo.json | 87 + ...-watched-repos-for-authenticated-user.json | 69 + .../activity/list-watchers-for-repo.json | 87 + .../operations/activity/mark-as-read.json | 64 + .../mark-notifications-as-read-for-repo.json | 82 + .../activity/mark-thread-as-read.json | 58 + .../activity/set-repo-subscription.json | 107 + .../activity/set-thread-subscription.json | 95 + .../operations/activity/star-repo.json | 62 + .../activity/stop-watching-repo-legacy.json | 62 + .../operations/activity/unstar-repo.json | 62 + .../activity/watch-repo-legacy.json | 62 + .../apps/add-repo-to-installation.json | 63 + .../apps/create-installation-token.json | 68 + .../operations/apps/get-authenticated.json | 121 + .../ghe-2.14/operations/apps/get-by-slug.json | 127 + .../operations/apps/get-installation.json | 153 ++ .../operations/apps/get-org-installation.json | 185 ++ .../apps/get-repo-installation.json | 194 ++ .../apps/get-user-installation.json | 188 ++ ...allation-repos-for-authenticated-user.json | 391 +++ ...-installations-for-authenticated-user.json | 218 ++ .../operations/apps/list-installations.json | 70 + .../ghe-2.14/operations/apps/list-repos.json | 368 +++ .../apps/remove-repo-from-installation.json | 63 + .../operations/checks/create-suite.json | 490 ++++ .../ghe-2.14/operations/checks/create.json | 448 ++++ .../ghe-2.14/operations/checks/get-suite.json | 481 ++++ openapi/ghe-2.14/operations/checks/get.json | 275 +++ .../operations/checks/list-annotations.json | 97 + .../operations/checks/list-for-ref.json | 349 +++ .../operations/checks/list-for-suite.json | 349 +++ .../checks/list-suites-for-ref.json | 530 +++++ .../operations/checks/request-suites.json | 86 + .../checks/set-suites-preferences.json | 430 ++++ .../ghe-2.14/operations/checks/update.json | 453 ++++ .../codes_of_conduct/get-conduct-code.json | 74 + .../codes_of_conduct/get-for-repo.json | 83 + .../codes_of_conduct/list-conduct-codes.json | 50 + openapi/ghe-2.14/operations/emojis/get.json | 49 + .../add-authorized-ssh-key.json | 67 + .../check-configuration-status.json | 73 + .../check-maintenance-status.json | 76 + .../enterprise-admin/create-global-hook.json | 156 ++ .../create-impersonation-o-auth-token.json | 129 + .../enterprise-admin/create-org.json | 115 + .../create-pre-receive-environment.json | 116 + .../create-pre-receive-hook.json | 173 ++ .../enterprise-admin/create-user.json | 128 + .../enterprise-admin/delete-global-hook.json | 54 + .../delete-impersonation-o-auth-token.json | 53 + .../delete-pre-receive-environment.json | 53 + .../delete-pre-receive-hook.json | 53 + .../enterprise-admin/delete-public-key.json | 53 + .../enterprise-admin/delete-user.json | 53 + ...e-site-administrator-to-ordinary-user.json | 53 + .../enable-or-disable-maintenance-mode.json | 94 + .../enterprise-admin/get-global-hook.json | 109 + .../get-license-information.json | 70 + ...e-receive-environment-download-status.json | 80 + .../get-pre-receive-environment.json | 53 + .../get-pre-receive-hook-for-org.json | 62 + .../get-pre-receive-hook-for-repo.json | 71 + .../get-pre-receive-hook.json | 53 + .../enterprise-admin/get-type-stats.json | 213 ++ .../enterprise-admin/list-global-hooks.json | 70 + .../list-pre-receive-environments.json | 64 + .../list-pre-receive-hooks-for-org.json | 73 + .../list-pre-receive-hooks-for-repo.json | 82 + .../list-pre-receive-hooks.json | 64 + .../enterprise-admin/modify-settings.json | 62 + .../enterprise-admin/ping-global-hook.json | 54 + ...e-ordinary-user-to-site-administrator.json | 53 + .../enterprise-admin/queue-indexing-job.json | 73 + .../remove-authorized-ssh-key.json | 67 + ...verrides-for-pre-receive-hook-for-org.json | 62 + ...errides-for-pre-receive-hook-for-repo.json | 91 + .../enterprise-admin/rename-org.json | 85 + .../enterprise-admin/rename-user.json | 85 + .../retrieve-authorized-ssh-keys.json | 49 + .../enterprise-admin/retrieve-settings.json | 452 ++++ .../start-configuration-process.json | 49 + .../enterprise-admin/suspend-user.json | 68 + .../sync-ldap-mapping-for-team.json | 64 + .../sync-ldap-mapping-for-user.json | 64 + ...gger-pre-receive-environment-download.json | 73 + .../enterprise-admin/unsuspend-user.json | 68 + .../enterprise-admin/update-global-hook.json | 154 ++ .../update-ldap-mapping-for-team.json | 112 + .../update-ldap-mapping-for-user.json | 133 ++ .../update-pre-receive-environment.json | 121 + ...-pre-receive-hook-enforcement-for-org.json | 85 + ...pre-receive-hook-enforcement-for-repo.json | 91 + .../update-pre-receive-hook.json | 139 ++ .../enterprise-admin/upgrade-license.json | 64 + .../upload-license-for-first-time.json | 75 + .../operations/gists/check-is-starred.json | 53 + .../operations/gists/create-comment.json | 156 ++ openapi/ghe-2.14/operations/gists/create.json | 470 ++++ .../operations/gists/delete-comment.json | 62 + openapi/ghe-2.14/operations/gists/delete.json | 53 + openapi/ghe-2.14/operations/gists/fork.json | 193 ++ .../operations/gists/get-comment.json | 147 ++ .../operations/gists/get-revision.json | 455 ++++ openapi/ghe-2.14/operations/gists/get.json | 446 ++++ .../operations/gists/list-comments.json | 78 + .../operations/gists/list-commits.json | 78 + .../ghe-2.14/operations/gists/list-forks.json | 78 + .../gists/list-public-for-user.json | 87 + .../operations/gists/list-public.json | 78 + .../operations/gists/list-starred.json | 78 + openapi/ghe-2.14/operations/gists/list.json | 78 + openapi/ghe-2.14/operations/gists/star.json | 53 + openapi/ghe-2.14/operations/gists/unstar.json | 53 + .../operations/gists/update-comment.json | 165 ++ openapi/ghe-2.14/operations/gists/update.json | 475 ++++ .../ghe-2.14/operations/git/create-blob.json | 99 + .../operations/git/create-commit.json | 223 ++ .../ghe-2.14/operations/git/create-ref.json | 116 + .../ghe-2.14/operations/git/create-tag.json | 186 ++ .../ghe-2.14/operations/git/create-tree.json | 161 ++ .../ghe-2.14/operations/git/delete-ref.json | 71 + openapi/ghe-2.14/operations/git/get-blob.json | 94 + .../ghe-2.14/operations/git/get-commit.json | 158 ++ openapi/ghe-2.14/operations/git/get-ref.json | 71 + openapi/ghe-2.14/operations/git/get-tag.json | 139 ++ openapi/ghe-2.14/operations/git/get-tree.json | 82 + .../ghe-2.14/operations/git/update-ref.json | 125 + .../operations/gitignore/get-template.json | 67 + .../operations/gitignore/list-templates.json | 49 + .../operations/issues/add-assignees.json | 516 ++++ .../operations/issues/add-labels.json | 97 + .../operations/issues/check-assignee.json | 71 + .../operations/issues/create-comment.json | 187 ++ .../operations/issues/create-label.json | 118 + .../operations/issues/create-milestone.json | 209 ++ .../ghe-2.14/operations/issues/create.json | 562 +++++ .../operations/issues/delete-comment.json | 71 + .../operations/issues/delete-label.json | 71 + .../operations/issues/delete-milestone.json | 81 + .../operations/issues/get-comment.json | 179 ++ .../ghe-2.14/operations/issues/get-event.json | 553 +++++ .../ghe-2.14/operations/issues/get-label.json | 100 + .../operations/issues/get-milestone.json | 193 ++ openapi/ghe-2.14/operations/issues/get.json | 537 +++++ .../operations/issues/list-assignees.json | 87 + .../issues/list-comments-for-repo.json | 103 + .../operations/issues/list-comments.json | 115 + .../issues/list-events-for-repo.json | 87 + .../issues/list-events-for-timeline.json | 107 + .../operations/issues/list-events.json | 106 + .../issues/list-for-authenticated-user.json | 148 ++ .../operations/issues/list-for-org.json | 157 ++ .../operations/issues/list-for-repo.json | 185 ++ .../issues/list-labels-for-milestone.json | 106 + .../issues/list-labels-for-repo.json | 87 + .../issues/list-labels-on-issue.json | 106 + .../issues/list-milestones-for-repo.json | 130 + openapi/ghe-2.14/operations/issues/list.json | 148 ++ openapi/ghe-2.14/operations/issues/lock.json | 102 + .../operations/issues/remove-assignees.json | 496 ++++ .../operations/issues/remove-label.json | 95 + .../operations/issues/remove-labels.json | 81 + .../operations/issues/replace-labels.json | 97 + .../ghe-2.14/operations/issues/unlock.json | 81 + .../operations/issues/update-comment.json | 177 ++ .../operations/issues/update-milestone.json | 225 ++ .../ghe-2.14/operations/issues/update.json | 587 +++++ .../operations/licenses/get-for-repo.json | 137 ++ openapi/ghe-2.14/operations/licenses/get.json | 109 + .../licenses/list-commonly-used.json | 63 + .../operations/markdown/render-raw.json | 71 + .../ghe-2.14/operations/markdown/render.json | 80 + openapi/ghe-2.14/operations/meta/get.json | 61 + .../check-authorization.json | 179 ++ .../create-authorization.json | 143 ++ .../delete-authorization.json | 53 + .../oauth_authorizations/delete-grant.json | 53 + .../get-authorization.json | 111 + .../oauth_authorizations/get-grant.json | 93 + ...authorization-for-app-and-fingerprint.json | 109 + .../get-or-create-authorization-for-app.json | 90 + .../list-authorizations.json | 69 + .../oauth_authorizations/list-grants.json | 69 + .../reset-authorization.json | 179 ++ .../revoke-authorization-for-application.json | 62 + .../revoke-grant-for-application.json | 62 + .../update-authorization.json | 155 ++ .../orgs/add-or-update-membership.json | 202 ++ .../operations/orgs/check-membership.json | 62 + .../orgs/check-public-membership.json | 62 + .../operations/orgs/conceal-membership.json | 62 + ...onvert-member-to-outside-collaborator.json | 62 + .../ghe-2.14/operations/orgs/create-hook.json | 158 ++ .../ghe-2.14/operations/orgs/delete-hook.json | 62 + .../ghe-2.14/operations/orgs/get-hook.json | 108 + ...get-membership-for-authenticated-user.json | 173 ++ .../operations/orgs/get-membership.json | 62 + openapi/ghe-2.14/operations/orgs/get.json | 180 ++ .../orgs/list-for-authenticated-user.json | 69 + .../operations/orgs/list-for-user.json | 78 + .../ghe-2.14/operations/orgs/list-hooks.json | 78 + .../operations/orgs/list-members.json | 107 + .../operations/orgs/list-memberships.json | 82 + .../orgs/list-outside-collaborators.json | 92 + .../operations/orgs/list-public-members.json | 78 + openapi/ghe-2.14/operations/orgs/list.json | 78 + .../ghe-2.14/operations/orgs/ping-hook.json | 62 + .../operations/orgs/publicize-membership.json | 62 + .../operations/orgs/remove-member.json | 62 + .../operations/orgs/remove-membership.json | 62 + .../orgs/remove-outside-collaborator.json | 62 + .../ghe-2.14/operations/orgs/update-hook.json | 159 ++ .../operations/orgs/update-membership.json | 194 ++ openapi/ghe-2.14/operations/orgs/update.json | 239 ++ .../operations/projects/add-collaborator.json | 84 + .../operations/projects/create-card.json | 168 ++ .../operations/projects/create-column.json | 72 + .../operations/projects/create-for-org.json | 199 ++ .../operations/projects/create-for-repo.json | 208 ++ .../operations/projects/delete-card.json | 54 + .../operations/projects/delete-column.json | 54 + .../ghe-2.14/operations/projects/delete.json | 54 + .../operations/projects/get-card.json | 54 + .../operations/projects/get-column.json | 54 + openapi/ghe-2.14/operations/projects/get.json | 177 ++ .../operations/projects/list-cards.json | 79 + .../projects/list-collaborators.json | 94 + .../operations/projects/list-columns.json | 79 + .../operations/projects/list-for-org.json | 94 + .../operations/projects/list-for-repo.json | 103 + .../operations/projects/move-card.json | 82 + .../operations/projects/move-column.json | 78 + .../projects/remove-collaborator.json | 63 + .../review-user-permission-level.json | 133 ++ .../operations/projects/update-card.json | 69 + .../operations/projects/update-column.json | 72 + .../ghe-2.14/operations/projects/update.json | 212 ++ .../operations/pulls/check-if-merged.json | 81 + .../pulls/create-comment-reply.json | 248 ++ .../operations/pulls/create-comment.json | 258 ++ .../operations/pulls/create-from-issue.json | 1528 ++++++++++++ .../pulls/create-review-request.json | 1468 ++++++++++++ .../operations/pulls/create-review.json | 244 ++ openapi/ghe-2.14/operations/pulls/create.json | 1532 ++++++++++++ .../operations/pulls/delete-comment.json | 71 + .../pulls/delete-pending-review.json | 199 ++ .../pulls/delete-review-request.json | 111 + .../operations/pulls/dismiss-review.json | 217 ++ .../operations/pulls/get-comment.json | 215 ++ .../pulls/get-comments-for-review.json | 115 + .../ghe-2.14/operations/pulls/get-review.json | 199 ++ openapi/ghe-2.14/operations/pulls/get.json | 1515 ++++++++++++ .../pulls/list-comments-for-repo.json | 123 + .../operations/pulls/list-comments.json | 142 ++ .../operations/pulls/list-commits.json | 106 + .../ghe-2.14/operations/pulls/list-files.json | 106 + .../pulls/list-review-requests.json | 212 ++ .../operations/pulls/list-reviews.json | 106 + openapi/ghe-2.14/operations/pulls/list.json | 149 ++ openapi/ghe-2.14/operations/pulls/merge.json | 113 + .../operations/pulls/submit-review.json | 226 ++ .../operations/pulls/update-comment.json | 233 ++ openapi/ghe-2.14/operations/pulls/update.json | 1550 ++++++++++++ .../ghe-2.14/operations/rate_limit/get.json | 113 + .../reactions/create-for-commit-comment.json | 179 ++ .../reactions/create-for-issue-comment.json | 179 ++ .../reactions/create-for-issue.json | 189 ++ ...reate-for-pull-request-review-comment.json | 179 ++ .../create-for-team-discussion-comment.json | 179 ++ .../reactions/create-for-team-discussion.json | 170 ++ .../ghe-2.14/operations/reactions/delete.json | 54 + .../reactions/list-for-commit-comment.json | 116 + .../reactions/list-for-issue-comment.json | 116 + .../operations/reactions/list-for-issue.json | 126 + .../list-for-pull-request-review-comment.json | 116 + .../list-for-team-discussion-comment.json | 116 + .../reactions/list-for-team-discussion.json | 107 + .../operations/repos/accept-invitation.json | 53 + .../operations/repos/add-collaborator.json | 92 + .../operations/repos/add-deploy-key.json | 117 + ...dd-protected-branch-admin-enforcement.json | 85 + ...-protected-branch-required-signatures.json | 86 + ...ranch-required-status-checks-contexts.json | 90 + ...dd-protected-branch-team-restrictions.json | 90 + ...dd-protected-branch-user-restrictions.json | 90 + .../operations/repos/check-collaborator.json | 71 + .../operations/repos/compare-commits.json | 80 + .../repos/create-commit-comment.json | 211 ++ .../repos/create-deployment-status.json | 224 ++ .../operations/repos/create-deployment.json | 121 + .../repos/create-for-authenticated-user.json | 428 ++++ .../operations/repos/create-fork.json | 383 +++ .../operations/repos/create-hook.json | 190 ++ .../operations/repos/create-in-org.json | 437 ++++ .../repos/create-or-update-file.json | 299 +++ .../operations/repos/create-release.json | 221 ++ .../operations/repos/create-status.json | 205 ++ .../operations/repos/decline-invitation.json | 53 + .../repos/delete-commit-comment.json | 71 + .../operations/repos/delete-download.json | 71 + .../operations/repos/delete-file.json | 230 ++ .../operations/repos/delete-hook.json | 71 + .../operations/repos/delete-invitation.json | 71 + .../repos/delete-release-asset.json | 71 + .../operations/repos/delete-release.json | 71 + openapi/ghe-2.14/operations/repos/delete.json | 62 + .../operations/repos/get-archive-link.json | 85 + .../repos/get-branch-protection.json | 364 +++ .../ghe-2.14/operations/repos/get-branch.json | 260 ++ .../repos/get-code-frequency-stats.json | 67 + .../get-collaborator-permission-level.json | 71 + .../repos/get-combined-status-for-ref.json | 346 +++ .../repos/get-commit-activity-stats.json | 67 + .../operations/repos/get-commit-comment.json | 171 ++ .../ghe-2.14/operations/repos/get-commit.json | 361 +++ .../operations/repos/get-contents.json | 80 + .../repos/get-contributors-stats.json | 67 + .../operations/repos/get-deploy-key.json | 100 + .../repos/get-deployment-status.json | 183 ++ .../operations/repos/get-deployment.json | 188 ++ .../operations/repos/get-download.json | 103 + .../ghe-2.14/operations/repos/get-hook.json | 140 ++ .../repos/get-latest-pages-build.json | 155 ++ .../operations/repos/get-latest-release.json | 280 +++ .../operations/repos/get-pages-build.json | 164 ++ .../ghe-2.14/operations/repos/get-pages.json | 96 + .../repos/get-participation-stats.json | 82 + ...et-protected-branch-admin-enforcement.json | 71 + ...ranch-pull-request-review-enforcement.json | 71 + ...-protected-branch-required-signatures.json | 86 + ...otected-branch-required-status-checks.json | 94 + .../get-protected-branch-restrictions.json | 71 + .../repos/get-punch-card-stats.json | 67 + .../ghe-2.14/operations/repos/get-readme.json | 126 + .../operations/repos/get-release-asset.json | 174 ++ .../operations/repos/get-release-by-tag.json | 289 +++ .../operations/repos/get-release.json | 289 +++ openapi/ghe-2.14/operations/repos/get.json | 1050 ++++++++ .../repos/list-assets-for-release.json | 96 + .../operations/repos/list-branches.json | 96 + .../operations/repos/list-collaborators.json | 102 + .../repos/list-comments-for-commit.json | 106 + .../repos/list-commit-comments.json | 87 + .../operations/repos/list-commits.json | 132 ++ .../operations/repos/list-contributors.json | 91 + .../operations/repos/list-deploy-keys.json | 87 + .../repos/list-deployment-statuses.json | 96 + .../operations/repos/list-deployments.json | 127 + .../operations/repos/list-downloads.json | 87 + .../operations/repos/list-for-org.json | 96 + .../operations/repos/list-for-user.json | 117 + .../ghe-2.14/operations/repos/list-forks.json | 102 + .../ghe-2.14/operations/repos/list-hooks.json | 87 + ...st-invitations-for-authenticated-user.json | 69 + .../operations/repos/list-invitations.json | 87 + .../operations/repos/list-languages.json | 76 + .../operations/repos/list-pages-builds.json | 87 + ...ranch-required-status-checks-contexts.json | 71 + ...st-protected-branch-team-restrictions.json | 91 + ...st-protected-branch-user-restrictions.json | 71 + .../operations/repos/list-public.json | 88 + .../operations/repos/list-releases.json | 87 + .../repos/list-statuses-for-ref.json | 96 + .../ghe-2.14/operations/repos/list-tags.json | 87 + .../ghe-2.14/operations/repos/list-teams.json | 87 + .../operations/repos/list-topics.json | 76 + openapi/ghe-2.14/operations/repos/list.json | 135 ++ openapi/ghe-2.14/operations/repos/merge.json | 89 + .../ghe-2.14/operations/repos/ping-hook.json | 71 + .../repos/remove-branch-protection.json | 71 + .../operations/repos/remove-collaborator.json | 71 + .../operations/repos/remove-deploy-key.json | 71 + ...ve-protected-branch-admin-enforcement.json | 71 + ...ranch-pull-request-review-enforcement.json | 71 + ...-protected-branch-required-signatures.json | 72 + ...ranch-required-status-checks-contexts.json | 90 + ...otected-branch-required-status-checks.json | 71 + .../remove-protected-branch-restrictions.json | 71 + ...ve-protected-branch-team-restrictions.json | 90 + ...ve-protected-branch-user-restrictions.json | 90 + ...ranch-required-status-checks-contexts.json | 90 + ...ce-protected-branch-team-restrictions.json | 90 + ...ce-protected-branch-user-restrictions.json | 90 + .../operations/repos/replace-topics.json | 97 + .../operations/repos/request-page-build.json | 77 + .../operations/repos/test-push-hook.json | 71 + .../ghe-2.14/operations/repos/transfer.json | 391 +++ .../repos/update-branch-protection.json | 468 ++++ .../repos/update-commit-comment.json | 189 ++ .../operations/repos/update-hook.json | 205 ++ .../operations/repos/update-invitation.json | 434 ++++ ...ranch-pull-request-review-enforcement.json | 251 ++ ...otected-branch-required-status-checks.json | 116 + .../repos/update-release-asset.json | 193 ++ .../operations/repos/update-release.json | 324 +++ openapi/ghe-2.14/operations/repos/update.json | 1106 +++++++++ openapi/ghe-2.14/operations/search/code.json | 99 + .../ghe-2.14/operations/search/commits.json | 101 + .../operations/search/email-legacy.json | 53 + .../search/issues-and-pull-requests.json | 123 + .../operations/search/issues-legacy.json | 84 + .../ghe-2.14/operations/search/labels.json | 89 + .../operations/search/repos-legacy.json | 98 + openapi/ghe-2.14/operations/search/repos.json | 102 + .../ghe-2.14/operations/search/topics.json | 53 + .../operations/search/users-legacy.json | 89 + openapi/ghe-2.14/operations/search/users.json | 101 + .../ghe-2.14/operations/teams/add-member.json | 62 + .../teams/add-or-update-membership.json | 82 + .../teams/add-or-update-project.json | 83 + .../operations/teams/add-or-update-repo.json | 91 + .../operations/teams/check-manages-repo.json | 71 + .../teams/create-discussion-comment.json | 210 ++ .../operations/teams/create-discussion.json | 226 ++ openapi/ghe-2.14/operations/teams/create.json | 254 ++ .../teams/delete-discussion-comment.json | 72 + .../operations/teams/delete-discussion.json | 63 + openapi/ghe-2.14/operations/teams/delete.json | 53 + .../teams/get-discussion-comment.json | 201 ++ .../operations/teams/get-discussion.json | 207 ++ .../ghe-2.14/operations/teams/get-member.json | 62 + .../operations/teams/get-membership.json | 62 + openapi/ghe-2.14/operations/teams/get.json | 192 ++ .../ghe-2.14/operations/teams/list-child.json | 74 + .../teams/list-discussion-comments.json | 102 + .../operations/teams/list-discussions.json | 93 + .../teams/list-for-authenticated-user.json | 69 + .../operations/teams/list-members.json | 93 + .../operations/teams/list-projects.json | 79 + .../ghe-2.14/operations/teams/list-repos.json | 78 + openapi/ghe-2.14/operations/teams/list.json | 78 + .../operations/teams/remove-member.json | 62 + .../operations/teams/remove-membership.json | 62 + .../operations/teams/remove-project.json | 62 + .../operations/teams/remove-repo.json | 71 + .../operations/teams/review-project.json | 186 ++ .../teams/update-discussion-comment.json | 219 ++ .../operations/teams/update-discussion.json | 226 ++ openapi/ghe-2.14/operations/teams/update.json | 236 ++ .../ghe-2.14/operations/users/add-emails.json | 49 + .../users/check-following-for-user.json | 62 + .../operations/users/check-following.json | 53 + .../operations/users/create-gpg-key.json | 157 ++ .../operations/users/create-public-key.json | 92 + .../operations/users/delete-emails.json | 44 + .../operations/users/delete-gpg-key.json | 53 + .../operations/users/delete-public-key.json | 53 + openapi/ghe-2.14/operations/users/follow.json | 53 + .../operations/users/get-authenticated.json | 44 + .../operations/users/get-by-username.json | 154 ++ .../users/get-context-for-user.json | 78 + .../operations/users/get-gpg-key.json | 151 ++ .../operations/users/get-public-key.json | 82 + .../operations/users/list-emails.json | 69 + ...list-followers-for-authenticated-user.json | 69 + .../users/list-followers-for-user.json | 78 + ...list-following-for-authenticated-user.json | 69 + .../users/list-following-for-user.json | 78 + .../users/list-gpg-keys-for-user.json | 78 + .../operations/users/list-gpg-keys.json | 69 + .../operations/users/list-public-emails.json | 69 + .../users/list-public-keys-for-user.json | 78 + .../operations/users/list-public-keys.json | 69 + openapi/ghe-2.14/operations/users/list.json | 78 + .../ghe-2.14/operations/users/unfollow.json | 53 + .../users/update-authenticated.json | 222 ++ routes/ghe-2.14/activity.json | 6 +- routes/ghe-2.14/activity/mark-as-read.json | 3 +- .../mark-notifications-as-read-for-repo.json | 3 +- routes/ghe-2.14/checks.json | 2 +- routes/ghe-2.14/checks/create.json | 2 +- routes/ghe-2.14/enterprise-admin.json | 6 +- .../enterprise-admin/create-global-hook.json | 3 +- .../enterprise-admin/update-global-hook.json | 3 +- routes/ghe-2.14/git.json | 2 +- routes/ghe-2.14/git/create-blob.json | 2 +- routes/ghe-2.14/index.json | 179 +- routes/ghe-2.14/orgs.json | 8 +- routes/ghe-2.14/orgs/create-hook.json | 4 +- routes/ghe-2.14/orgs/update-hook.json | 4 +- routes/ghe-2.14/pulls.json | 3 +- routes/ghe-2.14/pulls/list.json | 3 +- routes/ghe-2.14/repos.json | 118 +- .../repos/create-deployment-status.json | 8 +- routes/ghe-2.14/repos/create-deployment.json | 7 +- routes/ghe-2.14/repos/create-file.json | 9 +- routes/ghe-2.14/repos/create-hook.json | 4 +- .../ghe-2.14/repos/create-or-update-file.json | 9 +- routes/ghe-2.14/repos/create-release.json | 3 +- routes/ghe-2.14/repos/delete-file.json | 3 +- routes/ghe-2.14/repos/get-contents.json | 3 +- routes/ghe-2.14/repos/get-readme.json | 3 +- routes/ghe-2.14/repos/list-commits.json | 3 +- routes/ghe-2.14/repos/list-for-user.json | 3 +- routes/ghe-2.14/repos/list.json | 3 +- routes/ghe-2.14/repos/update-file.json | 9 +- routes/ghe-2.14/repos/update-hook.json | 4 +- routes/ghe-2.14/repos/update-release.json | 3 +- routes/ghe-2.14/search.json | 27 +- routes/ghe-2.14/search/code.json | 3 +- routes/ghe-2.14/search/commits.json | 3 +- .../search/issues-and-pull-requests.json | 3 +- routes/ghe-2.14/search/issues.json | 3 +- routes/ghe-2.14/search/labels.json | 3 +- routes/ghe-2.14/search/repos-legacy.json | 3 +- routes/ghe-2.14/search/repos.json | 3 +- routes/ghe-2.14/search/users-legacy.json | 3 +- routes/ghe-2.14/search/users.json | 3 +- routes/ghe-2.14/teams.json | 7 +- routes/ghe-2.14/teams/create.json | 3 +- routes/ghe-2.14/teams/update.json | 4 + 541 files changed, 73958 insertions(+), 370 deletions(-) create mode 100644 openapi/ghe-2.14/index.json create mode 100644 openapi/ghe-2.14/operations/activity/check-starring-repo.json create mode 100644 openapi/ghe-2.14/operations/activity/check-watching-repo-legacy.json create mode 100644 openapi/ghe-2.14/operations/activity/delete-repo-subscription.json create mode 100644 openapi/ghe-2.14/operations/activity/delete-thread-subscription.json create mode 100644 openapi/ghe-2.14/operations/activity/get-repo-subscription.json create mode 100644 openapi/ghe-2.14/operations/activity/get-thread-subscription.json create mode 100644 openapi/ghe-2.14/operations/activity/get-thread.json create mode 100644 openapi/ghe-2.14/operations/activity/list-events-for-org.json create mode 100644 openapi/ghe-2.14/operations/activity/list-events-for-user.json create mode 100644 openapi/ghe-2.14/operations/activity/list-feeds.json create mode 100644 openapi/ghe-2.14/operations/activity/list-notifications-for-repo.json create mode 100644 openapi/ghe-2.14/operations/activity/list-notifications.json create mode 100644 openapi/ghe-2.14/operations/activity/list-public-events-for-org.json create mode 100644 openapi/ghe-2.14/operations/activity/list-public-events-for-repo-network.json create mode 100644 openapi/ghe-2.14/operations/activity/list-public-events-for-user.json create mode 100644 openapi/ghe-2.14/operations/activity/list-public-events.json create mode 100644 openapi/ghe-2.14/operations/activity/list-received-events-for-user.json create mode 100644 openapi/ghe-2.14/operations/activity/list-received-public-events-for-user.json create mode 100644 openapi/ghe-2.14/operations/activity/list-repo-events.json create mode 100644 openapi/ghe-2.14/operations/activity/list-repos-starred-by-authenticated-user.json create mode 100644 openapi/ghe-2.14/operations/activity/list-repos-starred-by-user.json create mode 100644 openapi/ghe-2.14/operations/activity/list-repos-watched-by-user.json create mode 100644 openapi/ghe-2.14/operations/activity/list-stargazers-for-repo.json create mode 100644 openapi/ghe-2.14/operations/activity/list-watched-repos-for-authenticated-user.json create mode 100644 openapi/ghe-2.14/operations/activity/list-watchers-for-repo.json create mode 100644 openapi/ghe-2.14/operations/activity/mark-as-read.json create mode 100644 openapi/ghe-2.14/operations/activity/mark-notifications-as-read-for-repo.json create mode 100644 openapi/ghe-2.14/operations/activity/mark-thread-as-read.json create mode 100644 openapi/ghe-2.14/operations/activity/set-repo-subscription.json create mode 100644 openapi/ghe-2.14/operations/activity/set-thread-subscription.json create mode 100644 openapi/ghe-2.14/operations/activity/star-repo.json create mode 100644 openapi/ghe-2.14/operations/activity/stop-watching-repo-legacy.json create mode 100644 openapi/ghe-2.14/operations/activity/unstar-repo.json create mode 100644 openapi/ghe-2.14/operations/activity/watch-repo-legacy.json create mode 100644 openapi/ghe-2.14/operations/apps/add-repo-to-installation.json create mode 100644 openapi/ghe-2.14/operations/apps/create-installation-token.json create mode 100644 openapi/ghe-2.14/operations/apps/get-authenticated.json create mode 100644 openapi/ghe-2.14/operations/apps/get-by-slug.json create mode 100644 openapi/ghe-2.14/operations/apps/get-installation.json create mode 100644 openapi/ghe-2.14/operations/apps/get-org-installation.json create mode 100644 openapi/ghe-2.14/operations/apps/get-repo-installation.json create mode 100644 openapi/ghe-2.14/operations/apps/get-user-installation.json create mode 100644 openapi/ghe-2.14/operations/apps/list-installation-repos-for-authenticated-user.json create mode 100644 openapi/ghe-2.14/operations/apps/list-installations-for-authenticated-user.json create mode 100644 openapi/ghe-2.14/operations/apps/list-installations.json create mode 100644 openapi/ghe-2.14/operations/apps/list-repos.json create mode 100644 openapi/ghe-2.14/operations/apps/remove-repo-from-installation.json create mode 100644 openapi/ghe-2.14/operations/checks/create-suite.json create mode 100644 openapi/ghe-2.14/operations/checks/create.json create mode 100644 openapi/ghe-2.14/operations/checks/get-suite.json create mode 100644 openapi/ghe-2.14/operations/checks/get.json create mode 100644 openapi/ghe-2.14/operations/checks/list-annotations.json create mode 100644 openapi/ghe-2.14/operations/checks/list-for-ref.json create mode 100644 openapi/ghe-2.14/operations/checks/list-for-suite.json create mode 100644 openapi/ghe-2.14/operations/checks/list-suites-for-ref.json create mode 100644 openapi/ghe-2.14/operations/checks/request-suites.json create mode 100644 openapi/ghe-2.14/operations/checks/set-suites-preferences.json create mode 100644 openapi/ghe-2.14/operations/checks/update.json create mode 100644 openapi/ghe-2.14/operations/codes_of_conduct/get-conduct-code.json create mode 100644 openapi/ghe-2.14/operations/codes_of_conduct/get-for-repo.json create mode 100644 openapi/ghe-2.14/operations/codes_of_conduct/list-conduct-codes.json create mode 100644 openapi/ghe-2.14/operations/emojis/get.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/add-authorized-ssh-key.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/check-configuration-status.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/check-maintenance-status.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/create-global-hook.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/create-impersonation-o-auth-token.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/create-org.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/create-pre-receive-environment.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/create-pre-receive-hook.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/create-user.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/delete-global-hook.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/delete-impersonation-o-auth-token.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/delete-pre-receive-environment.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/delete-pre-receive-hook.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/delete-public-key.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/delete-user.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/demote-site-administrator-to-ordinary-user.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/enable-or-disable-maintenance-mode.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/get-global-hook.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/get-license-information.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/get-pre-receive-environment-download-status.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/get-pre-receive-environment.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/get-pre-receive-hook-for-org.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/get-pre-receive-hook-for-repo.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/get-pre-receive-hook.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/get-type-stats.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/list-global-hooks.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/list-pre-receive-environments.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/list-pre-receive-hooks-for-org.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/list-pre-receive-hooks-for-repo.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/list-pre-receive-hooks.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/modify-settings.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/ping-global-hook.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/promote-ordinary-user-to-site-administrator.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/queue-indexing-job.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/remove-authorized-ssh-key.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/remove-enforcement-overrides-for-pre-receive-hook-for-org.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/remove-enforcement-overrides-for-pre-receive-hook-for-repo.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/rename-org.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/rename-user.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/retrieve-authorized-ssh-keys.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/retrieve-settings.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/start-configuration-process.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/suspend-user.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/sync-ldap-mapping-for-team.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/sync-ldap-mapping-for-user.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/trigger-pre-receive-environment-download.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/unsuspend-user.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/update-global-hook.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/update-ldap-mapping-for-team.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/update-ldap-mapping-for-user.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/update-pre-receive-environment.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/update-pre-receive-hook-enforcement-for-org.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/update-pre-receive-hook-enforcement-for-repo.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/update-pre-receive-hook.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/upgrade-license.json create mode 100644 openapi/ghe-2.14/operations/enterprise-admin/upload-license-for-first-time.json create mode 100644 openapi/ghe-2.14/operations/gists/check-is-starred.json create mode 100644 openapi/ghe-2.14/operations/gists/create-comment.json create mode 100644 openapi/ghe-2.14/operations/gists/create.json create mode 100644 openapi/ghe-2.14/operations/gists/delete-comment.json create mode 100644 openapi/ghe-2.14/operations/gists/delete.json create mode 100644 openapi/ghe-2.14/operations/gists/fork.json create mode 100644 openapi/ghe-2.14/operations/gists/get-comment.json create mode 100644 openapi/ghe-2.14/operations/gists/get-revision.json create mode 100644 openapi/ghe-2.14/operations/gists/get.json create mode 100644 openapi/ghe-2.14/operations/gists/list-comments.json create mode 100644 openapi/ghe-2.14/operations/gists/list-commits.json create mode 100644 openapi/ghe-2.14/operations/gists/list-forks.json create mode 100644 openapi/ghe-2.14/operations/gists/list-public-for-user.json create mode 100644 openapi/ghe-2.14/operations/gists/list-public.json create mode 100644 openapi/ghe-2.14/operations/gists/list-starred.json create mode 100644 openapi/ghe-2.14/operations/gists/list.json create mode 100644 openapi/ghe-2.14/operations/gists/star.json create mode 100644 openapi/ghe-2.14/operations/gists/unstar.json create mode 100644 openapi/ghe-2.14/operations/gists/update-comment.json create mode 100644 openapi/ghe-2.14/operations/gists/update.json create mode 100644 openapi/ghe-2.14/operations/git/create-blob.json create mode 100644 openapi/ghe-2.14/operations/git/create-commit.json create mode 100644 openapi/ghe-2.14/operations/git/create-ref.json create mode 100644 openapi/ghe-2.14/operations/git/create-tag.json create mode 100644 openapi/ghe-2.14/operations/git/create-tree.json create mode 100644 openapi/ghe-2.14/operations/git/delete-ref.json create mode 100644 openapi/ghe-2.14/operations/git/get-blob.json create mode 100644 openapi/ghe-2.14/operations/git/get-commit.json create mode 100644 openapi/ghe-2.14/operations/git/get-ref.json create mode 100644 openapi/ghe-2.14/operations/git/get-tag.json create mode 100644 openapi/ghe-2.14/operations/git/get-tree.json create mode 100644 openapi/ghe-2.14/operations/git/update-ref.json create mode 100644 openapi/ghe-2.14/operations/gitignore/get-template.json create mode 100644 openapi/ghe-2.14/operations/gitignore/list-templates.json create mode 100644 openapi/ghe-2.14/operations/issues/add-assignees.json create mode 100644 openapi/ghe-2.14/operations/issues/add-labels.json create mode 100644 openapi/ghe-2.14/operations/issues/check-assignee.json create mode 100644 openapi/ghe-2.14/operations/issues/create-comment.json create mode 100644 openapi/ghe-2.14/operations/issues/create-label.json create mode 100644 openapi/ghe-2.14/operations/issues/create-milestone.json create mode 100644 openapi/ghe-2.14/operations/issues/create.json create mode 100644 openapi/ghe-2.14/operations/issues/delete-comment.json create mode 100644 openapi/ghe-2.14/operations/issues/delete-label.json create mode 100644 openapi/ghe-2.14/operations/issues/delete-milestone.json create mode 100644 openapi/ghe-2.14/operations/issues/get-comment.json create mode 100644 openapi/ghe-2.14/operations/issues/get-event.json create mode 100644 openapi/ghe-2.14/operations/issues/get-label.json create mode 100644 openapi/ghe-2.14/operations/issues/get-milestone.json create mode 100644 openapi/ghe-2.14/operations/issues/get.json create mode 100644 openapi/ghe-2.14/operations/issues/list-assignees.json create mode 100644 openapi/ghe-2.14/operations/issues/list-comments-for-repo.json create mode 100644 openapi/ghe-2.14/operations/issues/list-comments.json create mode 100644 openapi/ghe-2.14/operations/issues/list-events-for-repo.json create mode 100644 openapi/ghe-2.14/operations/issues/list-events-for-timeline.json create mode 100644 openapi/ghe-2.14/operations/issues/list-events.json create mode 100644 openapi/ghe-2.14/operations/issues/list-for-authenticated-user.json create mode 100644 openapi/ghe-2.14/operations/issues/list-for-org.json create mode 100644 openapi/ghe-2.14/operations/issues/list-for-repo.json create mode 100644 openapi/ghe-2.14/operations/issues/list-labels-for-milestone.json create mode 100644 openapi/ghe-2.14/operations/issues/list-labels-for-repo.json create mode 100644 openapi/ghe-2.14/operations/issues/list-labels-on-issue.json create mode 100644 openapi/ghe-2.14/operations/issues/list-milestones-for-repo.json create mode 100644 openapi/ghe-2.14/operations/issues/list.json create mode 100644 openapi/ghe-2.14/operations/issues/lock.json create mode 100644 openapi/ghe-2.14/operations/issues/remove-assignees.json create mode 100644 openapi/ghe-2.14/operations/issues/remove-label.json create mode 100644 openapi/ghe-2.14/operations/issues/remove-labels.json create mode 100644 openapi/ghe-2.14/operations/issues/replace-labels.json create mode 100644 openapi/ghe-2.14/operations/issues/unlock.json create mode 100644 openapi/ghe-2.14/operations/issues/update-comment.json create mode 100644 openapi/ghe-2.14/operations/issues/update-milestone.json create mode 100644 openapi/ghe-2.14/operations/issues/update.json create mode 100644 openapi/ghe-2.14/operations/licenses/get-for-repo.json create mode 100644 openapi/ghe-2.14/operations/licenses/get.json create mode 100644 openapi/ghe-2.14/operations/licenses/list-commonly-used.json create mode 100644 openapi/ghe-2.14/operations/markdown/render-raw.json create mode 100644 openapi/ghe-2.14/operations/markdown/render.json create mode 100644 openapi/ghe-2.14/operations/meta/get.json create mode 100644 openapi/ghe-2.14/operations/oauth_authorizations/check-authorization.json create mode 100644 openapi/ghe-2.14/operations/oauth_authorizations/create-authorization.json create mode 100644 openapi/ghe-2.14/operations/oauth_authorizations/delete-authorization.json create mode 100644 openapi/ghe-2.14/operations/oauth_authorizations/delete-grant.json create mode 100644 openapi/ghe-2.14/operations/oauth_authorizations/get-authorization.json create mode 100644 openapi/ghe-2.14/operations/oauth_authorizations/get-grant.json create mode 100644 openapi/ghe-2.14/operations/oauth_authorizations/get-or-create-authorization-for-app-and-fingerprint.json create mode 100644 openapi/ghe-2.14/operations/oauth_authorizations/get-or-create-authorization-for-app.json create mode 100644 openapi/ghe-2.14/operations/oauth_authorizations/list-authorizations.json create mode 100644 openapi/ghe-2.14/operations/oauth_authorizations/list-grants.json create mode 100644 openapi/ghe-2.14/operations/oauth_authorizations/reset-authorization.json create mode 100644 openapi/ghe-2.14/operations/oauth_authorizations/revoke-authorization-for-application.json create mode 100644 openapi/ghe-2.14/operations/oauth_authorizations/revoke-grant-for-application.json create mode 100644 openapi/ghe-2.14/operations/oauth_authorizations/update-authorization.json create mode 100644 openapi/ghe-2.14/operations/orgs/add-or-update-membership.json create mode 100644 openapi/ghe-2.14/operations/orgs/check-membership.json create mode 100644 openapi/ghe-2.14/operations/orgs/check-public-membership.json create mode 100644 openapi/ghe-2.14/operations/orgs/conceal-membership.json create mode 100644 openapi/ghe-2.14/operations/orgs/convert-member-to-outside-collaborator.json create mode 100644 openapi/ghe-2.14/operations/orgs/create-hook.json create mode 100644 openapi/ghe-2.14/operations/orgs/delete-hook.json create mode 100644 openapi/ghe-2.14/operations/orgs/get-hook.json create mode 100644 openapi/ghe-2.14/operations/orgs/get-membership-for-authenticated-user.json create mode 100644 openapi/ghe-2.14/operations/orgs/get-membership.json create mode 100644 openapi/ghe-2.14/operations/orgs/get.json create mode 100644 openapi/ghe-2.14/operations/orgs/list-for-authenticated-user.json create mode 100644 openapi/ghe-2.14/operations/orgs/list-for-user.json create mode 100644 openapi/ghe-2.14/operations/orgs/list-hooks.json create mode 100644 openapi/ghe-2.14/operations/orgs/list-members.json create mode 100644 openapi/ghe-2.14/operations/orgs/list-memberships.json create mode 100644 openapi/ghe-2.14/operations/orgs/list-outside-collaborators.json create mode 100644 openapi/ghe-2.14/operations/orgs/list-public-members.json create mode 100644 openapi/ghe-2.14/operations/orgs/list.json create mode 100644 openapi/ghe-2.14/operations/orgs/ping-hook.json create mode 100644 openapi/ghe-2.14/operations/orgs/publicize-membership.json create mode 100644 openapi/ghe-2.14/operations/orgs/remove-member.json create mode 100644 openapi/ghe-2.14/operations/orgs/remove-membership.json create mode 100644 openapi/ghe-2.14/operations/orgs/remove-outside-collaborator.json create mode 100644 openapi/ghe-2.14/operations/orgs/update-hook.json create mode 100644 openapi/ghe-2.14/operations/orgs/update-membership.json create mode 100644 openapi/ghe-2.14/operations/orgs/update.json create mode 100644 openapi/ghe-2.14/operations/projects/add-collaborator.json create mode 100644 openapi/ghe-2.14/operations/projects/create-card.json create mode 100644 openapi/ghe-2.14/operations/projects/create-column.json create mode 100644 openapi/ghe-2.14/operations/projects/create-for-org.json create mode 100644 openapi/ghe-2.14/operations/projects/create-for-repo.json create mode 100644 openapi/ghe-2.14/operations/projects/delete-card.json create mode 100644 openapi/ghe-2.14/operations/projects/delete-column.json create mode 100644 openapi/ghe-2.14/operations/projects/delete.json create mode 100644 openapi/ghe-2.14/operations/projects/get-card.json create mode 100644 openapi/ghe-2.14/operations/projects/get-column.json create mode 100644 openapi/ghe-2.14/operations/projects/get.json create mode 100644 openapi/ghe-2.14/operations/projects/list-cards.json create mode 100644 openapi/ghe-2.14/operations/projects/list-collaborators.json create mode 100644 openapi/ghe-2.14/operations/projects/list-columns.json create mode 100644 openapi/ghe-2.14/operations/projects/list-for-org.json create mode 100644 openapi/ghe-2.14/operations/projects/list-for-repo.json create mode 100644 openapi/ghe-2.14/operations/projects/move-card.json create mode 100644 openapi/ghe-2.14/operations/projects/move-column.json create mode 100644 openapi/ghe-2.14/operations/projects/remove-collaborator.json create mode 100644 openapi/ghe-2.14/operations/projects/review-user-permission-level.json create mode 100644 openapi/ghe-2.14/operations/projects/update-card.json create mode 100644 openapi/ghe-2.14/operations/projects/update-column.json create mode 100644 openapi/ghe-2.14/operations/projects/update.json create mode 100644 openapi/ghe-2.14/operations/pulls/check-if-merged.json create mode 100644 openapi/ghe-2.14/operations/pulls/create-comment-reply.json create mode 100644 openapi/ghe-2.14/operations/pulls/create-comment.json create mode 100644 openapi/ghe-2.14/operations/pulls/create-from-issue.json create mode 100644 openapi/ghe-2.14/operations/pulls/create-review-request.json create mode 100644 openapi/ghe-2.14/operations/pulls/create-review.json create mode 100644 openapi/ghe-2.14/operations/pulls/create.json create mode 100644 openapi/ghe-2.14/operations/pulls/delete-comment.json create mode 100644 openapi/ghe-2.14/operations/pulls/delete-pending-review.json create mode 100644 openapi/ghe-2.14/operations/pulls/delete-review-request.json create mode 100644 openapi/ghe-2.14/operations/pulls/dismiss-review.json create mode 100644 openapi/ghe-2.14/operations/pulls/get-comment.json create mode 100644 openapi/ghe-2.14/operations/pulls/get-comments-for-review.json create mode 100644 openapi/ghe-2.14/operations/pulls/get-review.json create mode 100644 openapi/ghe-2.14/operations/pulls/get.json create mode 100644 openapi/ghe-2.14/operations/pulls/list-comments-for-repo.json create mode 100644 openapi/ghe-2.14/operations/pulls/list-comments.json create mode 100644 openapi/ghe-2.14/operations/pulls/list-commits.json create mode 100644 openapi/ghe-2.14/operations/pulls/list-files.json create mode 100644 openapi/ghe-2.14/operations/pulls/list-review-requests.json create mode 100644 openapi/ghe-2.14/operations/pulls/list-reviews.json create mode 100644 openapi/ghe-2.14/operations/pulls/list.json create mode 100644 openapi/ghe-2.14/operations/pulls/merge.json create mode 100644 openapi/ghe-2.14/operations/pulls/submit-review.json create mode 100644 openapi/ghe-2.14/operations/pulls/update-comment.json create mode 100644 openapi/ghe-2.14/operations/pulls/update.json create mode 100644 openapi/ghe-2.14/operations/rate_limit/get.json create mode 100644 openapi/ghe-2.14/operations/reactions/create-for-commit-comment.json create mode 100644 openapi/ghe-2.14/operations/reactions/create-for-issue-comment.json create mode 100644 openapi/ghe-2.14/operations/reactions/create-for-issue.json create mode 100644 openapi/ghe-2.14/operations/reactions/create-for-pull-request-review-comment.json create mode 100644 openapi/ghe-2.14/operations/reactions/create-for-team-discussion-comment.json create mode 100644 openapi/ghe-2.14/operations/reactions/create-for-team-discussion.json create mode 100644 openapi/ghe-2.14/operations/reactions/delete.json create mode 100644 openapi/ghe-2.14/operations/reactions/list-for-commit-comment.json create mode 100644 openapi/ghe-2.14/operations/reactions/list-for-issue-comment.json create mode 100644 openapi/ghe-2.14/operations/reactions/list-for-issue.json create mode 100644 openapi/ghe-2.14/operations/reactions/list-for-pull-request-review-comment.json create mode 100644 openapi/ghe-2.14/operations/reactions/list-for-team-discussion-comment.json create mode 100644 openapi/ghe-2.14/operations/reactions/list-for-team-discussion.json create mode 100644 openapi/ghe-2.14/operations/repos/accept-invitation.json create mode 100644 openapi/ghe-2.14/operations/repos/add-collaborator.json create mode 100644 openapi/ghe-2.14/operations/repos/add-deploy-key.json create mode 100644 openapi/ghe-2.14/operations/repos/add-protected-branch-admin-enforcement.json create mode 100644 openapi/ghe-2.14/operations/repos/add-protected-branch-required-signatures.json create mode 100644 openapi/ghe-2.14/operations/repos/add-protected-branch-required-status-checks-contexts.json create mode 100644 openapi/ghe-2.14/operations/repos/add-protected-branch-team-restrictions.json create mode 100644 openapi/ghe-2.14/operations/repos/add-protected-branch-user-restrictions.json create mode 100644 openapi/ghe-2.14/operations/repos/check-collaborator.json create mode 100644 openapi/ghe-2.14/operations/repos/compare-commits.json create mode 100644 openapi/ghe-2.14/operations/repos/create-commit-comment.json create mode 100644 openapi/ghe-2.14/operations/repos/create-deployment-status.json create mode 100644 openapi/ghe-2.14/operations/repos/create-deployment.json create mode 100644 openapi/ghe-2.14/operations/repos/create-for-authenticated-user.json create mode 100644 openapi/ghe-2.14/operations/repos/create-fork.json create mode 100644 openapi/ghe-2.14/operations/repos/create-hook.json create mode 100644 openapi/ghe-2.14/operations/repos/create-in-org.json create mode 100644 openapi/ghe-2.14/operations/repos/create-or-update-file.json create mode 100644 openapi/ghe-2.14/operations/repos/create-release.json create mode 100644 openapi/ghe-2.14/operations/repos/create-status.json create mode 100644 openapi/ghe-2.14/operations/repos/decline-invitation.json create mode 100644 openapi/ghe-2.14/operations/repos/delete-commit-comment.json create mode 100644 openapi/ghe-2.14/operations/repos/delete-download.json create mode 100644 openapi/ghe-2.14/operations/repos/delete-file.json create mode 100644 openapi/ghe-2.14/operations/repos/delete-hook.json create mode 100644 openapi/ghe-2.14/operations/repos/delete-invitation.json create mode 100644 openapi/ghe-2.14/operations/repos/delete-release-asset.json create mode 100644 openapi/ghe-2.14/operations/repos/delete-release.json create mode 100644 openapi/ghe-2.14/operations/repos/delete.json create mode 100644 openapi/ghe-2.14/operations/repos/get-archive-link.json create mode 100644 openapi/ghe-2.14/operations/repos/get-branch-protection.json create mode 100644 openapi/ghe-2.14/operations/repos/get-branch.json create mode 100644 openapi/ghe-2.14/operations/repos/get-code-frequency-stats.json create mode 100644 openapi/ghe-2.14/operations/repos/get-collaborator-permission-level.json create mode 100644 openapi/ghe-2.14/operations/repos/get-combined-status-for-ref.json create mode 100644 openapi/ghe-2.14/operations/repos/get-commit-activity-stats.json create mode 100644 openapi/ghe-2.14/operations/repos/get-commit-comment.json create mode 100644 openapi/ghe-2.14/operations/repos/get-commit.json create mode 100644 openapi/ghe-2.14/operations/repos/get-contents.json create mode 100644 openapi/ghe-2.14/operations/repos/get-contributors-stats.json create mode 100644 openapi/ghe-2.14/operations/repos/get-deploy-key.json create mode 100644 openapi/ghe-2.14/operations/repos/get-deployment-status.json create mode 100644 openapi/ghe-2.14/operations/repos/get-deployment.json create mode 100644 openapi/ghe-2.14/operations/repos/get-download.json create mode 100644 openapi/ghe-2.14/operations/repos/get-hook.json create mode 100644 openapi/ghe-2.14/operations/repos/get-latest-pages-build.json create mode 100644 openapi/ghe-2.14/operations/repos/get-latest-release.json create mode 100644 openapi/ghe-2.14/operations/repos/get-pages-build.json create mode 100644 openapi/ghe-2.14/operations/repos/get-pages.json create mode 100644 openapi/ghe-2.14/operations/repos/get-participation-stats.json create mode 100644 openapi/ghe-2.14/operations/repos/get-protected-branch-admin-enforcement.json create mode 100644 openapi/ghe-2.14/operations/repos/get-protected-branch-pull-request-review-enforcement.json create mode 100644 openapi/ghe-2.14/operations/repos/get-protected-branch-required-signatures.json create mode 100644 openapi/ghe-2.14/operations/repos/get-protected-branch-required-status-checks.json create mode 100644 openapi/ghe-2.14/operations/repos/get-protected-branch-restrictions.json create mode 100644 openapi/ghe-2.14/operations/repos/get-punch-card-stats.json create mode 100644 openapi/ghe-2.14/operations/repos/get-readme.json create mode 100644 openapi/ghe-2.14/operations/repos/get-release-asset.json create mode 100644 openapi/ghe-2.14/operations/repos/get-release-by-tag.json create mode 100644 openapi/ghe-2.14/operations/repos/get-release.json create mode 100644 openapi/ghe-2.14/operations/repos/get.json create mode 100644 openapi/ghe-2.14/operations/repos/list-assets-for-release.json create mode 100644 openapi/ghe-2.14/operations/repos/list-branches.json create mode 100644 openapi/ghe-2.14/operations/repos/list-collaborators.json create mode 100644 openapi/ghe-2.14/operations/repos/list-comments-for-commit.json create mode 100644 openapi/ghe-2.14/operations/repos/list-commit-comments.json create mode 100644 openapi/ghe-2.14/operations/repos/list-commits.json create mode 100644 openapi/ghe-2.14/operations/repos/list-contributors.json create mode 100644 openapi/ghe-2.14/operations/repos/list-deploy-keys.json create mode 100644 openapi/ghe-2.14/operations/repos/list-deployment-statuses.json create mode 100644 openapi/ghe-2.14/operations/repos/list-deployments.json create mode 100644 openapi/ghe-2.14/operations/repos/list-downloads.json create mode 100644 openapi/ghe-2.14/operations/repos/list-for-org.json create mode 100644 openapi/ghe-2.14/operations/repos/list-for-user.json create mode 100644 openapi/ghe-2.14/operations/repos/list-forks.json create mode 100644 openapi/ghe-2.14/operations/repos/list-hooks.json create mode 100644 openapi/ghe-2.14/operations/repos/list-invitations-for-authenticated-user.json create mode 100644 openapi/ghe-2.14/operations/repos/list-invitations.json create mode 100644 openapi/ghe-2.14/operations/repos/list-languages.json create mode 100644 openapi/ghe-2.14/operations/repos/list-pages-builds.json create mode 100644 openapi/ghe-2.14/operations/repos/list-protected-branch-required-status-checks-contexts.json create mode 100644 openapi/ghe-2.14/operations/repos/list-protected-branch-team-restrictions.json create mode 100644 openapi/ghe-2.14/operations/repos/list-protected-branch-user-restrictions.json create mode 100644 openapi/ghe-2.14/operations/repos/list-public.json create mode 100644 openapi/ghe-2.14/operations/repos/list-releases.json create mode 100644 openapi/ghe-2.14/operations/repos/list-statuses-for-ref.json create mode 100644 openapi/ghe-2.14/operations/repos/list-tags.json create mode 100644 openapi/ghe-2.14/operations/repos/list-teams.json create mode 100644 openapi/ghe-2.14/operations/repos/list-topics.json create mode 100644 openapi/ghe-2.14/operations/repos/list.json create mode 100644 openapi/ghe-2.14/operations/repos/merge.json create mode 100644 openapi/ghe-2.14/operations/repos/ping-hook.json create mode 100644 openapi/ghe-2.14/operations/repos/remove-branch-protection.json create mode 100644 openapi/ghe-2.14/operations/repos/remove-collaborator.json create mode 100644 openapi/ghe-2.14/operations/repos/remove-deploy-key.json create mode 100644 openapi/ghe-2.14/operations/repos/remove-protected-branch-admin-enforcement.json create mode 100644 openapi/ghe-2.14/operations/repos/remove-protected-branch-pull-request-review-enforcement.json create mode 100644 openapi/ghe-2.14/operations/repos/remove-protected-branch-required-signatures.json create mode 100644 openapi/ghe-2.14/operations/repos/remove-protected-branch-required-status-checks-contexts.json create mode 100644 openapi/ghe-2.14/operations/repos/remove-protected-branch-required-status-checks.json create mode 100644 openapi/ghe-2.14/operations/repos/remove-protected-branch-restrictions.json create mode 100644 openapi/ghe-2.14/operations/repos/remove-protected-branch-team-restrictions.json create mode 100644 openapi/ghe-2.14/operations/repos/remove-protected-branch-user-restrictions.json create mode 100644 openapi/ghe-2.14/operations/repos/replace-protected-branch-required-status-checks-contexts.json create mode 100644 openapi/ghe-2.14/operations/repos/replace-protected-branch-team-restrictions.json create mode 100644 openapi/ghe-2.14/operations/repos/replace-protected-branch-user-restrictions.json create mode 100644 openapi/ghe-2.14/operations/repos/replace-topics.json create mode 100644 openapi/ghe-2.14/operations/repos/request-page-build.json create mode 100644 openapi/ghe-2.14/operations/repos/test-push-hook.json create mode 100644 openapi/ghe-2.14/operations/repos/transfer.json create mode 100644 openapi/ghe-2.14/operations/repos/update-branch-protection.json create mode 100644 openapi/ghe-2.14/operations/repos/update-commit-comment.json create mode 100644 openapi/ghe-2.14/operations/repos/update-hook.json create mode 100644 openapi/ghe-2.14/operations/repos/update-invitation.json create mode 100644 openapi/ghe-2.14/operations/repos/update-protected-branch-pull-request-review-enforcement.json create mode 100644 openapi/ghe-2.14/operations/repos/update-protected-branch-required-status-checks.json create mode 100644 openapi/ghe-2.14/operations/repos/update-release-asset.json create mode 100644 openapi/ghe-2.14/operations/repos/update-release.json create mode 100644 openapi/ghe-2.14/operations/repos/update.json create mode 100644 openapi/ghe-2.14/operations/search/code.json create mode 100644 openapi/ghe-2.14/operations/search/commits.json create mode 100644 openapi/ghe-2.14/operations/search/email-legacy.json create mode 100644 openapi/ghe-2.14/operations/search/issues-and-pull-requests.json create mode 100644 openapi/ghe-2.14/operations/search/issues-legacy.json create mode 100644 openapi/ghe-2.14/operations/search/labels.json create mode 100644 openapi/ghe-2.14/operations/search/repos-legacy.json create mode 100644 openapi/ghe-2.14/operations/search/repos.json create mode 100644 openapi/ghe-2.14/operations/search/topics.json create mode 100644 openapi/ghe-2.14/operations/search/users-legacy.json create mode 100644 openapi/ghe-2.14/operations/search/users.json create mode 100644 openapi/ghe-2.14/operations/teams/add-member.json create mode 100644 openapi/ghe-2.14/operations/teams/add-or-update-membership.json create mode 100644 openapi/ghe-2.14/operations/teams/add-or-update-project.json create mode 100644 openapi/ghe-2.14/operations/teams/add-or-update-repo.json create mode 100644 openapi/ghe-2.14/operations/teams/check-manages-repo.json create mode 100644 openapi/ghe-2.14/operations/teams/create-discussion-comment.json create mode 100644 openapi/ghe-2.14/operations/teams/create-discussion.json create mode 100644 openapi/ghe-2.14/operations/teams/create.json create mode 100644 openapi/ghe-2.14/operations/teams/delete-discussion-comment.json create mode 100644 openapi/ghe-2.14/operations/teams/delete-discussion.json create mode 100644 openapi/ghe-2.14/operations/teams/delete.json create mode 100644 openapi/ghe-2.14/operations/teams/get-discussion-comment.json create mode 100644 openapi/ghe-2.14/operations/teams/get-discussion.json create mode 100644 openapi/ghe-2.14/operations/teams/get-member.json create mode 100644 openapi/ghe-2.14/operations/teams/get-membership.json create mode 100644 openapi/ghe-2.14/operations/teams/get.json create mode 100644 openapi/ghe-2.14/operations/teams/list-child.json create mode 100644 openapi/ghe-2.14/operations/teams/list-discussion-comments.json create mode 100644 openapi/ghe-2.14/operations/teams/list-discussions.json create mode 100644 openapi/ghe-2.14/operations/teams/list-for-authenticated-user.json create mode 100644 openapi/ghe-2.14/operations/teams/list-members.json create mode 100644 openapi/ghe-2.14/operations/teams/list-projects.json create mode 100644 openapi/ghe-2.14/operations/teams/list-repos.json create mode 100644 openapi/ghe-2.14/operations/teams/list.json create mode 100644 openapi/ghe-2.14/operations/teams/remove-member.json create mode 100644 openapi/ghe-2.14/operations/teams/remove-membership.json create mode 100644 openapi/ghe-2.14/operations/teams/remove-project.json create mode 100644 openapi/ghe-2.14/operations/teams/remove-repo.json create mode 100644 openapi/ghe-2.14/operations/teams/review-project.json create mode 100644 openapi/ghe-2.14/operations/teams/update-discussion-comment.json create mode 100644 openapi/ghe-2.14/operations/teams/update-discussion.json create mode 100644 openapi/ghe-2.14/operations/teams/update.json create mode 100644 openapi/ghe-2.14/operations/users/add-emails.json create mode 100644 openapi/ghe-2.14/operations/users/check-following-for-user.json create mode 100644 openapi/ghe-2.14/operations/users/check-following.json create mode 100644 openapi/ghe-2.14/operations/users/create-gpg-key.json create mode 100644 openapi/ghe-2.14/operations/users/create-public-key.json create mode 100644 openapi/ghe-2.14/operations/users/delete-emails.json create mode 100644 openapi/ghe-2.14/operations/users/delete-gpg-key.json create mode 100644 openapi/ghe-2.14/operations/users/delete-public-key.json create mode 100644 openapi/ghe-2.14/operations/users/follow.json create mode 100644 openapi/ghe-2.14/operations/users/get-authenticated.json create mode 100644 openapi/ghe-2.14/operations/users/get-by-username.json create mode 100644 openapi/ghe-2.14/operations/users/get-context-for-user.json create mode 100644 openapi/ghe-2.14/operations/users/get-gpg-key.json create mode 100644 openapi/ghe-2.14/operations/users/get-public-key.json create mode 100644 openapi/ghe-2.14/operations/users/list-emails.json create mode 100644 openapi/ghe-2.14/operations/users/list-followers-for-authenticated-user.json create mode 100644 openapi/ghe-2.14/operations/users/list-followers-for-user.json create mode 100644 openapi/ghe-2.14/operations/users/list-following-for-authenticated-user.json create mode 100644 openapi/ghe-2.14/operations/users/list-following-for-user.json create mode 100644 openapi/ghe-2.14/operations/users/list-gpg-keys-for-user.json create mode 100644 openapi/ghe-2.14/operations/users/list-gpg-keys.json create mode 100644 openapi/ghe-2.14/operations/users/list-public-emails.json create mode 100644 openapi/ghe-2.14/operations/users/list-public-keys-for-user.json create mode 100644 openapi/ghe-2.14/operations/users/list-public-keys.json create mode 100644 openapi/ghe-2.14/operations/users/list.json create mode 100644 openapi/ghe-2.14/operations/users/unfollow.json create mode 100644 openapi/ghe-2.14/operations/users/update-authenticated.json diff --git a/cache/ghe-2.14/enterprise/2.14/v3/activity/events/types/checkrunevent.html b/cache/ghe-2.14/enterprise/2.14/v3/activity/events/types/checkrunevent.html index a848634402..3b0a425c33 100644 --- a/cache/ghe-2.14/enterprise/2.14/v3/activity/events/types/checkrunevent.html +++ b/cache/ghe-2.14/enterprise/2.14/v3/activity/events/types/checkrunevent.html @@ -17,7 +17,7 @@

action string -The action performed. Can be one of:
* created - A new check run was created.
* completed - The status of the check run is completed.
* rerequested - Someone requested to re-run your check run.
* requested_action - Someone requested that an action be taken. For example, this action will be sent if someone clicks a "Fix it" button in the UI. See Request further actions from a check run for details. +The action performed. Can be one of:
* created - A new check run was created.
* completed - The status of the check run is completed.
* rerequested - Someone requested to re-run your check run.
* requested_action - Someone requested that an action be taken. For example, this action will be sent if someone clicks a "Fix it" button in the UI. check_run diff --git a/cache/ghe-2.14/enterprise/2.14/v3/activity/events/types/index.html b/cache/ghe-2.14/enterprise/2.14/v3/activity/events/types/index.html index bbd61586fc..d7ff6c7986 100644 --- a/cache/ghe-2.14/enterprise/2.14/v3/activity/events/types/index.html +++ b/cache/ghe-2.14/enterprise/2.14/v3/activity/events/types/index.html @@ -327,7 +327,7 @@

action string -The action performed. Can be one of:
* created - A new check run was created.
* completed - The status of the check run is completed.
* rerequested - Someone requested to re-run your check run.
* requested_action - Someone requested that an action be taken. For example, this action will be sent if someone clicks a "Fix it" button in the UI. See Request further actions from a check run for details. +The action performed. Can be one of:
* created - A new check run was created.
* completed - The status of the check run is completed.
* rerequested - Someone requested to re-run your check run.
* requested_action - Someone requested that an action be taken. For example, this action will be sent if someone clicks a "Fix it" button in the UI. check_run diff --git a/cache/ghe-2.14/enterprise/2.14/v3/checks/index.html b/cache/ghe-2.14/enterprise/2.14/v3/checks/index.html index 40ff0ee6a8..f5e5093f7c 100644 --- a/cache/ghe-2.14/enterprise/2.14/v3/checks/index.html +++ b/cache/ghe-2.14/enterprise/2.14/v3/checks/index.html @@ -357,6 +357,7 @@

+

For an example of how to use the Checks API with a GitHub App, see "Creating CI tests with the Checks API."

Check runs API

diff --git a/cache/ghe-2.14/enterprise/2.14/v3/checks/runs/create-a-check-run.html b/cache/ghe-2.14/enterprise/2.14/v3/checks/runs/create-a-check-run.html index c5b2a26b19..8dba31a0c9 100644 --- a/cache/ghe-2.14/enterprise/2.14/v3/checks/runs/create-a-check-run.html +++ b/cache/ghe-2.14/enterprise/2.14/v3/checks/runs/create-a-check-run.html @@ -76,7 +76,7 @@

actions array of objects -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 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 to your app. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. diff --git a/cache/ghe-2.14/enterprise/2.14/v3/checks/runs/index.html b/cache/ghe-2.14/enterprise/2.14/v3/checks/runs/index.html index 9fd0206fc2..d5fab8c2d0 100644 --- a/cache/ghe-2.14/enterprise/2.14/v3/checks/runs/index.html +++ b/cache/ghe-2.14/enterprise/2.14/v3/checks/runs/index.html @@ -362,7 +362,7 @@

actions array of objects -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 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 to your app. Each action includes a label, identifier and description. A maximum of three actions are accepted. See the actions object description. diff --git a/cache/ghe-2.14/enterprise/2.14/v3/search/index.html b/cache/ghe-2.14/enterprise/2.14/v3/search/index.html index 70740b3c4d..a48d7ba406 100644 --- a/cache/ghe-2.14/enterprise/2.14/v3/search/index.html +++ b/cache/ghe-2.14/enterprise/2.14/v3/search/index.html @@ -276,7 +276,7 @@

  • Text match metadata

    • The Search API helps you search for the specific item you want to find. For example, you can find a user or a specific file in a repository. Think of it the way you think of performing a search on Google. It's designed to help you find the one result you're looking for (or maybe the few results you're looking for). Just like searching on Google, you sometimes want to see a few pages of search results so that you can find the item that best meets your needs. To satisfy that need, the GitHub Enterprise Search API provides up to 1,000 results for each search.

    -

    You can narrow your search using queries, also known as search qualifiers or query parameters. If only some search queries are successful, then you will see a partially successful response with an empty list for unsuccessful queries.

    +

    You can narrow your search using queries. To learn more about the search query syntax, see "Constructing a search query."

    Ranking search results

    Unless another sort option is provided as a query parameter, results are sorted @@ -311,34 +311,12 @@

    quantities, dates, or to exclude results, see "Understanding the search syntax."

    Limitations on query length

    -

    The Search API does not support queries that are longer than 256 characters (not including operators or qualifiers) and will return an error.

    -
    {
-  "message": "Validation Failed",
-  "errors": [
-    {
-      "message": "The search is longer than 256 characters.",
-      "resource": "Search",
-      "field": "q",
-      "code": "invalid"
-    }
-  ],
-  "documentation_url": "https://developer.github.com/v3/search/"
-}
-
    -

    Also, a query using more than five AND, OR, or NOT operators will return an error.

    -
    {
-  "message": "Validation Failed",
-  "errors": [
-    {
-      "message": "More than five AND / OR / NOT operators were used.",
-      "resource": "Search",
-      "field": "q",
-      "code": "invalid"
-    }
-  ],
-  "documentation_url": "https://developer.github.com/v3/search/"
-}
-
    +

    The Search API does not support queries that:

    + +

    These search queries will return a "Validation failed" error message.

    Timeouts and incomplete results

    To keep the Search API fast for everyone, we limit how long any individual query @@ -348,21 +326,10 @@

    Reaching a timeout does not necessarily mean that search results are incomplete. More results might have been found, but also might not.

    -Permissions failure or an empty list

    -

    You need to successfully authenticate and have access to the repositories in your search queries, otherwise, you'll see a 422 Unprocessible Entry error. For example, your search will fail if your query includes repo: or user: or org: qualifiers and doesn't match the resources that you have access to when you sign in on GitHub.

    -
    {
-  "message": "Validation Failed",
-  "errors": [
-    {
-      "message": "The listed users and repositories cannot be searched either because the resources do not exist or you do not have permission to view them.",
-      "resource": "Search",
-      "field": "q",
-      "code": "invalid"
-    }
-  ],
-  "documentation_url": "https://developer.github.com/v3/search/"
-}
-
    +Access errors or missing search results +

    You need to successfully authenticate and have access to the repositories in your search queries, otherwise, you'll see a 422 Unprocessible Entry error with a "Validation Failed" message. For example, your search will fail if your query includes repo:, user:, or org: qualifiers that request resources that you don't have access to when you sign in on GitHub.

    +

    When your search query requests multiple resources, the response will only contain the resources that you have access to and will not provide an error message listing the resources that were not returned.

    +

    For example, if your search query searches for the octocat/test and codertocat/test repositories, but you only have access to octocat/test, your response will show search results for octocat/test and nothing for codertocat/test. This behavior mimics how search works on GitHub.

    Search repositories

    diff --git a/openapi/ghe-2.14/index.json b/openapi/ghe-2.14/index.json new file mode 100644 index 0000000000..df4011aec9 --- /dev/null +++ b/openapi/ghe-2.14/index.json @@ -0,0 +1,2109 @@ +{ + "openapi": "3.0.2", + "info": { + "version": "3.0.0", + "title": "GitHub Enterprise REST API v3", + "description": "This describes the resources that make up the official GitHub Enterprise Server REST API v3. If you have any problems or requests, please contact [GitHub Enterprise Support](https://enterprise.github.com/support).", + "license": { + "name": "GitHub Enterprise License Agreement", + "url": "https://enterprise.github.com/license" + }, + "termsOfService": "https://help.github.com/en/articles/github-terms-of-service" + }, + "servers": [ + { + "url": "http://{hostname}", + "variables": { + "hostname": { + "description": "Self-hosted Enterprise Server or Enterprise Cloud hostname", + "default": "HOSTNAME" + } + } + } + ], + "externalDocs": { + "description": "GitHub Enterprise Developer Docs", + "url": "https://developer.github.com/enterprise/2.14/v3/" + }, + "paths": { + "/admin/hooks": { + "get": { + "$ref": "operations/enterprise-admin/list-global-hooks.json" + }, + "post": { + "$ref": "operations/enterprise-admin/create-global-hook.json" + } + }, + "/admin/hooks/{hook_id}": { + "get": { + "$ref": "operations/enterprise-admin/get-global-hook.json" + }, + "patch": { + "$ref": "operations/enterprise-admin/update-global-hook.json" + }, + "delete": { + "$ref": "operations/enterprise-admin/delete-global-hook.json" + } + }, + "/admin/hooks/{hook_id}/pings": { + "post": { + "$ref": "operations/enterprise-admin/ping-global-hook.json" + } + }, + "/admin/keys/{key_ids}": { + "delete": { + "$ref": "operations/enterprise-admin/delete-public-key.json" + } + }, + "/admin/ldap/teams/{team_id}/mapping": { + "patch": { + "$ref": "operations/enterprise-admin/update-ldap-mapping-for-team.json" + } + }, + "/admin/ldap/teams/{team_id}/sync": { + "post": { + "$ref": "operations/enterprise-admin/sync-ldap-mapping-for-team.json" + } + }, + "/admin/ldap/users/{username}/mapping": { + "patch": { + "$ref": "operations/enterprise-admin/update-ldap-mapping-for-user.json" + } + }, + "/admin/ldap/users/{username}/sync": { + "post": { + "$ref": "operations/enterprise-admin/sync-ldap-mapping-for-user.json" + } + }, + "/admin/organizations": { + "post": { + "$ref": "operations/enterprise-admin/create-org.json" + } + }, + "/admin/organizations/{org}": { + "patch": { + "$ref": "operations/enterprise-admin/rename-org.json" + } + }, + "/admin/pre-receive-environments": { + "get": { + "$ref": "operations/enterprise-admin/list-pre-receive-environments.json" + }, + "post": { + "$ref": "operations/enterprise-admin/create-pre-receive-environment.json" + } + }, + "/admin/pre-receive-environments/{pre_receive_environment_id}": { + "get": { + "$ref": "operations/enterprise-admin/get-pre-receive-environment.json" + }, + "patch": { + "$ref": "operations/enterprise-admin/update-pre-receive-environment.json" + }, + "delete": { + "$ref": "operations/enterprise-admin/delete-pre-receive-environment.json" + } + }, + "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads": { + "post": { + "$ref": "operations/enterprise-admin/trigger-pre-receive-environment-download.json" + } + }, + "/admin/pre-receive-environments/{pre_receive_environment_id}/downloads/latest": { + "get": { + "$ref": "operations/enterprise-admin/get-pre-receive-environment-download-status.json" + } + }, + "/admin/pre-receive-hooks": { + "get": { + "$ref": "operations/enterprise-admin/list-pre-receive-hooks.json" + }, + "post": { + "$ref": "operations/enterprise-admin/create-pre-receive-hook.json" + } + }, + "/admin/pre-receive-hooks/{pre_receive_hook_id}": { + "get": { + "$ref": "operations/enterprise-admin/get-pre-receive-hook.json" + } + }, + "/admin/pre_receive_hooks/{pre_receive_hook_id}": { + "patch": { + "$ref": "operations/enterprise-admin/update-pre-receive-hook.json" + }, + "delete": { + "$ref": "operations/enterprise-admin/delete-pre-receive-hook.json" + } + }, + "/admin/users": { + "post": { + "$ref": "operations/enterprise-admin/create-user.json" + } + }, + "/admin/users/{username}": { + "patch": { + "$ref": "operations/enterprise-admin/rename-user.json" + }, + "delete": { + "$ref": "operations/enterprise-admin/delete-user.json" + } + }, + "/admin/users/{username}/authorizations": { + "post": { + "$ref": "operations/enterprise-admin/create-impersonation-o-auth-token.json" + }, + "delete": { + "$ref": "operations/enterprise-admin/delete-impersonation-o-auth-token.json" + } + }, + "/app": { + "get": { + "$ref": "operations/apps/get-authenticated.json" + } + }, + "/app/installations": { + "get": { + "$ref": "operations/apps/list-installations.json" + } + }, + "/app/installations/{installation_id}": { + "get": { + "$ref": "operations/apps/get-installation.json" + } + }, + "/applications/grants": { + "get": { + "$ref": "operations/oauth_authorizations/list-grants.json" + } + }, + "/applications/grants/{grant_id}": { + "get": { + "$ref": "operations/oauth_authorizations/get-grant.json" + }, + "delete": { + "$ref": "operations/oauth_authorizations/delete-grant.json" + } + }, + "/applications/{client_id}/grants/{access_token}": { + "delete": { + "$ref": "operations/oauth_authorizations/revoke-grant-for-application.json" + } + }, + "/applications/{client_id}/tokens/{access_token}": { + "get": { + "$ref": "operations/oauth_authorizations/check-authorization.json" + }, + "post": { + "$ref": "operations/oauth_authorizations/reset-authorization.json" + }, + "delete": { + "$ref": "operations/oauth_authorizations/revoke-authorization-for-application.json" + } + }, + "/apps/{app_slug}": { + "get": { + "$ref": "operations/apps/get-by-slug.json" + } + }, + "/authorizations": { + "get": { + "$ref": "operations/oauth_authorizations/list-authorizations.json" + }, + "post": { + "$ref": "operations/oauth_authorizations/create-authorization.json" + } + }, + "/authorizations/clients/{client_id}": { + "put": { + "$ref": "operations/oauth_authorizations/get-or-create-authorization-for-app.json" + } + }, + "/authorizations/clients/{client_id}/{fingerprint}": { + "put": { + "$ref": "operations/oauth_authorizations/get-or-create-authorization-for-app-and-fingerprint.json" + } + }, + "/authorizations/{authorization_id}": { + "get": { + "$ref": "operations/oauth_authorizations/get-authorization.json" + }, + "patch": { + "$ref": "operations/oauth_authorizations/update-authorization.json" + }, + "delete": { + "$ref": "operations/oauth_authorizations/delete-authorization.json" + } + }, + "/codes_of_conduct": { + "get": { + "$ref": "operations/codes_of_conduct/list-conduct-codes.json" + } + }, + "/codes_of_conduct/{key}": { + "get": { + "$ref": "operations/codes_of_conduct/get-conduct-code.json" + } + }, + "/emojis": { + "get": { + "$ref": "operations/emojis/get.json" + } + }, + "/enterprise/settings/license": { + "get": { + "$ref": "operations/enterprise-admin/get-license-information.json" + } + }, + "/enterprise/stats/{type}": { + "get": { + "$ref": "operations/enterprise-admin/get-type-stats.json" + } + }, + "/events": { + "get": { + "$ref": "operations/activity/list-public-events.json" + } + }, + "/feeds": { + "get": { + "$ref": "operations/activity/list-feeds.json" + } + }, + "/gists": { + "get": { + "$ref": "operations/gists/list.json" + }, + "post": { + "$ref": "operations/gists/create.json" + } + }, + "/gists/public": { + "get": { + "$ref": "operations/gists/list-public.json" + } + }, + "/gists/starred": { + "get": { + "$ref": "operations/gists/list-starred.json" + } + }, + "/gists/{gist_id}": { + "get": { + "$ref": "operations/gists/get.json" + }, + "patch": { + "$ref": "operations/gists/update.json" + }, + "delete": { + "$ref": "operations/gists/delete.json" + } + }, + "/gists/{gist_id}/comments": { + "get": { + "$ref": "operations/gists/list-comments.json" + }, + "post": { + "$ref": "operations/gists/create-comment.json" + } + }, + "/gists/{gist_id}/comments/{comment_id}": { + "get": { + "$ref": "operations/gists/get-comment.json" + }, + "patch": { + "$ref": "operations/gists/update-comment.json" + }, + "delete": { + "$ref": "operations/gists/delete-comment.json" + } + }, + "/gists/{gist_id}/commits": { + "get": { + "$ref": "operations/gists/list-commits.json" + } + }, + "/gists/{gist_id}/forks": { + "post": { + "$ref": "operations/gists/fork.json" + }, + "get": { + "$ref": "operations/gists/list-forks.json" + } + }, + "/gists/{gist_id}/star": { + "put": { + "$ref": "operations/gists/star.json" + }, + "delete": { + "$ref": "operations/gists/unstar.json" + }, + "get": { + "$ref": "operations/gists/check-is-starred.json" + } + }, + "/gists/{gist_id}/{sha}": { + "get": { + "$ref": "operations/gists/get-revision.json" + } + }, + "/gitignore/templates": { + "get": { + "$ref": "operations/gitignore/list-templates.json" + } + }, + "/gitignore/templates/{name}": { + "get": { + "$ref": "operations/gitignore/get-template.json" + } + }, + "/installation/repositories": { + "get": { + "$ref": "operations/apps/list-repos.json" + } + }, + "/installations/{installation_id}/access_tokens": { + "post": { + "$ref": "operations/apps/create-installation-token.json" + } + }, + "/issues": { + "get": { + "$ref": "operations/issues/list.json" + } + }, + "/legacy/issues/search/{owner}/{repository}/{state}/{keyword}": { + "get": { + "$ref": "operations/search/issues-legacy.json" + } + }, + "/legacy/repos/search/{keyword}": { + "get": { + "$ref": "operations/search/repos-legacy.json" + } + }, + "/legacy/user/email/{email}": { + "get": { + "$ref": "operations/search/email-legacy.json" + } + }, + "/legacy/user/search/{keyword}": { + "get": { + "$ref": "operations/search/users-legacy.json" + } + }, + "/licenses": { + "get": { + "$ref": "operations/licenses/list-commonly-used.json" + } + }, + "/licenses/{license}": { + "get": { + "$ref": "operations/licenses/get.json" + } + }, + "/markdown": { + "post": { + "$ref": "operations/markdown/render.json" + } + }, + "/markdown/raw": { + "post": { + "$ref": "operations/markdown/render-raw.json" + } + }, + "/meta": { + "get": { + "$ref": "operations/meta/get.json" + } + }, + "/networks/{owner}/{repo}/events": { + "get": { + "$ref": "operations/activity/list-public-events-for-repo-network.json" + } + }, + "/notifications": { + "get": { + "$ref": "operations/activity/list-notifications.json" + }, + "put": { + "$ref": "operations/activity/mark-as-read.json" + } + }, + "/notifications/threads/{thread_id}": { + "get": { + "$ref": "operations/activity/get-thread.json" + }, + "patch": { + "$ref": "operations/activity/mark-thread-as-read.json" + } + }, + "/notifications/threads/{thread_id}/subscription": { + "get": { + "$ref": "operations/activity/get-thread-subscription.json" + }, + "put": { + "$ref": "operations/activity/set-thread-subscription.json" + }, + "delete": { + "$ref": "operations/activity/delete-thread-subscription.json" + } + }, + "/organizations": { + "get": { + "$ref": "operations/orgs/list.json" + } + }, + "/orgs/{org}": { + "get": { + "$ref": "operations/orgs/get.json" + }, + "patch": { + "$ref": "operations/orgs/update.json" + } + }, + "/orgs/{org}/events": { + "get": { + "$ref": "operations/activity/list-public-events-for-org.json" + } + }, + "/orgs/{org}/hooks": { + "get": { + "$ref": "operations/orgs/list-hooks.json" + }, + "post": { + "$ref": "operations/orgs/create-hook.json" + } + }, + "/orgs/{org}/hooks/{hook_id}": { + "get": { + "$ref": "operations/orgs/get-hook.json" + }, + "patch": { + "$ref": "operations/orgs/update-hook.json" + }, + "delete": { + "$ref": "operations/orgs/delete-hook.json" + } + }, + "/orgs/{org}/hooks/{hook_id}/pings": { + "post": { + "$ref": "operations/orgs/ping-hook.json" + } + }, + "/orgs/{org}/installation": { + "get": { + "$ref": "operations/apps/get-org-installation.json" + } + }, + "/orgs/{org}/issues": { + "get": { + "$ref": "operations/issues/list-for-org.json" + } + }, + "/orgs/{org}/members": { + "get": { + "$ref": "operations/orgs/list-members.json" + } + }, + "/orgs/{org}/members/{username}": { + "get": { + "$ref": "operations/orgs/check-membership.json" + }, + "delete": { + "$ref": "operations/orgs/remove-member.json" + } + }, + "/orgs/{org}/memberships/{username}": { + "get": { + "$ref": "operations/orgs/get-membership.json" + }, + "put": { + "$ref": "operations/orgs/add-or-update-membership.json" + }, + "delete": { + "$ref": "operations/orgs/remove-membership.json" + } + }, + "/orgs/{org}/outside_collaborators": { + "get": { + "$ref": "operations/orgs/list-outside-collaborators.json" + } + }, + "/orgs/{org}/outside_collaborators/{username}": { + "delete": { + "$ref": "operations/orgs/remove-outside-collaborator.json" + }, + "put": { + "$ref": "operations/orgs/convert-member-to-outside-collaborator.json" + } + }, + "/orgs/{org}/pre-receive-hooks": { + "get": { + "$ref": "operations/enterprise-admin/list-pre-receive-hooks-for-org.json" + } + }, + "/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}": { + "get": { + "$ref": "operations/enterprise-admin/get-pre-receive-hook-for-org.json" + }, + "patch": { + "$ref": "operations/enterprise-admin/update-pre-receive-hook-enforcement-for-org.json" + }, + "delete": { + "$ref": "operations/enterprise-admin/remove-enforcement-overrides-for-pre-receive-hook-for-org.json" + } + }, + "/orgs/{org}/projects": { + "get": { + "$ref": "operations/projects/list-for-org.json" + }, + "post": { + "$ref": "operations/projects/create-for-org.json" + } + }, + "/orgs/{org}/public_members": { + "get": { + "$ref": "operations/orgs/list-public-members.json" + } + }, + "/orgs/{org}/public_members/{username}": { + "get": { + "$ref": "operations/orgs/check-public-membership.json" + }, + "put": { + "$ref": "operations/orgs/publicize-membership.json" + }, + "delete": { + "$ref": "operations/orgs/conceal-membership.json" + } + }, + "/orgs/{org}/repos": { + "get": { + "$ref": "operations/repos/list-for-org.json" + }, + "post": { + "$ref": "operations/repos/create-in-org.json" + } + }, + "/orgs/{org}/teams": { + "get": { + "$ref": "operations/teams/list.json" + }, + "post": { + "$ref": "operations/teams/create.json" + } + }, + "/projects/columns/cards/{card_id}": { + "get": { + "$ref": "operations/projects/get-card.json" + }, + "patch": { + "$ref": "operations/projects/update-card.json" + }, + "delete": { + "$ref": "operations/projects/delete-card.json" + } + }, + "/projects/columns/cards/{card_id}/moves": { + "post": { + "$ref": "operations/projects/move-card.json" + } + }, + "/projects/columns/{column_id}": { + "get": { + "$ref": "operations/projects/get-column.json" + }, + "patch": { + "$ref": "operations/projects/update-column.json" + }, + "delete": { + "$ref": "operations/projects/delete-column.json" + } + }, + "/projects/columns/{column_id}/cards": { + "get": { + "$ref": "operations/projects/list-cards.json" + }, + "post": { + "$ref": "operations/projects/create-card.json" + } + }, + "/projects/columns/{column_id}/moves": { + "post": { + "$ref": "operations/projects/move-column.json" + } + }, + "/projects/{project_id}": { + "get": { + "$ref": "operations/projects/get.json" + }, + "patch": { + "$ref": "operations/projects/update.json" + }, + "delete": { + "$ref": "operations/projects/delete.json" + } + }, + "/projects/{project_id}/collaborators": { + "get": { + "$ref": "operations/projects/list-collaborators.json" + } + }, + "/projects/{project_id}/collaborators/{username}": { + "put": { + "$ref": "operations/projects/add-collaborator.json" + }, + "delete": { + "$ref": "operations/projects/remove-collaborator.json" + } + }, + "/projects/{project_id}/collaborators/{username}/permission": { + "get": { + "$ref": "operations/projects/review-user-permission-level.json" + } + }, + "/projects/{project_id}/columns": { + "get": { + "$ref": "operations/projects/list-columns.json" + }, + "post": { + "$ref": "operations/projects/create-column.json" + } + }, + "/rate_limit": { + "get": { + "$ref": "operations/rate_limit/get.json" + } + }, + "/reactions/{reaction_id}": { + "delete": { + "$ref": "operations/reactions/delete.json" + } + }, + "/repos/{owner}/{repo}": { + "get": { + "$ref": "operations/repos/get.json" + }, + "patch": { + "$ref": "operations/repos/update.json" + }, + "delete": { + "$ref": "operations/repos/delete.json" + } + }, + "/repos/{owner}/{repo}/assignees": { + "get": { + "$ref": "operations/issues/list-assignees.json" + } + }, + "/repos/{owner}/{repo}/assignees/{assignee}": { + "get": { + "$ref": "operations/issues/check-assignee.json" + } + }, + "/repos/{owner}/{repo}/branches": { + "get": { + "$ref": "operations/repos/list-branches.json" + } + }, + "/repos/{owner}/{repo}/branches/{branch}": { + "get": { + "$ref": "operations/repos/get-branch.json" + } + }, + "/repos/{owner}/{repo}/branches/{branch}/protection": { + "get": { + "$ref": "operations/repos/get-branch-protection.json" + }, + "put": { + "$ref": "operations/repos/update-branch-protection.json" + }, + "delete": { + "$ref": "operations/repos/remove-branch-protection.json" + } + }, + "/repos/{owner}/{repo}/branches/{branch}/protection/enforce_admins": { + "get": { + "$ref": "operations/repos/get-protected-branch-admin-enforcement.json" + }, + "post": { + "$ref": "operations/repos/add-protected-branch-admin-enforcement.json" + }, + "delete": { + "$ref": "operations/repos/remove-protected-branch-admin-enforcement.json" + } + }, + "/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews": { + "get": { + "$ref": "operations/repos/get-protected-branch-pull-request-review-enforcement.json" + }, + "patch": { + "$ref": "operations/repos/update-protected-branch-pull-request-review-enforcement.json" + }, + "delete": { + "$ref": "operations/repos/remove-protected-branch-pull-request-review-enforcement.json" + } + }, + "/repos/{owner}/{repo}/branches/{branch}/protection/required_signatures": { + "get": { + "$ref": "operations/repos/get-protected-branch-required-signatures.json" + }, + "post": { + "$ref": "operations/repos/add-protected-branch-required-signatures.json" + }, + "delete": { + "$ref": "operations/repos/remove-protected-branch-required-signatures.json" + } + }, + "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks": { + "get": { + "$ref": "operations/repos/get-protected-branch-required-status-checks.json" + }, + "patch": { + "$ref": "operations/repos/update-protected-branch-required-status-checks.json" + }, + "delete": { + "$ref": "operations/repos/remove-protected-branch-required-status-checks.json" + } + }, + "/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks/contexts": { + "get": { + "$ref": "operations/repos/list-protected-branch-required-status-checks-contexts.json" + }, + "put": { + "$ref": "operations/repos/replace-protected-branch-required-status-checks-contexts.json" + }, + "post": { + "$ref": "operations/repos/add-protected-branch-required-status-checks-contexts.json" + }, + "delete": { + "$ref": "operations/repos/remove-protected-branch-required-status-checks-contexts.json" + } + }, + "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions": { + "get": { + "$ref": "operations/repos/get-protected-branch-restrictions.json" + }, + "delete": { + "$ref": "operations/repos/remove-protected-branch-restrictions.json" + } + }, + "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/teams": { + "get": { + "$ref": "operations/repos/list-protected-branch-team-restrictions.json" + }, + "put": { + "$ref": "operations/repos/replace-protected-branch-team-restrictions.json" + }, + "post": { + "$ref": "operations/repos/add-protected-branch-team-restrictions.json" + }, + "delete": { + "$ref": "operations/repos/remove-protected-branch-team-restrictions.json" + } + }, + "/repos/{owner}/{repo}/branches/{branch}/protection/restrictions/users": { + "get": { + "$ref": "operations/repos/list-protected-branch-user-restrictions.json" + }, + "put": { + "$ref": "operations/repos/replace-protected-branch-user-restrictions.json" + }, + "post": { + "$ref": "operations/repos/add-protected-branch-user-restrictions.json" + }, + "delete": { + "$ref": "operations/repos/remove-protected-branch-user-restrictions.json" + } + }, + "/repos/{owner}/{repo}/check-runs": { + "post": { + "$ref": "operations/checks/create.json" + } + }, + "/repos/{owner}/{repo}/check-runs/{check_run_id}": { + "patch": { + "$ref": "operations/checks/update.json" + }, + "get": { + "$ref": "operations/checks/get.json" + } + }, + "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations": { + "get": { + "$ref": "operations/checks/list-annotations.json" + } + }, + "/repos/{owner}/{repo}/check-suite-requests": { + "post": { + "$ref": "operations/checks/request-suites.json" + } + }, + "/repos/{owner}/{repo}/check-suites": { + "post": { + "$ref": "operations/checks/create-suite.json" + } + }, + "/repos/{owner}/{repo}/check-suites/preferences": { + "patch": { + "$ref": "operations/checks/set-suites-preferences.json" + } + }, + "/repos/{owner}/{repo}/check-suites/{check_suite_id}": { + "get": { + "$ref": "operations/checks/get-suite.json" + } + }, + "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { + "get": { + "$ref": "operations/checks/list-for-suite.json" + } + }, + "/repos/{owner}/{repo}/collaborators": { + "get": { + "$ref": "operations/repos/list-collaborators.json" + } + }, + "/repos/{owner}/{repo}/collaborators/{username}": { + "get": { + "$ref": "operations/repos/check-collaborator.json" + }, + "put": { + "$ref": "operations/repos/add-collaborator.json" + }, + "delete": { + "$ref": "operations/repos/remove-collaborator.json" + } + }, + "/repos/{owner}/{repo}/collaborators/{username}/permission": { + "get": { + "$ref": "operations/repos/get-collaborator-permission-level.json" + } + }, + "/repos/{owner}/{repo}/comments": { + "get": { + "$ref": "operations/repos/list-commit-comments.json" + } + }, + "/repos/{owner}/{repo}/comments/{comment_id}": { + "get": { + "$ref": "operations/repos/get-commit-comment.json" + }, + "patch": { + "$ref": "operations/repos/update-commit-comment.json" + }, + "delete": { + "$ref": "operations/repos/delete-commit-comment.json" + } + }, + "/repos/{owner}/{repo}/comments/{comment_id}/reactions": { + "get": { + "$ref": "operations/reactions/list-for-commit-comment.json" + }, + "post": { + "$ref": "operations/reactions/create-for-commit-comment.json" + } + }, + "/repos/{owner}/{repo}/commits": { + "get": { + "$ref": "operations/repos/list-commits.json" + } + }, + "/repos/{owner}/{repo}/commits/{commit_sha}/comments": { + "get": { + "$ref": "operations/repos/list-comments-for-commit.json" + }, + "post": { + "$ref": "operations/repos/create-commit-comment.json" + } + }, + "/repos/{owner}/{repo}/commits/{ref}": { + "get": { + "$ref": "operations/repos/get-commit.json" + } + }, + "/repos/{owner}/{repo}/commits/{ref}/check-runs": { + "get": { + "$ref": "operations/checks/list-for-ref.json" + } + }, + "/repos/{owner}/{repo}/commits/{ref}/check-suites": { + "get": { + "$ref": "operations/checks/list-suites-for-ref.json" + } + }, + "/repos/{owner}/{repo}/commits/{ref}/status": { + "get": { + "$ref": "operations/repos/get-combined-status-for-ref.json" + } + }, + "/repos/{owner}/{repo}/commits/{ref}/statuses": { + "get": { + "$ref": "operations/repos/list-statuses-for-ref.json" + } + }, + "/repos/{owner}/{repo}/community/code_of_conduct": { + "get": { + "$ref": "operations/codes_of_conduct/get-for-repo.json" + } + }, + "/repos/{owner}/{repo}/compare/{base}...{head}": { + "get": { + "$ref": "operations/repos/compare-commits.json" + } + }, + "/repos/{owner}/{repo}/contents/{path}": { + "get": { + "$ref": "operations/repos/get-contents.json" + }, + "put": { + "$ref": "operations/repos/create-or-update-file.json" + }, + "delete": { + "$ref": "operations/repos/delete-file.json" + } + }, + "/repos/{owner}/{repo}/contributors": { + "get": { + "$ref": "operations/repos/list-contributors.json" + } + }, + "/repos/{owner}/{repo}/deployments": { + "get": { + "$ref": "operations/repos/list-deployments.json" + }, + "post": { + "$ref": "operations/repos/create-deployment.json" + } + }, + "/repos/{owner}/{repo}/deployments/{deployment_id}": { + "get": { + "$ref": "operations/repos/get-deployment.json" + } + }, + "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses": { + "get": { + "$ref": "operations/repos/list-deployment-statuses.json" + }, + "post": { + "$ref": "operations/repos/create-deployment-status.json" + } + }, + "/repos/{owner}/{repo}/deployments/{deployment_id}/statuses/{status_id}": { + "get": { + "$ref": "operations/repos/get-deployment-status.json" + } + }, + "/repos/{owner}/{repo}/downloads": { + "get": { + "$ref": "operations/repos/list-downloads.json" + } + }, + "/repos/{owner}/{repo}/downloads/{download_id}": { + "get": { + "$ref": "operations/repos/get-download.json" + }, + "delete": { + "$ref": "operations/repos/delete-download.json" + } + }, + "/repos/{owner}/{repo}/events": { + "get": { + "$ref": "operations/activity/list-repo-events.json" + } + }, + "/repos/{owner}/{repo}/forks": { + "get": { + "$ref": "operations/repos/list-forks.json" + }, + "post": { + "$ref": "operations/repos/create-fork.json" + } + }, + "/repos/{owner}/{repo}/git/blobs": { + "post": { + "$ref": "operations/git/create-blob.json" + } + }, + "/repos/{owner}/{repo}/git/blobs/{file_sha}": { + "get": { + "$ref": "operations/git/get-blob.json" + } + }, + "/repos/{owner}/{repo}/git/commits": { + "post": { + "$ref": "operations/git/create-commit.json" + } + }, + "/repos/{owner}/{repo}/git/commits/{commit_sha}": { + "get": { + "$ref": "operations/git/get-commit.json" + } + }, + "/repos/{owner}/{repo}/git/refs": { + "post": { + "$ref": "operations/git/create-ref.json" + } + }, + "/repos/{owner}/{repo}/git/refs/{ref}": { + "get": { + "$ref": "operations/git/get-ref.json" + }, + "patch": { + "$ref": "operations/git/update-ref.json" + }, + "delete": { + "$ref": "operations/git/delete-ref.json" + } + }, + "/repos/{owner}/{repo}/git/tags": { + "post": { + "$ref": "operations/git/create-tag.json" + } + }, + "/repos/{owner}/{repo}/git/tags/{tag_sha}": { + "get": { + "$ref": "operations/git/get-tag.json" + } + }, + "/repos/{owner}/{repo}/git/trees": { + "post": { + "$ref": "operations/git/create-tree.json" + } + }, + "/repos/{owner}/{repo}/git/trees/{tree_sha}": { + "get": { + "$ref": "operations/git/get-tree.json" + } + }, + "/repos/{owner}/{repo}/hooks": { + "get": { + "$ref": "operations/repos/list-hooks.json" + }, + "post": { + "$ref": "operations/repos/create-hook.json" + } + }, + "/repos/{owner}/{repo}/hooks/{hook_id}": { + "get": { + "$ref": "operations/repos/get-hook.json" + }, + "patch": { + "$ref": "operations/repos/update-hook.json" + }, + "delete": { + "$ref": "operations/repos/delete-hook.json" + } + }, + "/repos/{owner}/{repo}/hooks/{hook_id}/pings": { + "post": { + "$ref": "operations/repos/ping-hook.json" + } + }, + "/repos/{owner}/{repo}/hooks/{hook_id}/tests": { + "post": { + "$ref": "operations/repos/test-push-hook.json" + } + }, + "/repos/{owner}/{repo}/installation": { + "get": { + "$ref": "operations/apps/get-repo-installation.json" + } + }, + "/repos/{owner}/{repo}/invitations": { + "get": { + "$ref": "operations/repos/list-invitations.json" + } + }, + "/repos/{owner}/{repo}/invitations/{invitation_id}": { + "delete": { + "$ref": "operations/repos/delete-invitation.json" + }, + "patch": { + "$ref": "operations/repos/update-invitation.json" + } + }, + "/repos/{owner}/{repo}/issues": { + "get": { + "$ref": "operations/issues/list-for-repo.json" + }, + "post": { + "$ref": "operations/issues/create.json" + } + }, + "/repos/{owner}/{repo}/issues/comments": { + "get": { + "$ref": "operations/issues/list-comments-for-repo.json" + } + }, + "/repos/{owner}/{repo}/issues/comments/{comment_id}": { + "get": { + "$ref": "operations/issues/get-comment.json" + }, + "patch": { + "$ref": "operations/issues/update-comment.json" + }, + "delete": { + "$ref": "operations/issues/delete-comment.json" + } + }, + "/repos/{owner}/{repo}/issues/comments/{comment_id}/reactions": { + "get": { + "$ref": "operations/reactions/list-for-issue-comment.json" + }, + "post": { + "$ref": "operations/reactions/create-for-issue-comment.json" + } + }, + "/repos/{owner}/{repo}/issues/events": { + "get": { + "$ref": "operations/issues/list-events-for-repo.json" + } + }, + "/repos/{owner}/{repo}/issues/events/{event_id}": { + "get": { + "$ref": "operations/issues/get-event.json" + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}": { + "get": { + "$ref": "operations/issues/get.json" + }, + "patch": { + "$ref": "operations/issues/update.json" + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/assignees": { + "post": { + "$ref": "operations/issues/add-assignees.json" + }, + "delete": { + "$ref": "operations/issues/remove-assignees.json" + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/comments": { + "get": { + "$ref": "operations/issues/list-comments.json" + }, + "post": { + "$ref": "operations/issues/create-comment.json" + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/events": { + "get": { + "$ref": "operations/issues/list-events.json" + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/labels": { + "get": { + "$ref": "operations/issues/list-labels-on-issue.json" + }, + "post": { + "$ref": "operations/issues/add-labels.json" + }, + "put": { + "$ref": "operations/issues/replace-labels.json" + }, + "delete": { + "$ref": "operations/issues/remove-labels.json" + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/labels/{name}": { + "delete": { + "$ref": "operations/issues/remove-label.json" + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/lock": { + "put": { + "$ref": "operations/issues/lock.json" + }, + "delete": { + "$ref": "operations/issues/unlock.json" + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/reactions": { + "get": { + "$ref": "operations/reactions/list-for-issue.json" + }, + "post": { + "$ref": "operations/reactions/create-for-issue.json" + } + }, + "/repos/{owner}/{repo}/issues/{issue_number}/timeline": { + "get": { + "$ref": "operations/issues/list-events-for-timeline.json" + } + }, + "/repos/{owner}/{repo}/keys": { + "get": { + "$ref": "operations/repos/list-deploy-keys.json" + }, + "post": { + "$ref": "operations/repos/add-deploy-key.json" + } + }, + "/repos/{owner}/{repo}/keys/{key_id}": { + "get": { + "$ref": "operations/repos/get-deploy-key.json" + }, + "delete": { + "$ref": "operations/repos/remove-deploy-key.json" + } + }, + "/repos/{owner}/{repo}/labels": { + "get": { + "$ref": "operations/issues/list-labels-for-repo.json" + }, + "post": { + "$ref": "operations/issues/create-label.json" + } + }, + "/repos/{owner}/{repo}/labels/{name}": { + "get": { + "$ref": "operations/issues/get-label.json" + }, + "delete": { + "$ref": "operations/issues/delete-label.json" + } + }, + "/repos/{owner}/{repo}/languages": { + "get": { + "$ref": "operations/repos/list-languages.json" + } + }, + "/repos/{owner}/{repo}/license": { + "get": { + "$ref": "operations/licenses/get-for-repo.json" + } + }, + "/repos/{owner}/{repo}/merges": { + "post": { + "$ref": "operations/repos/merge.json" + } + }, + "/repos/{owner}/{repo}/milestones": { + "get": { + "$ref": "operations/issues/list-milestones-for-repo.json" + }, + "post": { + "$ref": "operations/issues/create-milestone.json" + } + }, + "/repos/{owner}/{repo}/milestones/{milestone_number}": { + "get": { + "$ref": "operations/issues/get-milestone.json" + }, + "patch": { + "$ref": "operations/issues/update-milestone.json" + }, + "delete": { + "$ref": "operations/issues/delete-milestone.json" + } + }, + "/repos/{owner}/{repo}/milestones/{milestone_number}/labels": { + "get": { + "$ref": "operations/issues/list-labels-for-milestone.json" + } + }, + "/repos/{owner}/{repo}/notifications": { + "get": { + "$ref": "operations/activity/list-notifications-for-repo.json" + }, + "put": { + "$ref": "operations/activity/mark-notifications-as-read-for-repo.json" + } + }, + "/repos/{owner}/{repo}/pages": { + "get": { + "$ref": "operations/repos/get-pages.json" + } + }, + "/repos/{owner}/{repo}/pages/builds": { + "post": { + "$ref": "operations/repos/request-page-build.json" + }, + "get": { + "$ref": "operations/repos/list-pages-builds.json" + } + }, + "/repos/{owner}/{repo}/pages/builds/latest": { + "get": { + "$ref": "operations/repos/get-latest-pages-build.json" + } + }, + "/repos/{owner}/{repo}/pages/builds/{build_id}": { + "get": { + "$ref": "operations/repos/get-pages-build.json" + } + }, + "/repos/{owner}/{repo}/pre-receive-hooks": { + "get": { + "$ref": "operations/enterprise-admin/list-pre-receive-hooks-for-repo.json" + } + }, + "/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}": { + "get": { + "$ref": "operations/enterprise-admin/get-pre-receive-hook-for-repo.json" + }, + "patch": { + "$ref": "operations/enterprise-admin/update-pre-receive-hook-enforcement-for-repo.json" + }, + "delete": { + "$ref": "operations/enterprise-admin/remove-enforcement-overrides-for-pre-receive-hook-for-repo.json" + } + }, + "/repos/{owner}/{repo}/projects": { + "get": { + "$ref": "operations/projects/list-for-repo.json" + }, + "post": { + "$ref": "operations/projects/create-for-repo.json" + } + }, + "/repos/{owner}/{repo}/pulls": { + "get": { + "$ref": "operations/pulls/list.json" + }, + "post": { + "$ref": "operations/pulls/create-from-issue.json" + } + }, + "/repos/{owner}/{repo}/pulls/comments": { + "get": { + "$ref": "operations/pulls/list-comments-for-repo.json" + } + }, + "/repos/{owner}/{repo}/pulls/comments/{comment_id}": { + "get": { + "$ref": "operations/pulls/get-comment.json" + }, + "patch": { + "$ref": "operations/pulls/update-comment.json" + }, + "delete": { + "$ref": "operations/pulls/delete-comment.json" + } + }, + "/repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions": { + "get": { + "$ref": "operations/reactions/list-for-pull-request-review-comment.json" + }, + "post": { + "$ref": "operations/reactions/create-for-pull-request-review-comment.json" + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}": { + "get": { + "$ref": "operations/pulls/get.json" + }, + "patch": { + "$ref": "operations/pulls/update.json" + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/comments": { + "get": { + "$ref": "operations/pulls/list-comments.json" + }, + "post": { + "$ref": "operations/pulls/create-comment-reply.json" + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/commits": { + "get": { + "$ref": "operations/pulls/list-commits.json" + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/files": { + "get": { + "$ref": "operations/pulls/list-files.json" + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/merge": { + "get": { + "$ref": "operations/pulls/check-if-merged.json" + }, + "put": { + "$ref": "operations/pulls/merge.json" + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/requested_reviewers": { + "get": { + "$ref": "operations/pulls/list-review-requests.json" + }, + "post": { + "$ref": "operations/pulls/create-review-request.json" + }, + "delete": { + "$ref": "operations/pulls/delete-review-request.json" + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/reviews": { + "get": { + "$ref": "operations/pulls/list-reviews.json" + }, + "post": { + "$ref": "operations/pulls/create-review.json" + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}": { + "get": { + "$ref": "operations/pulls/get-review.json" + }, + "delete": { + "$ref": "operations/pulls/delete-pending-review.json" + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/comments": { + "get": { + "$ref": "operations/pulls/get-comments-for-review.json" + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/dismissals": { + "put": { + "$ref": "operations/pulls/dismiss-review.json" + } + }, + "/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}/events": { + "post": { + "$ref": "operations/pulls/submit-review.json" + } + }, + "/repos/{owner}/{repo}/readme": { + "get": { + "$ref": "operations/repos/get-readme.json" + } + }, + "/repos/{owner}/{repo}/releases": { + "get": { + "$ref": "operations/repos/list-releases.json" + }, + "post": { + "$ref": "operations/repos/create-release.json" + } + }, + "/repos/{owner}/{repo}/releases/assets/{asset_id}": { + "get": { + "$ref": "operations/repos/get-release-asset.json" + }, + "patch": { + "$ref": "operations/repos/update-release-asset.json" + }, + "delete": { + "$ref": "operations/repos/delete-release-asset.json" + } + }, + "/repos/{owner}/{repo}/releases/latest": { + "get": { + "$ref": "operations/repos/get-latest-release.json" + } + }, + "/repos/{owner}/{repo}/releases/tags/{tag}": { + "get": { + "$ref": "operations/repos/get-release-by-tag.json" + } + }, + "/repos/{owner}/{repo}/releases/{release_id}": { + "get": { + "$ref": "operations/repos/get-release.json" + }, + "patch": { + "$ref": "operations/repos/update-release.json" + }, + "delete": { + "$ref": "operations/repos/delete-release.json" + } + }, + "/repos/{owner}/{repo}/releases/{release_id}/assets": { + "get": { + "$ref": "operations/repos/list-assets-for-release.json" + } + }, + "/repos/{owner}/{repo}/stargazers": { + "get": { + "$ref": "operations/activity/list-stargazers-for-repo.json" + } + }, + "/repos/{owner}/{repo}/stats/code_frequency": { + "get": { + "$ref": "operations/repos/get-code-frequency-stats.json" + } + }, + "/repos/{owner}/{repo}/stats/commit_activity": { + "get": { + "$ref": "operations/repos/get-commit-activity-stats.json" + } + }, + "/repos/{owner}/{repo}/stats/contributors": { + "get": { + "$ref": "operations/repos/get-contributors-stats.json" + } + }, + "/repos/{owner}/{repo}/stats/participation": { + "get": { + "$ref": "operations/repos/get-participation-stats.json" + } + }, + "/repos/{owner}/{repo}/stats/punch_card": { + "get": { + "$ref": "operations/repos/get-punch-card-stats.json" + } + }, + "/repos/{owner}/{repo}/statuses/{sha}": { + "post": { + "$ref": "operations/repos/create-status.json" + } + }, + "/repos/{owner}/{repo}/subscribers": { + "get": { + "$ref": "operations/activity/list-watchers-for-repo.json" + } + }, + "/repos/{owner}/{repo}/subscription": { + "get": { + "$ref": "operations/activity/get-repo-subscription.json" + }, + "put": { + "$ref": "operations/activity/set-repo-subscription.json" + }, + "delete": { + "$ref": "operations/activity/delete-repo-subscription.json" + } + }, + "/repos/{owner}/{repo}/tags": { + "get": { + "$ref": "operations/repos/list-tags.json" + } + }, + "/repos/{owner}/{repo}/teams": { + "get": { + "$ref": "operations/repos/list-teams.json" + } + }, + "/repos/{owner}/{repo}/topics": { + "get": { + "$ref": "operations/repos/list-topics.json" + }, + "put": { + "$ref": "operations/repos/replace-topics.json" + } + }, + "/repos/{owner}/{repo}/transfer": { + "post": { + "$ref": "operations/repos/transfer.json" + } + }, + "/repos/{owner}/{repo}/{archive_format}/{ref}": { + "get": { + "$ref": "operations/repos/get-archive-link.json" + } + }, + "/repositories": { + "get": { + "$ref": "operations/repos/list-public.json" + } + }, + "/search/code": { + "get": { + "$ref": "operations/search/code.json" + } + }, + "/search/commits": { + "get": { + "$ref": "operations/search/commits.json" + } + }, + "/search/issues": { + "get": { + "$ref": "operations/search/issues-and-pull-requests.json" + } + }, + "/search/labels": { + "get": { + "$ref": "operations/search/labels.json" + } + }, + "/search/repositories": { + "get": { + "$ref": "operations/search/repos.json" + } + }, + "/search/topics": { + "get": { + "$ref": "operations/search/topics.json" + } + }, + "/search/users": { + "get": { + "$ref": "operations/search/users.json" + } + }, + "/setup/api/configcheck": { + "get": { + "$ref": "operations/enterprise-admin/check-configuration-status.json" + } + }, + "/setup/api/configure": { + "post": { + "$ref": "operations/enterprise-admin/start-configuration-process.json" + } + }, + "/setup/api/maintenance": { + "get": { + "$ref": "operations/enterprise-admin/check-maintenance-status.json" + }, + "post": { + "$ref": "operations/enterprise-admin/enable-or-disable-maintenance-mode.json" + } + }, + "/setup/api/settings": { + "get": { + "$ref": "operations/enterprise-admin/retrieve-settings.json" + }, + "put": { + "$ref": "operations/enterprise-admin/modify-settings.json" + } + }, + "/setup/api/settings/authorized-keys": { + "get": { + "$ref": "operations/enterprise-admin/retrieve-authorized-ssh-keys.json" + }, + "post": { + "$ref": "operations/enterprise-admin/add-authorized-ssh-key.json" + }, + "delete": { + "$ref": "operations/enterprise-admin/remove-authorized-ssh-key.json" + } + }, + "/setup/api/start": { + "post": { + "$ref": "operations/enterprise-admin/upload-license-for-first-time.json" + } + }, + "/setup/api/upgrade": { + "post": { + "$ref": "operations/enterprise-admin/upgrade-license.json" + } + }, + "/staff/indexing_jobs": { + "post": { + "$ref": "operations/enterprise-admin/queue-indexing-job.json" + } + }, + "/teams/{team_id}": { + "get": { + "$ref": "operations/teams/get.json" + }, + "patch": { + "$ref": "operations/teams/update.json" + }, + "delete": { + "$ref": "operations/teams/delete.json" + } + }, + "/teams/{team_id}/discussions": { + "get": { + "$ref": "operations/teams/list-discussions.json" + }, + "post": { + "$ref": "operations/teams/create-discussion.json" + } + }, + "/teams/{team_id}/discussions/{discussion_number}": { + "get": { + "$ref": "operations/teams/get-discussion.json" + }, + "patch": { + "$ref": "operations/teams/update-discussion.json" + }, + "delete": { + "$ref": "operations/teams/delete-discussion.json" + } + }, + "/teams/{team_id}/discussions/{discussion_number}/comments": { + "get": { + "$ref": "operations/teams/list-discussion-comments.json" + }, + "post": { + "$ref": "operations/teams/create-discussion-comment.json" + } + }, + "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}": { + "get": { + "$ref": "operations/teams/get-discussion-comment.json" + }, + "patch": { + "$ref": "operations/teams/update-discussion-comment.json" + }, + "delete": { + "$ref": "operations/teams/delete-discussion-comment.json" + } + }, + "/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + "get": { + "$ref": "operations/reactions/list-for-team-discussion-comment.json" + }, + "post": { + "$ref": "operations/reactions/create-for-team-discussion-comment.json" + } + }, + "/teams/{team_id}/discussions/{discussion_number}/reactions": { + "get": { + "$ref": "operations/reactions/list-for-team-discussion.json" + }, + "post": { + "$ref": "operations/reactions/create-for-team-discussion.json" + } + }, + "/teams/{team_id}/members": { + "get": { + "$ref": "operations/teams/list-members.json" + } + }, + "/teams/{team_id}/members/{username}": { + "get": { + "$ref": "operations/teams/get-member.json" + }, + "put": { + "$ref": "operations/teams/add-member.json" + }, + "delete": { + "$ref": "operations/teams/remove-member.json" + } + }, + "/teams/{team_id}/memberships/{username}": { + "get": { + "$ref": "operations/teams/get-membership.json" + }, + "put": { + "$ref": "operations/teams/add-or-update-membership.json" + }, + "delete": { + "$ref": "operations/teams/remove-membership.json" + } + }, + "/teams/{team_id}/projects": { + "get": { + "$ref": "operations/teams/list-projects.json" + } + }, + "/teams/{team_id}/projects/{project_id}": { + "get": { + "$ref": "operations/teams/review-project.json" + }, + "put": { + "$ref": "operations/teams/add-or-update-project.json" + }, + "delete": { + "$ref": "operations/teams/remove-project.json" + } + }, + "/teams/{team_id}/repos": { + "get": { + "$ref": "operations/teams/list-repos.json" + } + }, + "/teams/{team_id}/repos/{owner}/{repo}": { + "get": { + "$ref": "operations/teams/check-manages-repo.json" + }, + "put": { + "$ref": "operations/teams/add-or-update-repo.json" + }, + "delete": { + "$ref": "operations/teams/remove-repo.json" + } + }, + "/teams/{team_id}/teams": { + "get": { + "$ref": "operations/teams/list-child.json" + } + }, + "/user": { + "get": { + "$ref": "operations/users/get-authenticated.json" + }, + "patch": { + "$ref": "operations/users/update-authenticated.json" + } + }, + "/user/emails": { + "get": { + "$ref": "operations/users/list-emails.json" + }, + "post": { + "$ref": "operations/users/add-emails.json" + }, + "delete": { + "$ref": "operations/users/delete-emails.json" + } + }, + "/user/followers": { + "get": { + "$ref": "operations/users/list-followers-for-authenticated-user.json" + } + }, + "/user/following": { + "get": { + "$ref": "operations/users/list-following-for-authenticated-user.json" + } + }, + "/user/following/{username}": { + "get": { + "$ref": "operations/users/check-following.json" + }, + "put": { + "$ref": "operations/users/follow.json" + }, + "delete": { + "$ref": "operations/users/unfollow.json" + } + }, + "/user/gpg_keys": { + "get": { + "$ref": "operations/users/list-gpg-keys.json" + }, + "post": { + "$ref": "operations/users/create-gpg-key.json" + } + }, + "/user/gpg_keys/{gpg_key_id}": { + "get": { + "$ref": "operations/users/get-gpg-key.json" + }, + "delete": { + "$ref": "operations/users/delete-gpg-key.json" + } + }, + "/user/installations": { + "get": { + "$ref": "operations/apps/list-installations-for-authenticated-user.json" + } + }, + "/user/installations/{installation_id}/repositories": { + "get": { + "$ref": "operations/apps/list-installation-repos-for-authenticated-user.json" + } + }, + "/user/installations/{installation_id}/repositories/{repository_id}": { + "put": { + "$ref": "operations/apps/add-repo-to-installation.json" + }, + "delete": { + "$ref": "operations/apps/remove-repo-from-installation.json" + } + }, + "/user/issues": { + "get": { + "$ref": "operations/issues/list-for-authenticated-user.json" + } + }, + "/user/keys": { + "get": { + "$ref": "operations/users/list-public-keys.json" + }, + "post": { + "$ref": "operations/users/create-public-key.json" + } + }, + "/user/keys/{key_id}": { + "get": { + "$ref": "operations/users/get-public-key.json" + }, + "delete": { + "$ref": "operations/users/delete-public-key.json" + } + }, + "/user/memberships/orgs": { + "get": { + "$ref": "operations/orgs/list-memberships.json" + } + }, + "/user/memberships/orgs/{org}": { + "get": { + "$ref": "operations/orgs/get-membership-for-authenticated-user.json" + }, + "patch": { + "$ref": "operations/orgs/update-membership.json" + } + }, + "/user/orgs": { + "get": { + "$ref": "operations/orgs/list-for-authenticated-user.json" + } + }, + "/user/public_emails": { + "get": { + "$ref": "operations/users/list-public-emails.json" + } + }, + "/user/repos": { + "get": { + "$ref": "operations/repos/list.json" + }, + "post": { + "$ref": "operations/repos/create-for-authenticated-user.json" + } + }, + "/user/repository_invitations": { + "get": { + "$ref": "operations/repos/list-invitations-for-authenticated-user.json" + } + }, + "/user/repository_invitations/{invitation_id}": { + "patch": { + "$ref": "operations/repos/accept-invitation.json" + }, + "delete": { + "$ref": "operations/repos/decline-invitation.json" + } + }, + "/user/starred": { + "get": { + "$ref": "operations/activity/list-repos-starred-by-authenticated-user.json" + } + }, + "/user/starred/{owner}/{repo}": { + "get": { + "$ref": "operations/activity/check-starring-repo.json" + }, + "put": { + "$ref": "operations/activity/star-repo.json" + }, + "delete": { + "$ref": "operations/activity/unstar-repo.json" + } + }, + "/user/subscriptions": { + "get": { + "$ref": "operations/activity/list-watched-repos-for-authenticated-user.json" + } + }, + "/user/subscriptions/{owner}/{repo}": { + "get": { + "$ref": "operations/activity/check-watching-repo-legacy.json" + }, + "put": { + "$ref": "operations/activity/watch-repo-legacy.json" + }, + "delete": { + "$ref": "operations/activity/stop-watching-repo-legacy.json" + } + }, + "/user/teams": { + "get": { + "$ref": "operations/teams/list-for-authenticated-user.json" + } + }, + "/users": { + "get": { + "$ref": "operations/users/list.json" + } + }, + "/users/{username}": { + "get": { + "$ref": "operations/users/get-by-username.json" + } + }, + "/users/{username}/events": { + "get": { + "$ref": "operations/activity/list-events-for-user.json" + } + }, + "/users/{username}/events/orgs/{org}": { + "get": { + "$ref": "operations/activity/list-events-for-org.json" + } + }, + "/users/{username}/events/public": { + "get": { + "$ref": "operations/activity/list-public-events-for-user.json" + } + }, + "/users/{username}/followers": { + "get": { + "$ref": "operations/users/list-followers-for-user.json" + } + }, + "/users/{username}/following": { + "get": { + "$ref": "operations/users/list-following-for-user.json" + } + }, + "/users/{username}/following/{target_user}": { + "get": { + "$ref": "operations/users/check-following-for-user.json" + } + }, + "/users/{username}/gists": { + "get": { + "$ref": "operations/gists/list-public-for-user.json" + } + }, + "/users/{username}/gpg_keys": { + "get": { + "$ref": "operations/users/list-gpg-keys-for-user.json" + } + }, + "/users/{username}/hovercard": { + "get": { + "$ref": "operations/users/get-context-for-user.json" + } + }, + "/users/{username}/installation": { + "get": { + "$ref": "operations/apps/get-user-installation.json" + } + }, + "/users/{username}/keys": { + "get": { + "$ref": "operations/users/list-public-keys-for-user.json" + } + }, + "/users/{username}/orgs": { + "get": { + "$ref": "operations/orgs/list-for-user.json" + } + }, + "/users/{username}/received_events": { + "get": { + "$ref": "operations/activity/list-received-events-for-user.json" + } + }, + "/users/{username}/received_events/public": { + "get": { + "$ref": "operations/activity/list-received-public-events-for-user.json" + } + }, + "/users/{username}/repos": { + "get": { + "$ref": "operations/repos/list-for-user.json" + } + }, + "/users/{username}/site_admin": { + "put": { + "$ref": "operations/enterprise-admin/promote-ordinary-user-to-site-administrator.json" + }, + "delete": { + "$ref": "operations/enterprise-admin/demote-site-administrator-to-ordinary-user.json" + } + }, + "/users/{username}/starred": { + "get": { + "$ref": "operations/activity/list-repos-starred-by-user.json" + } + }, + "/users/{username}/subscriptions": { + "get": { + "$ref": "operations/activity/list-repos-watched-by-user.json" + } + }, + "/users/{username}/suspended": { + "put": { + "$ref": "operations/enterprise-admin/suspend-user.json" + }, + "delete": { + "$ref": "operations/enterprise-admin/unsuspend-user.json" + } + } + } +} diff --git a/openapi/ghe-2.14/operations/activity/check-starring-repo.json b/openapi/ghe-2.14/operations/activity/check-starring-repo.json new file mode 100644 index 0000000000..ef31ae4f69 --- /dev/null +++ b/openapi/ghe-2.14/operations/activity/check-starring-repo.json @@ -0,0 +1,62 @@ +{ + "summary": "Check if you are starring a repository", + "description": "Requires for the user to be authenticated.", + "operationId": "activity-check-starring-repo", + "tags": [ + "activity" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/activity/starring/#check-if-you-are-starring-a-repository" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/user/starred/octocat/:repo" + }, + { + "lang": "JS", + "source": "octokit.activity.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/activity/check-watching-repo-legacy.json b/openapi/ghe-2.14/operations/activity/check-watching-repo-legacy.json new file mode 100644 index 0000000000..4e499fb000 --- /dev/null +++ b/openapi/ghe-2.14/operations/activity/check-watching-repo-legacy.json @@ -0,0 +1,62 @@ +{ + "summary": "Check if you are watching a repository (LEGACY)", + "description": "Requires for the user to be authenticated.", + "operationId": "activity-check-watching-repo-legacy", + "tags": [ + "activity" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/activity/watching/#check-if-you-are-watching-a-repository-legacy" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/user/subscriptions/octocat/:repo" + }, + { + "lang": "JS", + "source": "octokit.activity.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": true, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/activity/delete-repo-subscription.json b/openapi/ghe-2.14/operations/activity/delete-repo-subscription.json new file mode 100644 index 0000000000..a6a66b6d3a --- /dev/null +++ b/openapi/ghe-2.14/operations/activity/delete-repo-subscription.json @@ -0,0 +1,62 @@ +{ + "summary": "Delete a Repository Subscription", + "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/enterprise/2.14/v3/activity/watching/#set-a-repository-subscription).", + "operationId": "activity-delete-repo-subscription", + "tags": [ + "activity" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/activity/watching/#delete-a-repository-subscription" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/subscription" + }, + { + "lang": "JS", + "source": "octokit.activity.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/activity/delete-thread-subscription.json b/openapi/ghe-2.14/operations/activity/delete-thread-subscription.json new file mode 100644 index 0000000000..2b56dd0fed --- /dev/null +++ b/openapi/ghe-2.14/operations/activity/delete-thread-subscription.json @@ -0,0 +1,53 @@ +{ + "summary": "Delete a thread subscription", + "description": "Mutes all future notifications for a conversation until you comment on the thread or get **@mention**ed.", + "operationId": "activity-delete-thread-subscription", + "tags": [ + "activity" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/activity/notifications/#delete-a-thread-subscription" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "thread_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "thread_id parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/notifications/threads//subscription" + }, + { + "lang": "JS", + "source": "octokit.activity.get({\n thread_id: 'thread_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/activity/get-repo-subscription.json b/openapi/ghe-2.14/operations/activity/get-repo-subscription.json new file mode 100644 index 0000000000..f303e9c9c7 --- /dev/null +++ b/openapi/ghe-2.14/operations/activity/get-repo-subscription.json @@ -0,0 +1,62 @@ +{ + "summary": "Get a Repository Subscription", + "description": "", + "operationId": "activity-get-repo-subscription", + "tags": [ + "activity" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/activity/watching/#get-a-repository-subscription" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/subscription" + }, + { + "lang": "JS", + "source": "octokit.activity.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/activity/get-thread-subscription.json b/openapi/ghe-2.14/operations/activity/get-thread-subscription.json new file mode 100644 index 0000000000..1802b7f78f --- /dev/null +++ b/openapi/ghe-2.14/operations/activity/get-thread-subscription.json @@ -0,0 +1,79 @@ +{ + "summary": "Get a thread subscription", + "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/enterprise/2.14/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.", + "operationId": "activity-get-thread-subscription", + "tags": [ + "activity" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/activity/notifications/#get-a-thread-subscription" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "thread_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "thread_id parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "subscribed": { + "type": "boolean" + }, + "ignored": { + "type": "boolean" + }, + "reason": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "thread_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/notifications/threads//subscription" + }, + { + "lang": "JS", + "source": "octokit.activity.get({\n thread_id: 'thread_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/activity/get-thread.json b/openapi/ghe-2.14/operations/activity/get-thread.json new file mode 100644 index 0000000000..7b238d88e0 --- /dev/null +++ b/openapi/ghe-2.14/operations/activity/get-thread.json @@ -0,0 +1,298 @@ +{ + "summary": "View a single thread", + "description": "", + "operationId": "activity-get-thread", + "tags": [ + "activity" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/activity/notifications/#view-a-single-thread" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "thread_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "thread_id parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "string" + }, + "repository": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + } + } + }, + "subject": { + "type": "object", + "properties": { + "title": { + "type": "string" + }, + "url": { + "type": "string" + }, + "latest_comment_url": { + "type": "string" + }, + "type": { + "type": "string" + } + } + }, + "reason": { + "type": "string" + }, + "unread": { + "type": "boolean" + }, + "updated_at": { + "type": "string" + }, + "last_read_at": { + "type": "string" + }, + "url": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/notifications/threads/" + }, + { + "lang": "JS", + "source": "octokit.activity.get({\n thread_id: 'thread_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/activity/list-events-for-org.json b/openapi/ghe-2.14/operations/activity/list-events-for-org.json new file mode 100644 index 0000000000..3c0530a0bf --- /dev/null +++ b/openapi/ghe-2.14/operations/activity/list-events-for-org.json @@ -0,0 +1,82 @@ +{ + "summary": "List events for an organization", + "description": "This is the user's organization dashboard. You must be authenticated as the user to view this.", + "operationId": "activity-list-events-for-org", + "tags": [ + "activity" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/activity/events/#list-events-for-an-organization" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + }, + { + "name": "org", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "org parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/users//events/orgs/:org" + }, + { + "lang": "JS", + "source": "octokit.activity.get({\n username: 'username',\n org: 'org'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/activity/list-events-for-user.json b/openapi/ghe-2.14/operations/activity/list-events-for-user.json new file mode 100644 index 0000000000..5335d7b317 --- /dev/null +++ b/openapi/ghe-2.14/operations/activity/list-events-for-user.json @@ -0,0 +1,73 @@ +{ + "summary": "List events performed by a user", + "description": "If you are authenticated as the given user, you will see your private events. Otherwise, you'll only see public events.", + "operationId": "activity-list-events-for-user", + "tags": [ + "activity" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/activity/events/#list-events-performed-by-a-user" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/users//events" + }, + { + "lang": "JS", + "source": "octokit.activity.get({\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/activity/list-feeds.json b/openapi/ghe-2.14/operations/activity/list-feeds.json new file mode 100644 index 0000000000..c68bb0d743 --- /dev/null +++ b/openapi/ghe-2.14/operations/activity/list-feeds.json @@ -0,0 +1,161 @@ +{ + "summary": "List feeds", + "description": "GitHub Enterprise provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user:\n\n* **Timeline**: The GitHub Enterprise global public timeline\n* **User**: The public timeline for any user, using [URI template](https://developer.github.com/enterprise/2.14/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\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://developer.github.com/enterprise/2.14/v3/#basic-authentication) since current feed URIs use the older, non revocable auth tokens.", + "operationId": "activity-list-feeds", + "tags": [ + "activity" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/activity/feeds/#list-feeds" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "timeline_url": { + "type": "string" + }, + "user_url": { + "type": "string" + }, + "current_user_public_url": { + "type": "string" + }, + "current_user_url": { + "type": "string" + }, + "current_user_actor_url": { + "type": "string" + }, + "current_user_organization_url": { + "type": "string" + }, + "current_user_organization_urls": { + "type": "array", + "items": { + "type": "string" + } + }, + "_links": { + "type": "object", + "properties": { + "timeline": { + "type": "object", + "properties": { + "href": { + "type": "string" + }, + "type": { + "type": "string" + } + } + }, + "user": { + "type": "object", + "properties": { + "href": { + "type": "string" + }, + "type": { + "type": "string" + } + } + }, + "current_user_public": { + "type": "object", + "properties": { + "href": { + "type": "string" + }, + "type": { + "type": "string" + } + } + }, + "current_user": { + "type": "object", + "properties": { + "href": { + "type": "string" + }, + "type": { + "type": "string" + } + } + }, + "current_user_actor": { + "type": "object", + "properties": { + "href": { + "type": "string" + }, + "type": { + "type": "string" + } + } + }, + "current_user_organization": { + "type": "object", + "properties": { + "href": { + "type": "string" + }, + "type": { + "type": "string" + } + } + }, + "current_user_organizations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "href": { + "type": "string" + }, + "type": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/feeds" + }, + { + "lang": "JS", + "source": "octokit.activity.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/activity/list-notifications-for-repo.json b/openapi/ghe-2.14/operations/activity/list-notifications-for-repo.json new file mode 100644 index 0000000000..0ce87a8e51 --- /dev/null +++ b/openapi/ghe-2.14/operations/activity/list-notifications-for-repo.json @@ -0,0 +1,125 @@ +{ + "summary": "List your notifications in a repository", + "description": "List all notifications for the current user.", + "operationId": "activity-list-notifications-for-repo", + "tags": [ + "activity" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/activity/notifications/#list-your-notifications-in-a-repository" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "all", + "in": "query", + "schema": { + "type": "boolean", + "default": false + }, + "required": false, + "description": "If `true`, show notifications marked as read." + }, + { + "name": "participating", + "in": "query", + "schema": { + "type": "boolean", + "default": false + }, + "required": false, + "description": "If `true`, only shows notifications in which the user is directly participating or mentioned." + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "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`." + }, + { + "name": "before", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "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`." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/notifications" + }, + { + "lang": "JS", + "source": "octokit.activity.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/activity/list-notifications.json b/openapi/ghe-2.14/operations/activity/list-notifications.json new file mode 100644 index 0000000000..fb4ab08ef5 --- /dev/null +++ b/openapi/ghe-2.14/operations/activity/list-notifications.json @@ -0,0 +1,107 @@ +{ + "summary": "List your notifications", + "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.", + "operationId": "activity-list-notifications", + "tags": [ + "activity" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/activity/notifications/#list-your-notifications" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "all", + "in": "query", + "schema": { + "type": "boolean", + "default": false + }, + "required": false, + "description": "If `true`, show notifications marked as read." + }, + { + "name": "participating", + "in": "query", + "schema": { + "type": "boolean", + "default": false + }, + "required": false, + "description": "If `true`, only shows notifications in which the user is directly participating or mentioned." + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "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`." + }, + { + "name": "before", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "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`." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/notifications" + }, + { + "lang": "JS", + "source": "octokit.activity.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/activity/list-public-events-for-org.json b/openapi/ghe-2.14/operations/activity/list-public-events-for-org.json new file mode 100644 index 0000000000..d3117e9a9f --- /dev/null +++ b/openapi/ghe-2.14/operations/activity/list-public-events-for-org.json @@ -0,0 +1,73 @@ +{ + "summary": "List public events for an organization", + "description": "", + "operationId": "activity-list-public-events-for-org", + "tags": [ + "activity" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/activity/events/#list-public-events-for-an-organization" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "org", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "org parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/orgs//events" + }, + { + "lang": "JS", + "source": "octokit.activity.get({\n org: 'org'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/activity/list-public-events-for-repo-network.json b/openapi/ghe-2.14/operations/activity/list-public-events-for-repo-network.json new file mode 100644 index 0000000000..72445842f2 --- /dev/null +++ b/openapi/ghe-2.14/operations/activity/list-public-events-for-repo-network.json @@ -0,0 +1,82 @@ +{ + "summary": "List public events for a network of repositories", + "description": "", + "operationId": "activity-list-public-events-for-repo-network", + "tags": [ + "activity" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/activity/events/#list-public-events-for-a-network-of-repositories" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/networks/octocat/:repo/events" + }, + { + "lang": "JS", + "source": "octokit.activity.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/activity/list-public-events-for-user.json b/openapi/ghe-2.14/operations/activity/list-public-events-for-user.json new file mode 100644 index 0000000000..8488cc3574 --- /dev/null +++ b/openapi/ghe-2.14/operations/activity/list-public-events-for-user.json @@ -0,0 +1,73 @@ +{ + "summary": "List public events performed by a user", + "description": "", + "operationId": "activity-list-public-events-for-user", + "tags": [ + "activity" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/activity/events/#list-public-events-performed-by-a-user" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/users//events/public" + }, + { + "lang": "JS", + "source": "octokit.activity.get({\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/activity/list-public-events.json b/openapi/ghe-2.14/operations/activity/list-public-events.json new file mode 100644 index 0000000000..6418e39c6e --- /dev/null +++ b/openapi/ghe-2.14/operations/activity/list-public-events.json @@ -0,0 +1,64 @@ +{ + "summary": "List public events", + "description": "", + "operationId": "activity-list-public-events", + "tags": [ + "activity" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/activity/events/#list-public-events" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/events" + }, + { + "lang": "JS", + "source": "octokit.activity.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/activity/list-received-events-for-user.json b/openapi/ghe-2.14/operations/activity/list-received-events-for-user.json new file mode 100644 index 0000000000..0d0db54e7d --- /dev/null +++ b/openapi/ghe-2.14/operations/activity/list-received-events-for-user.json @@ -0,0 +1,73 @@ +{ + "summary": "List events that a user has received", + "description": "These are events that you've received by watching repos and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events.", + "operationId": "activity-list-received-events-for-user", + "tags": [ + "activity" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/activity/events/#list-events-that-a-user-has-received" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/users//received_events" + }, + { + "lang": "JS", + "source": "octokit.activity.get({\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/activity/list-received-public-events-for-user.json b/openapi/ghe-2.14/operations/activity/list-received-public-events-for-user.json new file mode 100644 index 0000000000..14d54ff5b5 --- /dev/null +++ b/openapi/ghe-2.14/operations/activity/list-received-public-events-for-user.json @@ -0,0 +1,73 @@ +{ + "summary": "List public events that a user has received", + "description": "", + "operationId": "activity-list-received-public-events-for-user", + "tags": [ + "activity" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/activity/events/#list-public-events-that-a-user-has-received" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/users//received_events/public" + }, + { + "lang": "JS", + "source": "octokit.activity.get({\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/activity/list-repo-events.json b/openapi/ghe-2.14/operations/activity/list-repo-events.json new file mode 100644 index 0000000000..cadc765dbb --- /dev/null +++ b/openapi/ghe-2.14/operations/activity/list-repo-events.json @@ -0,0 +1,82 @@ +{ + "summary": "List repository events", + "description": "", + "operationId": "activity-list-repo-events", + "tags": [ + "activity" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/activity/events/#list-repository-events" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/events" + }, + { + "lang": "JS", + "source": "octokit.activity.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/activity/list-repos-starred-by-authenticated-user.json b/openapi/ghe-2.14/operations/activity/list-repos-starred-by-authenticated-user.json new file mode 100644 index 0000000000..0bca29f54a --- /dev/null +++ b/openapi/ghe-2.14/operations/activity/list-repos-starred-by-authenticated-user.json @@ -0,0 +1,97 @@ +{ + "summary": "List repositories being starred by the authenticated user", + "description": "You can also find out _when_ stars were created by passing the following custom [media type](https://developer.github.com/enterprise/2.14/v3/media/) via the `Accept` header:", + "operationId": "activity-list-repos-starred-by-authenticated-user", + "tags": [ + "activity" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/activity/starring/#list-repositories-being-starred" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "created", + "updated" + ], + "default": "created" + }, + "required": false, + "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to)." + }, + { + "name": "direction", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "required": false, + "description": "One of `asc` (ascending) or `desc` (descending)." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/user/starred" + }, + { + "lang": "JS", + "source": "octokit.activity.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/activity/list-repos-starred-by-user.json b/openapi/ghe-2.14/operations/activity/list-repos-starred-by-user.json new file mode 100644 index 0000000000..2f63c067e4 --- /dev/null +++ b/openapi/ghe-2.14/operations/activity/list-repos-starred-by-user.json @@ -0,0 +1,106 @@ +{ + "summary": "List repositories being starred by a user", + "description": "You can also find out _when_ stars were created by passing the following custom [media type](https://developer.github.com/enterprise/2.14/v3/media/) via the `Accept` header:", + "operationId": "activity-list-repos-starred-by-user", + "tags": [ + "activity" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/activity/starring/#list-repositories-being-starred" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "created", + "updated" + ], + "default": "created" + }, + "required": false, + "description": "One of `created` (when the repository was starred) or `updated` (when it was last pushed to)." + }, + { + "name": "direction", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "required": false, + "description": "One of `asc` (ascending) or `desc` (descending)." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/users//starred" + }, + { + "lang": "JS", + "source": "octokit.activity.get({\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/activity/list-repos-watched-by-user.json b/openapi/ghe-2.14/operations/activity/list-repos-watched-by-user.json new file mode 100644 index 0000000000..62106cefae --- /dev/null +++ b/openapi/ghe-2.14/operations/activity/list-repos-watched-by-user.json @@ -0,0 +1,78 @@ +{ + "summary": "List repositories being watched by a user", + "description": "", + "operationId": "activity-list-repos-watched-by-user", + "tags": [ + "activity" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/activity/watching/#list-repositories-being-watched" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/users//subscriptions" + }, + { + "lang": "JS", + "source": "octokit.activity.get({\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/activity/list-stargazers-for-repo.json b/openapi/ghe-2.14/operations/activity/list-stargazers-for-repo.json new file mode 100644 index 0000000000..666ecf7bf5 --- /dev/null +++ b/openapi/ghe-2.14/operations/activity/list-stargazers-for-repo.json @@ -0,0 +1,87 @@ +{ + "summary": "List Stargazers", + "description": "You can also find out _when_ stars were created by passing the following custom [media type](https://developer.github.com/enterprise/2.14/v3/media/) via the `Accept` header:", + "operationId": "activity-list-stargazers-for-repo", + "tags": [ + "activity" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/activity/starring/#list-stargazers" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/stargazers" + }, + { + "lang": "JS", + "source": "octokit.activity.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/activity/list-watched-repos-for-authenticated-user.json b/openapi/ghe-2.14/operations/activity/list-watched-repos-for-authenticated-user.json new file mode 100644 index 0000000000..7cf1b147b3 --- /dev/null +++ b/openapi/ghe-2.14/operations/activity/list-watched-repos-for-authenticated-user.json @@ -0,0 +1,69 @@ +{ + "summary": "List repositories being watched by the authenticated user", + "description": "", + "operationId": "activity-list-watched-repos-for-authenticated-user", + "tags": [ + "activity" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/activity/watching/#list-repositories-being-watched" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/user/subscriptions" + }, + { + "lang": "JS", + "source": "octokit.activity.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/activity/list-watchers-for-repo.json b/openapi/ghe-2.14/operations/activity/list-watchers-for-repo.json new file mode 100644 index 0000000000..e6f54c93b9 --- /dev/null +++ b/openapi/ghe-2.14/operations/activity/list-watchers-for-repo.json @@ -0,0 +1,87 @@ +{ + "summary": "List watchers", + "description": "", + "operationId": "activity-list-watchers-for-repo", + "tags": [ + "activity" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/activity/watching/#list-watchers" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/subscribers" + }, + { + "lang": "JS", + "source": "octokit.activity.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/activity/mark-as-read.json b/openapi/ghe-2.14/operations/activity/mark-as-read.json new file mode 100644 index 0000000000..12e3d3b4a2 --- /dev/null +++ b/openapi/ghe-2.14/operations/activity/mark-as-read.json @@ -0,0 +1,64 @@ +{ + "summary": "Mark as read", + "description": "Marking a notification as \"read\" removes it from the [default view on GitHub Enterprise](https://github.com/notifications).", + "operationId": "activity-mark-as-read", + "tags": [ + "activity" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/activity/notifications/#mark-as-read" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "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: current date/time", + "type": "string" + } + } + } + } + } + }, + "responses": { + "205": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPUT \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/notifications" + }, + { + "lang": "JS", + "source": "octokit.activity.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/activity/mark-notifications-as-read-for-repo.json b/openapi/ghe-2.14/operations/activity/mark-notifications-as-read-for-repo.json new file mode 100644 index 0000000000..0c4d9c4af5 --- /dev/null +++ b/openapi/ghe-2.14/operations/activity/mark-notifications-as-read-for-repo.json @@ -0,0 +1,82 @@ +{ + "summary": "Mark notifications as read in a repository", + "description": "Marking all notifications in a repository as \"read\" removes them from the [default view on GitHub Enterprise](https://github.com/notifications).", + "operationId": "activity-mark-notifications-as-read-for-repo", + "tags": [ + "activity" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/activity/notifications/#mark-notifications-as-read-in-a-repository" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "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: current date/time", + "type": "string" + } + } + } + } + } + }, + "responses": { + "205": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPUT \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/notifications" + }, + { + "lang": "JS", + "source": "octokit.activity.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/activity/mark-thread-as-read.json b/openapi/ghe-2.14/operations/activity/mark-thread-as-read.json new file mode 100644 index 0000000000..96ec5b84d5 --- /dev/null +++ b/openapi/ghe-2.14/operations/activity/mark-thread-as-read.json @@ -0,0 +1,58 @@ +{ + "summary": "Mark a thread as read", + "description": "", + "operationId": "activity-mark-thread-as-read", + "tags": [ + "activity" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/activity/notifications/#mark-a-thread-as-read" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "thread_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "thread_id parameter" + } + ], + "responses": { + "205": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPATCH \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/notifications/threads/" + }, + { + "lang": "JS", + "source": "octokit.activity.get({\n thread_id: 'thread_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/activity/set-repo-subscription.json b/openapi/ghe-2.14/operations/activity/set-repo-subscription.json new file mode 100644 index 0000000000..7f224b8faf --- /dev/null +++ b/openapi/ghe-2.14/operations/activity/set-repo-subscription.json @@ -0,0 +1,107 @@ +{ + "summary": "Set a Repository Subscription", + "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/enterprise/2.14/v3/activity/watching/#delete-a-repository-subscription) completely.", + "operationId": "activity-set-repo-subscription", + "tags": [ + "activity" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/activity/watching/#set-a-repository-subscription" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "subscribed": { + "description": "Determines if notifications should be received from this repository.", + "type": "boolean" + }, + "ignored": { + "description": "Determines if all notifications should be blocked from this repository.", + "type": "boolean" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "subscribed": { + "type": "boolean" + }, + "ignored": { + "type": "boolean" + }, + "reason": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repository_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPUT \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/subscription" + }, + { + "lang": "JS", + "source": "octokit.activity.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/activity/set-thread-subscription.json b/openapi/ghe-2.14/operations/activity/set-thread-subscription.json new file mode 100644 index 0000000000..3c6adf706d --- /dev/null +++ b/openapi/ghe-2.14/operations/activity/set-thread-subscription.json @@ -0,0 +1,95 @@ +{ + "summary": "Set a thread subscription", + "description": "This lets you subscribe or unsubscribe from a conversation.", + "operationId": "activity-set-thread-subscription", + "tags": [ + "activity" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/activity/notifications/#set-a-thread-subscription" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "thread_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "thread_id parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "ignored": { + "description": "Unsubscribes and subscribes you to a conversation. Set `ignored` to `true` to block all notifications from this thread.", + "type": "boolean", + "default": false + } + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "subscribed": { + "type": "boolean" + }, + "ignored": { + "type": "boolean" + }, + "reason": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "thread_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPUT \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/notifications/threads//subscription" + }, + { + "lang": "JS", + "source": "octokit.activity.get({\n thread_id: 'thread_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/activity/star-repo.json b/openapi/ghe-2.14/operations/activity/star-repo.json new file mode 100644 index 0000000000..a107079dfd --- /dev/null +++ b/openapi/ghe-2.14/operations/activity/star-repo.json @@ -0,0 +1,62 @@ +{ + "summary": "Star a repository", + "description": "Requires for the user to be authenticated.\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/enterprise/2.14/v3/#http-verbs).\"", + "operationId": "activity-star-repo", + "tags": [ + "activity" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/activity/starring/#star-a-repository" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPUT \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/user/starred/octocat/:repo" + }, + { + "lang": "JS", + "source": "octokit.activity.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/activity/stop-watching-repo-legacy.json b/openapi/ghe-2.14/operations/activity/stop-watching-repo-legacy.json new file mode 100644 index 0000000000..745326f262 --- /dev/null +++ b/openapi/ghe-2.14/operations/activity/stop-watching-repo-legacy.json @@ -0,0 +1,62 @@ +{ + "summary": "Stop watching a repository (LEGACY)", + "description": "Requires for the user to be authenticated.", + "operationId": "activity-stop-watching-repo-legacy", + "tags": [ + "activity" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/activity/watching/#stop-watching-a-repository-legacy" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/user/subscriptions/octocat/:repo" + }, + { + "lang": "JS", + "source": "octokit.activity.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": true, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/activity/unstar-repo.json b/openapi/ghe-2.14/operations/activity/unstar-repo.json new file mode 100644 index 0000000000..12447077b9 --- /dev/null +++ b/openapi/ghe-2.14/operations/activity/unstar-repo.json @@ -0,0 +1,62 @@ +{ + "summary": "Unstar a repository", + "description": "Requires for the user to be authenticated.", + "operationId": "activity-unstar-repo", + "tags": [ + "activity" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/activity/starring/#unstar-a-repository" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/user/starred/octocat/:repo" + }, + { + "lang": "JS", + "source": "octokit.activity.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/activity/watch-repo-legacy.json b/openapi/ghe-2.14/operations/activity/watch-repo-legacy.json new file mode 100644 index 0000000000..9de98e1054 --- /dev/null +++ b/openapi/ghe-2.14/operations/activity/watch-repo-legacy.json @@ -0,0 +1,62 @@ +{ + "summary": "Watch a repository (LEGACY)", + "description": "Requires the user to be authenticated.\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/enterprise/2.14/v3/#http-verbs).\"", + "operationId": "activity-watch-repo-legacy", + "tags": [ + "activity" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/activity/watching/#watch-a-repository-legacy" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPUT \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/user/subscriptions/octocat/:repo" + }, + { + "lang": "JS", + "source": "octokit.activity.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": true, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/apps/add-repo-to-installation.json b/openapi/ghe-2.14/operations/apps/add-repo-to-installation.json new file mode 100644 index 0000000000..fd8c723377 --- /dev/null +++ b/openapi/ghe-2.14/operations/apps/add-repo-to-installation.json @@ -0,0 +1,63 @@ +{ + "summary": "Add repository to installation", + "description": "Add a single repository to an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://developer.github.com/enterprise/2.14/v3/oauth_authorizations/#create-a-new-authorization)) or [Basic Authentication](https://developer.github.com/enterprise/2.14/v3/auth/#basic-authentication) to access this endpoint.", + "operationId": "apps-add-repo-to-installation", + "tags": [ + "apps" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/apps/installations/#add-repository-to-installation" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.machine-man-preview+json" + }, + "required": true + }, + { + "name": "installation_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "installation_id parameter" + }, + { + "name": "repository_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "repository_id parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPUT \\\n -H\"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://developer.github.com/user/installations//repositories/:repository_id" + }, + { + "lang": "JS", + "source": "octokit.apps.get({\n installation_id: 'installation_id',\n repository_id: 'repository_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/apps/create-installation-token.json b/openapi/ghe-2.14/operations/apps/create-installation-token.json new file mode 100644 index 0000000000..cf3be840f9 --- /dev/null +++ b/openapi/ghe-2.14/operations/apps/create-installation-token.json @@ -0,0 +1,68 @@ +{ + "summary": "Create a new installation token", + "description": "Creates an installation access token that enables a GitHub App to make authenticated API requests for the app's installation on an organization or individual account. Installation tokens expire one hour from the time you create them. Using an expired token produces a status code of `401 - Unauthorized`, and requires creating a new installation token.\n\nYou must use a [JWT](https://developer.github.com/enterprise/2.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "operationId": "apps-create-installation-token", + "tags": [ + "apps" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/apps/#create-a-new-installation-token" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.machine-man-preview+json" + }, + "required": true + }, + { + "name": "installation_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "installation_id parameter" + } + ], + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "token": { + "type": "string" + }, + "expires_at": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://developer.github.com/installations//access_tokens" + }, + { + "lang": "JS", + "source": "octokit.apps.get({\n installation_id: 'installation_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/apps/get-authenticated.json b/openapi/ghe-2.14/operations/apps/get-authenticated.json new file mode 100644 index 0000000000..47db38738b --- /dev/null +++ b/openapi/ghe-2.14/operations/apps/get-authenticated.json @@ -0,0 +1,121 @@ +{ + "summary": "Get the authenticated GitHub App", + "description": "Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app's installations, see the \"[List installations](https://developer.github.com/enterprise/2.14/v3/apps/#list-installations)\" endpoint.\n\nYou must use a [JWT](https://developer.github.com/enterprise/2.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "operationId": "apps-get-authenticated", + "tags": [ + "apps" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/apps/#get-the-authenticated-github-app" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.machine-man-preview+json" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + } + } + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "external_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "installations_count": { + "type": "number" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://developer.github.com/app" + }, + { + "lang": "JS", + "source": "octokit.apps.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/apps/get-by-slug.json b/openapi/ghe-2.14/operations/apps/get-by-slug.json new file mode 100644 index 0000000000..c7b70904ea --- /dev/null +++ b/openapi/ghe-2.14/operations/apps/get-by-slug.json @@ -0,0 +1,127 @@ +{ + "summary": "Get a single GitHub App", + "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/enterprise/2.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "operationId": "apps-get-by-slug", + "tags": [ + "apps" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/apps/#get-a-single-github-app" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.machine-man-preview+json" + }, + "required": true + }, + { + "name": "app_slug", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "app_slug parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + } + } + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "external_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://developer.github.com/apps/" + }, + { + "lang": "JS", + "source": "octokit.apps.get({\n app_slug: 'app_slug'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/apps/get-installation.json b/openapi/ghe-2.14/operations/apps/get-installation.json new file mode 100644 index 0000000000..1a246399e2 --- /dev/null +++ b/openapi/ghe-2.14/operations/apps/get-installation.json @@ -0,0 +1,153 @@ +{ + "summary": "Get an installation", + "description": "You must use a [JWT](https://developer.github.com/enterprise/2.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "operationId": "apps-get-installation", + "tags": [ + "apps" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/apps/#get-an-installation" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.machine-man-preview+json" + }, + "required": true + }, + { + "name": "installation_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "installation_id parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "account": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + } + } + }, + "access_tokens_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "app_id": { + "type": "number" + }, + "target_id": { + "type": "number" + }, + "target_type": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "issues": { + "type": "string" + }, + "single_file": { + "type": "string" + } + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "single_file_name": { + "type": "string" + }, + "repository_selection": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://developer.github.com/app/installations/" + }, + { + "lang": "JS", + "source": "octokit.apps.get({\n installation_id: 'installation_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/apps/get-org-installation.json b/openapi/ghe-2.14/operations/apps/get-org-installation.json new file mode 100644 index 0000000000..37988d4ab8 --- /dev/null +++ b/openapi/ghe-2.14/operations/apps/get-org-installation.json @@ -0,0 +1,185 @@ +{ + "summary": "Get an organization installation", + "description": "Enables an authenticated GitHub App to find the organization's installation information.\n\nYou must use a [JWT](https://developer.github.com/enterprise/2.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "operationId": "apps-get-org-installation", + "tags": [ + "apps" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/apps/#get-an-organization-installation" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.machine-man-preview+json" + }, + "required": true + }, + { + "name": "org", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "org parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "account": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "repository_selection": { + "type": "string" + }, + "access_tokens_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "app_id": { + "type": "number" + }, + "target_id": { + "type": "number" + }, + "target_type": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + } + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "single_file_name": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://developer.github.com/orgs//installation" + }, + { + "lang": "JS", + "source": "octokit.apps.get({\n org: 'org'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "idName", + "date": "2019-04-10", + "note": "\"Find organization installation\" renamed to \"Get an organization installation\"", + "meta": { + "before": { + "idName": "find-org-installation" + }, + "after": { + "idName": "get-org-installation" + } + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/apps/get-repo-installation.json b/openapi/ghe-2.14/operations/apps/get-repo-installation.json new file mode 100644 index 0000000000..e8dc121656 --- /dev/null +++ b/openapi/ghe-2.14/operations/apps/get-repo-installation.json @@ -0,0 +1,194 @@ +{ + "summary": "Get a repository installation", + "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/enterprise/2.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "operationId": "apps-get-repo-installation", + "tags": [ + "apps" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/apps/#get-a-repository-installation" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.machine-man-preview+json" + }, + "required": true + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "account": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "repository_selection": { + "type": "string" + }, + "access_tokens_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "app_id": { + "type": "number" + }, + "target_id": { + "type": "number" + }, + "target_type": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + } + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "single_file_name": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://developer.github.com/repos/octocat/:repo/installation" + }, + { + "lang": "JS", + "source": "octokit.apps.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "idName", + "date": "2019-04-10", + "note": "\"Find repository installation\" renamed to \"Get a repository installation\"", + "meta": { + "before": { + "idName": "find-repo-installation" + }, + "after": { + "idName": "get-repo-installation" + } + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/apps/get-user-installation.json b/openapi/ghe-2.14/operations/apps/get-user-installation.json new file mode 100644 index 0000000000..b4ee8c2e83 --- /dev/null +++ b/openapi/ghe-2.14/operations/apps/get-user-installation.json @@ -0,0 +1,188 @@ +{ + "summary": "Get a user installation", + "description": "Enables an authenticated GitHub App to find the user’s installation information.\n\nYou must use a [JWT](https://developer.github.com/enterprise/2.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "operationId": "apps-get-user-installation", + "tags": [ + "apps" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/apps/#get-a-user-installation" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.machine-man-preview+json" + }, + "required": true + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "account": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "repository_selection": { + "type": "string" + }, + "access_tokens_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "app_id": { + "type": "number" + }, + "target_id": { + "type": "number" + }, + "target_type": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + } + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "single_file_name": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://developer.github.com/users//installation" + }, + { + "lang": "JS", + "source": "octokit.apps.get({\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "idName", + "date": "2019-04-10", + "note": "\"Find repository installation\" renamed to \"Get a repository installation\"", + "meta": { + "before": { + "idName": "find-user-installation" + }, + "after": { + "idName": "get-user-installation" + } + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/apps/list-installation-repos-for-authenticated-user.json b/openapi/ghe-2.14/operations/apps/list-installation-repos-for-authenticated-user.json new file mode 100644 index 0000000000..95c8423fe6 --- /dev/null +++ b/openapi/ghe-2.14/operations/apps/list-installation-repos-for-authenticated-user.json @@ -0,0 +1,391 @@ +{ + "summary": "List repositories accessible to the user for an installation", + "description": "List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access for an installation.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.\n\nYou must use a [user-to-server OAuth access token](https://developer.github.com/enterprise/2.14/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint.\n\nThe access the user has to each repository is included in the hash under the `permissions` key.", + "operationId": "apps-list-installation-repos-for-authenticated-user", + "tags": [ + "apps" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/apps/installations/#list-repositories-accessible-to-the-user-for-an-installation" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.machine-man-preview+json" + }, + "required": true + }, + { + "name": "installation_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "installation_id parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "total_count": { + "type": "number" + }, + "repositories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "number" + }, + "stargazers_count": { + "type": "number" + }, + "watchers_count": { + "type": "number" + }, + "size": { + "type": "number" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "number" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "number" + }, + "network_count": { + "type": "number" + }, + "anonymous_access_enabled": { + "type": "boolean" + } + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://developer.github.com/user/installations//repositories" + }, + { + "lang": "JS", + "source": "octokit.apps.get({\n installation_id: 'installation_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/apps/list-installations-for-authenticated-user.json b/openapi/ghe-2.14/operations/apps/list-installations-for-authenticated-user.json new file mode 100644 index 0000000000..63b6c08d47 --- /dev/null +++ b/openapi/ghe-2.14/operations/apps/list-installations-for-authenticated-user.json @@ -0,0 +1,218 @@ +{ + "summary": "List installations for a user", + "description": "Lists installations of your GitHub App that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.\n\nYou must use a [user-to-server OAuth access token](https://developer.github.com/enterprise/2.14/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#identifying-users-on-your-site), created for a user who has authorized your GitHub App, to access this endpoint.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.\n\nYou can find the permissions for the installation under the `permissions` key.", + "operationId": "apps-list-installations-for-authenticated-user", + "tags": [ + "apps" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/apps/installations/#list-installations-for-a-user" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.machine-man-preview+json" + }, + "required": true + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "total_count": { + "type": "number" + }, + "installations": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "account": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "access_tokens_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "app_id": { + "type": "number" + }, + "target_id": { + "type": "number" + }, + "target_type": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "issues": { + "type": "string" + }, + "single_file": { + "type": "string" + } + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "single_file_name": { + "type": "string" + } + }, + "required": [ + "id", + "account", + "access_tokens_url", + "repositories_url", + "html_url", + "app_id", + "target_id", + "target_type", + "permissions", + "events", + "single_file_name" + ] + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://developer.github.com/user/installations" + }, + { + "lang": "JS", + "source": "octokit.apps.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/apps/list-installations.json b/openapi/ghe-2.14/operations/apps/list-installations.json new file mode 100644 index 0000000000..741f785c4f --- /dev/null +++ b/openapi/ghe-2.14/operations/apps/list-installations.json @@ -0,0 +1,70 @@ +{ + "summary": "List installations", + "description": "You must use a [JWT](https://developer.github.com/enterprise/2.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.\n\nThe permissions the installation has are included under the `permissions` key.", + "operationId": "apps-list-installations", + "tags": [ + "apps" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/apps/#list-installations" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.machine-man-preview+json" + }, + "required": true + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://developer.github.com/app/installations" + }, + { + "lang": "JS", + "source": "octokit.apps.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/apps/list-repos.json b/openapi/ghe-2.14/operations/apps/list-repos.json new file mode 100644 index 0000000000..3ba2777c2c --- /dev/null +++ b/openapi/ghe-2.14/operations/apps/list-repos.json @@ -0,0 +1,368 @@ +{ + "summary": "List repositories", + "description": "List repositories that an installation can access.\n\nYou must use an [installation access token](https://developer.github.com/enterprise/2.14/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "operationId": "apps-list-repos", + "tags": [ + "apps" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/apps/installations/#list-repositories" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.machine-man-preview+json" + }, + "required": true + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "total_count": { + "type": "number" + }, + "repositories": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "number" + }, + "stargazers_count": { + "type": "number" + }, + "watchers_count": { + "type": "number" + }, + "size": { + "type": "number" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "number" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "number" + }, + "network_count": { + "type": "number" + }, + "anonymous_access_enabled": { + "type": "boolean" + } + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://developer.github.com/installation/repositories" + }, + { + "lang": "JS", + "source": "octokit.apps.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/apps/remove-repo-from-installation.json b/openapi/ghe-2.14/operations/apps/remove-repo-from-installation.json new file mode 100644 index 0000000000..0ef144e733 --- /dev/null +++ b/openapi/ghe-2.14/operations/apps/remove-repo-from-installation.json @@ -0,0 +1,63 @@ +{ + "summary": "Remove repository from installation", + "description": "Remove a single repository from an installation. The authenticated user must have admin access to the repository.\n\nYou must use a personal access token (which you can create via the [command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/) or the [OAuth Authorizations API](https://developer.github.com/enterprise/2.14/v3/oauth_authorizations/#create-a-new-authorization)) or [Basic Authentication](https://developer.github.com/enterprise/2.14/v3/auth/#basic-authentication) to access this endpoint.", + "operationId": "apps-remove-repo-from-installation", + "tags": [ + "apps" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/apps/installations/#remove-repository-from-installation" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.machine-man-preview+json" + }, + "required": true + }, + { + "name": "installation_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "installation_id parameter" + }, + { + "name": "repository_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "repository_id parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.machine-man-preview+json\" \\\n https://developer.github.com/user/installations//repositories/:repository_id" + }, + { + "lang": "JS", + "source": "octokit.apps.get({\n installation_id: 'installation_id',\n repository_id: 'repository_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/checks/create-suite.json b/openapi/ghe-2.14/operations/checks/create-suite.json new file mode 100644 index 0000000000..c942f02e46 --- /dev/null +++ b/openapi/ghe-2.14/operations/checks/create-suite.json @@ -0,0 +1,490 @@ +{ + "summary": "Create a check suite", + "description": "By default, check suites are automatically created when you create a [check run](https://developer.github.com/enterprise/2.14/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/enterprise/2.14/v3/checks/suites/#set-preferences-for-check-suites-on-a-repository)\". Your GitHub App must have the `checks:write` permission to create check suites.", + "operationId": "checks-create-suite", + "tags": [ + "checks" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/checks/suites/#create-a-check-suite" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.antiope-preview+json" + }, + "required": true + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "head_sha": { + "description": "The sha of the head commit.", + "type": "string" + } + }, + "required": [ + "head_sha" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "head_branch": { + "type": "string" + }, + "head_sha": { + "type": "string" + }, + "status": { + "type": "string" + }, + "conclusion": { + "type": "string" + }, + "url": { + "type": "string" + }, + "before": { + "type": "string" + }, + "after": { + "type": "string" + }, + "pull_requests": { + "type": "array", + "items": {} + }, + "app": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + } + } + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "external_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + }, + "repository": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "number" + }, + "stargazers_count": { + "type": "number" + }, + "watchers_count": { + "type": "number" + }, + "size": { + "type": "number" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "number" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "number" + }, + "network_count": { + "type": "number" + }, + "anonymous_access_enabled": { + "type": "boolean" + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.antiope-preview+json\" \\\n https://developer.github.com/repos/octocat/:repo/check-suites \\\n -d '{\"head_sha\":\"head_sha\"}'" + }, + { + "lang": "JS", + "source": "octokit.checks.get({\n owner: 'octocat',\n repo: 'hello-world',\n head_sha: 'head_sha'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/checks/create.json b/openapi/ghe-2.14/operations/checks/create.json new file mode 100644 index 0000000000..9692314b39 --- /dev/null +++ b/openapi/ghe-2.14/operations/checks/create.json @@ -0,0 +1,448 @@ +{ + "summary": "Create a check run", + "description": "Creates a new check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to create check runs.", + "operationId": "checks-create", + "tags": [ + "checks" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/checks/runs/#create-a-check-run" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.antiope-preview+json" + }, + "required": true + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "The name of the check. For example, \"code-coverage\".", + "type": "string" + }, + "head_sha": { + "description": "The SHA of the commit.", + "type": "string" + }, + "details_url": { + "description": "The URL of the integrator's site that has the full details of the check.", + "type": "string" + }, + "external_id": { + "description": "A reference for the run on the integrator's system.", + "type": "string" + }, + "status": { + "description": "The current status. Can be one of `queued`, `in_progress`, or `completed`.", + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed" + ], + "default": "queued" + }, + "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`.", + "type": "string" + }, + "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`.", + "type": "string", + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required" + ] + }, + "completed_at": { + "description": "**Required if you provide `conclusion`**. 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`.", + "type": "string" + }, + "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/enterprise/2.14/v3/checks/runs/#output-object) description.", + "type": "object", + "properties": { + "title": { + "description": "The title of the check run.", + "type": "string" + }, + "summary": { + "description": "The summary of the check run. This parameter supports Markdown.", + "type": "string" + }, + "text": { + "description": "The details of the check run. This parameter supports Markdown.", + "type": "string" + }, + "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/enterprise/2.14/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/enterprise/2.14/v3/checks/runs/#annotations-object) description for details about how to use this parameter.", + "type": "array", + "items": { + "type": "object", + "properties": { + "filename": { + "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", + "type": "string" + }, + "blob_href": { + "description": "The file's full blob URL. You can find the `blob_href` in the response of the [Get a single commit](https://developer.github.com/enterprise/2.14/v3/repos/commits/#get-a-single-commit) endpoint, by reading the `blob_url` from an element of the `files` array. You can also construct the blob URL from the `head_sha`, the repository, and the filename: \n`https://github.com/:owner/:repo/blob/:head_sha/:filename`.", + "type": "string" + }, + "start_line": { + "description": "The start line of the annotation.", + "type": "integer" + }, + "end_line": { + "description": "The end line of the annotation.", + "type": "integer" + }, + "warning_level": { + "description": "The warning level of the annotation. Can be one of `notice`, `warning`, or `failure`.", + "type": "string", + "enum": [ + "notice", + "warning", + "failure" + ] + }, + "message": { + "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", + "type": "string" + }, + "title": { + "description": "The title that represents the annotation. The maximum size is 255 characters.", + "type": "string" + }, + "raw_details": { + "description": "Details about this annotation. The maximum size is 64 KB.", + "type": "string" + } + }, + "required": [ + "filename", + "blob_href", + "start_line", + "end_line", + "warning_level", + "message" + ] + } + }, + "images": { + "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://developer.github.com/enterprise/2.14/v3/checks/runs/#images-object) description for details.", + "type": "array", + "items": { + "type": "object", + "properties": { + "alt": { + "description": "The alternative text for the image.", + "type": "string" + }, + "image_url": { + "description": "The full URL of the image.", + "type": "string" + }, + "caption": { + "description": "A short image description.", + "type": "string" + } + }, + "required": [ + "alt", + "image_url" + ] + } + } + }, + "required": [ + "title", + "summary" + ] + }, + "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/enterprise/2.14/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/enterprise/2.14/v3/checks/runs/#actions-object) description.", + "type": "array", + "items": { + "type": "object", + "properties": { + "label": { + "description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", + "type": "string" + }, + "description": { + "description": "A short explanation of what this action would do. The maximum size is 40 characters.", + "type": "string" + }, + "identifier": { + "description": "A reference for the action on the integrator's system. The maximum size is 20 characters.", + "type": "string" + } + }, + "required": [ + "label", + "description", + "identifier" + ] + } + } + }, + "required": [ + "name", + "head_sha" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "head_sha": { + "type": "string" + }, + "external_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "status": { + "type": "string" + }, + "conclusion": { + "type": "string" + }, + "started_at": { + "type": "string" + }, + "completed_at": { + "type": "string" + }, + "output": { + "type": "object", + "properties": { + "title": { + "type": "string" + }, + "summary": { + "type": "string" + }, + "text": { + "type": "string" + } + } + }, + "name": { + "type": "string" + }, + "check_suite": { + "type": "object", + "properties": { + "id": { + "type": "number" + } + } + }, + "app": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + } + } + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "external_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + }, + "pull_requests": { + "type": "array", + "items": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "number": { + "type": "number" + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + } + } + } + }, + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.antiope-preview+json\" \\\n https://developer.github.com/repos/octocat/:repo/check-runs \\\n -d '{\"name\":\"name\",\"head_sha\":\"head_sha\",\"output.title\":\"output.title\",\"output.summary\":\"output.summary\",\"output.annotations[].filename\":\"output.annotations[].filename\",\"output.annotations[].blob_href\":\"output.annotations[].blob_href\",\"output.annotations[].start_line\":\"output.annotations[].start_line\",\"output.annotations[].end_line\":\"output.annotations[].end_line\",\"output.annotations[].warning_level\":\"output.annotations[].warning_level\",\"output.annotations[].message\":\"output.annotations[].message\",\"output.images[].alt\":\"output.images[].alt\",\"output.images[].image_url\":\"output.images[].image_url\",\"actions[].label\":\"actions[].label\",\"actions[].description\":\"actions[].description\",\"actions[].identifier\":\"actions[].identifier\"}'" + }, + { + "lang": "JS", + "source": "octokit.checks.get({\n owner: 'octocat',\n repo: 'hello-world',\n name: 'name',\n head_sha: 'head_sha',\n 'output.title': 'output.title',\n 'output.summary': 'output.summary',\n 'output.annotations[].filename': 'output.annotations[].filename',\n 'output.annotations[].blob_href': 'output.annotations[].blob_href',\n 'output.annotations[].start_line': 'output.annotations[].start_line',\n 'output.annotations[].end_line': 'output.annotations[].end_line',\n 'output.annotations[].warning_level': 'output.annotations[].warning_level',\n 'output.annotations[].message': 'output.annotations[].message',\n 'output.images[].alt': 'output.images[].alt',\n 'output.images[].image_url': 'output.images[].image_url',\n 'actions[].label': 'actions[].label',\n 'actions[].description': 'actions[].description',\n 'actions[].identifier': 'actions[].identifier'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/checks/get-suite.json b/openapi/ghe-2.14/operations/checks/get-suite.json new file mode 100644 index 0000000000..2201891103 --- /dev/null +++ b/openapi/ghe-2.14/operations/checks/get-suite.json @@ -0,0 +1,481 @@ +{ + "summary": "Get a single check suite", + "description": "Gets 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.", + "operationId": "checks-get-suite", + "tags": [ + "checks" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/checks/suites/#get-a-single-check-suite" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.antiope-preview+json" + }, + "required": true + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "check_suite_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "check_suite_id parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "head_branch": { + "type": "string" + }, + "head_sha": { + "type": "string" + }, + "status": { + "type": "string" + }, + "conclusion": { + "type": "string" + }, + "url": { + "type": "string" + }, + "before": { + "type": "string" + }, + "after": { + "type": "string" + }, + "pull_requests": { + "type": "array", + "items": {} + }, + "app": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + } + } + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "external_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + }, + "repository": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "number" + }, + "stargazers_count": { + "type": "number" + }, + "watchers_count": { + "type": "number" + }, + "size": { + "type": "number" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "number" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "number" + }, + "network_count": { + "type": "number" + }, + "anonymous_access_enabled": { + "type": "boolean" + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.antiope-preview+json\" \\\n https://developer.github.com/repos/octocat/:repo/check-suites/:check_suite_id" + }, + { + "lang": "JS", + "source": "octokit.checks.get({\n owner: 'octocat',\n repo: 'hello-world',\n check_suite_id: 'check_suite_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/checks/get.json b/openapi/ghe-2.14/operations/checks/get.json new file mode 100644 index 0000000000..5720b43d14 --- /dev/null +++ b/openapi/ghe-2.14/operations/checks/get.json @@ -0,0 +1,275 @@ +{ + "summary": "Get a single check run", + "description": "Gets 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.", + "operationId": "checks-get", + "tags": [ + "checks" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/checks/runs/#get-a-single-check-run" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.antiope-preview+json" + }, + "required": true + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "check_run_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "check_run_id parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "head_sha": { + "type": "string" + }, + "external_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "status": { + "type": "string" + }, + "conclusion": { + "type": "string" + }, + "started_at": { + "type": "string" + }, + "completed_at": { + "type": "string" + }, + "output": { + "type": "object", + "properties": { + "title": { + "type": "string" + }, + "summary": { + "type": "string" + }, + "text": { + "type": "string" + }, + "annotations_count": { + "type": "number" + }, + "annotations_url": { + "type": "string" + } + } + }, + "name": { + "type": "string" + }, + "check_suite": { + "type": "object", + "properties": { + "id": { + "type": "number" + } + } + }, + "app": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + } + } + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "external_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + }, + "pull_requests": { + "type": "array", + "items": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "number": { + "type": "number" + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + } + } + } + }, + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.antiope-preview+json\" \\\n https://developer.github.com/repos/octocat/:repo/check-runs/:check_run_id" + }, + { + "lang": "JS", + "source": "octokit.checks.get({\n owner: 'octocat',\n repo: 'hello-world',\n check_run_id: 'check_run_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/checks/list-annotations.json b/openapi/ghe-2.14/operations/checks/list-annotations.json new file mode 100644 index 0000000000..9465f923df --- /dev/null +++ b/openapi/ghe-2.14/operations/checks/list-annotations.json @@ -0,0 +1,97 @@ +{ + "summary": "List annotations for a check run", + "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.", + "operationId": "checks-list-annotations", + "tags": [ + "checks" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/checks/runs/#list-annotations-for-a-check-run" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.antiope-preview+json" + }, + "required": true + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "check_run_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "check_run_id parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.antiope-preview+json\" \\\n https://developer.github.com/repos/octocat/:repo/check-runs/:check_run_id/annotations" + }, + { + "lang": "JS", + "source": "octokit.checks.get({\n owner: 'octocat',\n repo: 'hello-world',\n check_run_id: 'check_run_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/checks/list-for-ref.json b/openapi/ghe-2.14/operations/checks/list-for-ref.json new file mode 100644 index 0000000000..b5940de2f9 --- /dev/null +++ b/openapi/ghe-2.14/operations/checks/list-for-ref.json @@ -0,0 +1,349 @@ +{ + "summary": "List check runs for a specific ref", + "description": "Lists 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.", + "operationId": "checks-list-for-ref", + "tags": [ + "checks" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/checks/runs/#list-check-runs-for-a-specific-ref" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.antiope-preview+json" + }, + "required": true + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "ref", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "ref parameter" + }, + { + "name": "check_name", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "description": "Returns check runs with the specified `name`." + }, + { + "name": "status", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed" + ] + }, + "required": false, + "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`." + }, + { + "name": "filter", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "latest", + "all" + ], + "default": "latest" + }, + "required": false, + "description": "Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "total_count": { + "type": "number" + }, + "check_runs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "head_sha": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "external_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "details_url": { + "type": "string" + }, + "status": { + "type": "string" + }, + "conclusion": { + "type": "string" + }, + "started_at": { + "type": "string" + }, + "completed_at": { + "type": "string" + }, + "output": { + "type": "object", + "properties": { + "title": { + "type": "string" + }, + "summary": { + "type": "string" + }, + "text": { + "type": "string" + }, + "annotations_count": { + "type": "number" + }, + "annotations_url": { + "type": "string" + } + } + }, + "name": { + "type": "string" + }, + "check_suite": { + "type": "object", + "properties": { + "id": { + "type": "number" + } + } + }, + "app": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + } + } + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "external_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + }, + "pull_requests": { + "type": "array", + "items": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "number": { + "type": "number" + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + } + } + } + }, + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.antiope-preview+json\" \\\n https://developer.github.com/repos/octocat/:repo/commits/:ref/check-runs" + }, + { + "lang": "JS", + "source": "octokit.checks.get({\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/checks/list-for-suite.json b/openapi/ghe-2.14/operations/checks/list-for-suite.json new file mode 100644 index 0000000000..3a201094f7 --- /dev/null +++ b/openapi/ghe-2.14/operations/checks/list-for-suite.json @@ -0,0 +1,349 @@ +{ + "summary": "List check runs in a check suite", + "description": "Lists 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.", + "operationId": "checks-list-for-suite", + "tags": [ + "checks" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/checks/runs/#list-check-runs-in-a-check-suite" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.antiope-preview+json" + }, + "required": true + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "check_suite_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "check_suite_id parameter" + }, + { + "name": "check_name", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "description": "Returns check runs with the specified `name`." + }, + { + "name": "status", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed" + ] + }, + "required": false, + "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`." + }, + { + "name": "filter", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "latest", + "all" + ], + "default": "latest" + }, + "required": false, + "description": "Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "total_count": { + "type": "number" + }, + "check_runs": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "head_sha": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "external_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "details_url": { + "type": "string" + }, + "status": { + "type": "string" + }, + "conclusion": { + "type": "string" + }, + "started_at": { + "type": "string" + }, + "completed_at": { + "type": "string" + }, + "output": { + "type": "object", + "properties": { + "title": { + "type": "string" + }, + "summary": { + "type": "string" + }, + "text": { + "type": "string" + }, + "annotations_count": { + "type": "number" + }, + "annotations_url": { + "type": "string" + } + } + }, + "name": { + "type": "string" + }, + "check_suite": { + "type": "object", + "properties": { + "id": { + "type": "number" + } + } + }, + "app": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + } + } + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "external_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + }, + "pull_requests": { + "type": "array", + "items": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "number": { + "type": "number" + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + } + } + } + }, + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.antiope-preview+json\" \\\n https://developer.github.com/repos/octocat/:repo/check-suites/:check_suite_id/check-runs" + }, + { + "lang": "JS", + "source": "octokit.checks.get({\n owner: 'octocat',\n repo: 'hello-world',\n check_suite_id: 'check_suite_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/checks/list-suites-for-ref.json b/openapi/ghe-2.14/operations/checks/list-suites-for-ref.json new file mode 100644 index 0000000000..4382380083 --- /dev/null +++ b/openapi/ghe-2.14/operations/checks/list-suites-for-ref.json @@ -0,0 +1,530 @@ +{ + "summary": "List check suites for a specific ref", + "description": "Lists 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.", + "operationId": "checks-list-suites-for-ref", + "tags": [ + "checks" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/checks/suites/#list-check-suites-for-a-specific-ref" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.antiope-preview+json" + }, + "required": true + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "ref", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "ref parameter" + }, + { + "name": "app_id", + "in": "query", + "schema": { + "type": "integer" + }, + "required": false, + "description": "Filters check suites by GitHub App `id`." + }, + { + "name": "check_name", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "description": "Filters checks suites by the name of the [check run](https://developer.github.com/enterprise/2.14/v3/checks/runs/)." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "total_count": { + "type": "number" + }, + "check_suites": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "head_branch": { + "type": "string" + }, + "head_sha": { + "type": "string" + }, + "status": { + "type": "string" + }, + "conclusion": { + "type": "string" + }, + "url": { + "type": "string" + }, + "before": { + "type": "string" + }, + "after": { + "type": "string" + }, + "pull_requests": { + "type": "array", + "items": {} + }, + "app": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + } + } + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "external_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + }, + "repository": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "number" + }, + "stargazers_count": { + "type": "number" + }, + "watchers_count": { + "type": "number" + }, + "size": { + "type": "number" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "number" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "number" + }, + "network_count": { + "type": "number" + }, + "anonymous_access_enabled": { + "type": "boolean" + } + } + } + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.antiope-preview+json\" \\\n https://developer.github.com/repos/octocat/:repo/commits/:ref/check-suites" + }, + { + "lang": "JS", + "source": "octokit.checks.get({\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/checks/request-suites.json b/openapi/ghe-2.14/operations/checks/request-suites.json new file mode 100644 index 0000000000..ee6bfb5e45 --- /dev/null +++ b/openapi/ghe-2.14/operations/checks/request-suites.json @@ -0,0 +1,86 @@ +{ + "summary": "Request check suites", + "description": "Triggers GitHub to create a new check suite, without pushing new code to a repository. To request a check suite, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.", + "operationId": "checks-request-suites", + "tags": [ + "checks" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/checks/suites/#request-check-suites" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.antiope-preview+json" + }, + "required": true + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "head_sha": { + "description": "The sha of the head commit.", + "type": "string" + } + }, + "required": [ + "head_sha" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.antiope-preview+json\" \\\n https://developer.github.com/repos/octocat/:repo/check-suite-requests \\\n -d '{\"head_sha\":\"head_sha\"}'" + }, + { + "lang": "JS", + "source": "octokit.checks.get({\n owner: 'octocat',\n repo: 'hello-world',\n head_sha: 'head_sha'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/checks/set-suites-preferences.json b/openapi/ghe-2.14/operations/checks/set-suites-preferences.json new file mode 100644 index 0000000000..5aad9bc204 --- /dev/null +++ b/openapi/ghe-2.14/operations/checks/set-suites-preferences.json @@ -0,0 +1,430 @@ +{ + "summary": "Set preferences for check suites on a repository", + "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/enterprise/2.14/v3/checks/suites/#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites.", + "operationId": "checks-set-suites-preferences", + "tags": [ + "checks" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/checks/suites/#set-preferences-for-check-suites-on-a-repository" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.antiope-preview+json" + }, + "required": true + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "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/enterprise/2.14/v3/checks/suites/#auto_trigger_checks-object) description for details.", + "type": "array", + "items": { + "type": "object", + "properties": { + "app_id": { + "description": "The `id` of the GitHub App.", + "type": "integer" + }, + "setting": { + "description": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", + "type": "boolean", + "default": true + } + }, + "required": [ + "app_id", + "setting" + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "preferences": { + "type": "object", + "properties": { + "auto_trigger_checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "app_id": { + "type": "number" + }, + "setting": { + "type": "boolean" + } + }, + "required": [ + "app_id", + "setting" + ] + } + } + } + }, + "repository": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "number" + }, + "stargazers_count": { + "type": "number" + }, + "watchers_count": { + "type": "number" + }, + "size": { + "type": "number" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "number" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "number" + }, + "network_count": { + "type": "number" + }, + "anonymous_access_enabled": { + "type": "boolean" + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPATCH \\\n -H\"Accept: application/vnd.github.antiope-preview+json\" \\\n https://developer.github.com/repos/octocat/:repo/check-suites/preferences \\\n -d '{\"auto_trigger_checks[].app_id\":\"auto_trigger_checks[].app_id\",\"auto_trigger_checks[].setting\":\"auto_trigger_checks[].setting\"}'" + }, + { + "lang": "JS", + "source": "octokit.checks.get({\n owner: 'octocat',\n repo: 'hello-world',\n 'auto_trigger_checks[].app_id': 'auto_trigger_checks[].app_id',\n 'auto_trigger_checks[].setting': 'auto_trigger_checks[].setting'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/checks/update.json b/openapi/ghe-2.14/operations/checks/update.json new file mode 100644 index 0000000000..b4510667e5 --- /dev/null +++ b/openapi/ghe-2.14/operations/checks/update.json @@ -0,0 +1,453 @@ +{ + "summary": "Update a check run", + "description": "Updates a check run for a specific commit in a repository. Your GitHub App must have the `checks:write` permission to edit check runs.", + "operationId": "checks-update", + "tags": [ + "checks" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/checks/runs/#update-a-check-run" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.antiope-preview+json" + }, + "required": true + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "check_run_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "check_run_id parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "The name of the check. For example, \"code-coverage\".", + "type": "string" + }, + "details_url": { + "description": "The URL of the integrator's site that has the full details of the check.", + "type": "string" + }, + "external_id": { + "description": "A reference for the run on the integrator's system.", + "type": "string" + }, + "started_at": { + "description": "This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "type": "string" + }, + "status": { + "description": "The current status. Can be one of `queued`, `in_progress`, or `completed`.", + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed" + ] + }, + "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`.", + "type": "string", + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "timed_out", + "action_required" + ] + }, + "completed_at": { + "description": "**Required if you provide `conclusion`**. 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`.", + "type": "string" + }, + "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/enterprise/2.14/v3/checks/runs/#output-object-1) description.", + "type": "object", + "properties": { + "title": { + "description": "**Required**.", + "type": "string" + }, + "summary": { + "description": "Can contain Markdown.", + "type": "string" + }, + "text": { + "description": "Can contain Markdown.", + "type": "string" + }, + "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/enterprise/2.14/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/enterprise/2.14/v3/checks/runs/#annotations-object-1) description for details.", + "type": "array", + "items": { + "type": "object", + "properties": { + "filename": { + "description": "The path of the file to add an annotation to. For example, `assets/css/main.css`.", + "type": "string" + }, + "blob_href": { + "description": "The file's full blob URL. You can find the `blob_href` in the response of the [Get a single commit](https://developer.github.com/enterprise/2.14/v3/repos/commits/#get-a-single-commit) endpoint, by reading the `blob_url` from an element of the `files` array. You can also construct the blob URL from the `head_sha`, the repository, and the filename: \n`https://github.com/:owner/:repo/blob/:head_sha/:filename`.", + "type": "string" + }, + "start_line": { + "description": "The start line of the annotation.", + "type": "integer" + }, + "end_line": { + "description": "The end line of the annotation.", + "type": "integer" + }, + "warning_level": { + "description": "The warning level of the annotation. Can be one of `notice`, `warning`, or `failure`.", + "type": "string", + "enum": [ + "notice", + "warning", + "failure" + ] + }, + "message": { + "description": "A short description of the feedback for these lines of code. The maximum size is 64 KB.", + "type": "string" + }, + "title": { + "description": "The title that represents the annotation. The maximum size is 255 characters.", + "type": "string" + }, + "raw_details": { + "description": "Details about this annotation. The maximum size is 64 KB.", + "type": "string" + } + }, + "required": [ + "filename", + "blob_href", + "start_line", + "end_line", + "warning_level", + "message" + ] + } + }, + "images": { + "description": "Adds images to the output displayed in the GitHub pull request UI. See the [`images` object](https://developer.github.com/enterprise/2.14/v3/checks/runs/#annotations-object-1) description for details.", + "type": "array", + "items": { + "type": "object", + "properties": { + "alt": { + "description": "The alternative text for the image.", + "type": "string" + }, + "image_url": { + "description": "The full URL of the image.", + "type": "string" + }, + "caption": { + "description": "A short image description.", + "type": "string" + } + }, + "required": [ + "alt", + "image_url" + ] + } + } + }, + "required": [ + "summary" + ] + }, + "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/enterprise/2.14/v3/checks/runs/#actions-object) description.", + "type": "array", + "items": { + "type": "object", + "properties": { + "label": { + "description": "The text to be displayed on a button in the web UI. The maximum size is 20 characters.", + "type": "string" + }, + "description": { + "description": "A short explanation of what this action would do. The maximum size is 40 characters.", + "type": "string" + }, + "identifier": { + "description": "A reference for the action on the integrator's system. The maximum size is 20 characters.", + "type": "string" + } + }, + "required": [ + "label", + "description", + "identifier" + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "head_sha": { + "type": "string" + }, + "external_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "status": { + "type": "string" + }, + "conclusion": { + "type": "string" + }, + "started_at": { + "type": "string" + }, + "completed_at": { + "type": "string" + }, + "output": { + "type": "object", + "properties": { + "title": { + "type": "string" + }, + "summary": { + "type": "string" + }, + "text": { + "type": "string" + }, + "annotations_count": { + "type": "number" + }, + "annotations_url": { + "type": "string" + } + } + }, + "name": { + "type": "string" + }, + "check_suite": { + "type": "object", + "properties": { + "id": { + "type": "number" + } + } + }, + "app": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + } + } + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "external_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + }, + "pull_requests": { + "type": "array", + "items": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "number": { + "type": "number" + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + } + } + } + }, + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPATCH \\\n -H\"Accept: application/vnd.github.antiope-preview+json\" \\\n https://developer.github.com/repos/octocat/:repo/check-runs/:check_run_id \\\n -d '{\"output.summary\":\"output.summary\",\"output.annotations[].filename\":\"output.annotations[].filename\",\"output.annotations[].blob_href\":\"output.annotations[].blob_href\",\"output.annotations[].start_line\":\"output.annotations[].start_line\",\"output.annotations[].end_line\":\"output.annotations[].end_line\",\"output.annotations[].warning_level\":\"output.annotations[].warning_level\",\"output.annotations[].message\":\"output.annotations[].message\",\"output.images[].alt\":\"output.images[].alt\",\"output.images[].image_url\":\"output.images[].image_url\",\"actions[].label\":\"actions[].label\",\"actions[].description\":\"actions[].description\",\"actions[].identifier\":\"actions[].identifier\"}'" + }, + { + "lang": "JS", + "source": "octokit.checks.get({\n owner: 'octocat',\n repo: 'hello-world',\n check_run_id: 'check_run_id',\n 'output.summary': 'output.summary',\n 'output.annotations[].filename': 'output.annotations[].filename',\n 'output.annotations[].blob_href': 'output.annotations[].blob_href',\n 'output.annotations[].start_line': 'output.annotations[].start_line',\n 'output.annotations[].end_line': 'output.annotations[].end_line',\n 'output.annotations[].warning_level': 'output.annotations[].warning_level',\n 'output.annotations[].message': 'output.annotations[].message',\n 'output.images[].alt': 'output.images[].alt',\n 'output.images[].image_url': 'output.images[].image_url',\n 'actions[].label': 'actions[].label',\n 'actions[].description': 'actions[].description',\n 'actions[].identifier': 'actions[].identifier'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/codes_of_conduct/get-conduct-code.json b/openapi/ghe-2.14/operations/codes_of_conduct/get-conduct-code.json new file mode 100644 index 0000000000..bf47e8167a --- /dev/null +++ b/openapi/ghe-2.14/operations/codes_of_conduct/get-conduct-code.json @@ -0,0 +1,74 @@ +{ + "summary": "Get an individual code of conduct", + "description": "", + "operationId": "codes_of_conduct-get-conduct-code", + "tags": [ + "codes_of_conduct" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/codes_of_conduct/#get-an-individual-code-of-conduct" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.scarlet-witch-preview+json" + }, + "required": true + }, + { + "name": "key", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "key parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string" + }, + "body": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n https://developer.github.com/codes_of_conduct/" + }, + { + "lang": "JS", + "source": "octokit.codes_of_conduct.get({\n key: 'key'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/codes_of_conduct/get-for-repo.json b/openapi/ghe-2.14/operations/codes_of_conduct/get-for-repo.json new file mode 100644 index 0000000000..a78e3ef30e --- /dev/null +++ b/openapi/ghe-2.14/operations/codes_of_conduct/get-for-repo.json @@ -0,0 +1,83 @@ +{ + "summary": "Get the contents of a repository's code of conduct", + "description": "This method returns the contents of the repository's code of conduct file, if one is detected.", + "operationId": "codes_of_conduct-get-for-repo", + "tags": [ + "codes_of_conduct" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/codes_of_conduct/#get-the-contents-of-a-repositorys-code-of-conduct" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.scarlet-witch-preview+json" + }, + "required": true + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string" + }, + "body": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n https://developer.github.com/repos/octocat/:repo/community/code_of_conduct" + }, + { + "lang": "JS", + "source": "octokit.codes_of_conduct.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/codes_of_conduct/list-conduct-codes.json b/openapi/ghe-2.14/operations/codes_of_conduct/list-conduct-codes.json new file mode 100644 index 0000000000..d2481f5e94 --- /dev/null +++ b/openapi/ghe-2.14/operations/codes_of_conduct/list-conduct-codes.json @@ -0,0 +1,50 @@ +{ + "summary": "List all codes of conduct", + "description": "", + "operationId": "codes_of_conduct-list-conduct-codes", + "tags": [ + "codes_of_conduct" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/codes_of_conduct/#list-all-codes-of-conduct" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.scarlet-witch-preview+json" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.scarlet-witch-preview+json\" \\\n https://developer.github.com/codes_of_conduct" + }, + { + "lang": "JS", + "source": "octokit.codes_of_conduct.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/emojis/get.json b/openapi/ghe-2.14/operations/emojis/get.json new file mode 100644 index 0000000000..f5ce30773f --- /dev/null +++ b/openapi/ghe-2.14/operations/emojis/get.json @@ -0,0 +1,49 @@ +{ + "summary": "Get", + "description": "Lists all the emojis available to use on GitHub Enterprise.\n\n", + "operationId": "emojis-get", + "tags": [ + "emojis" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/emojis/#emojis" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/emojis" + }, + { + "lang": "JS", + "source": "octokit.emojis.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/add-authorized-ssh-key.json b/openapi/ghe-2.14/operations/enterprise-admin/add-authorized-ssh-key.json new file mode 100644 index 0000000000..cac128f5c1 --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/add-authorized-ssh-key.json @@ -0,0 +1,67 @@ +{ + "summary": "Add a new authorized SSH key", + "description": "", + "operationId": "enterprise-admin-add-authorized-ssh-key", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/management_console/#add-a-new-authorized-ssh-key" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "authorized_key": { + "description": "The path to the public SSH key.", + "type": "string" + } + }, + "required": [ + "authorized_key" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/setup/api/settings/authorized-keys \\\n -d '{\"authorized_key\":\"authorized_key\"}'" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n authorized_key: 'authorized_key'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/check-configuration-status.json b/openapi/ghe-2.14/operations/enterprise-admin/check-configuration-status.json new file mode 100644 index 0000000000..c4f305e09c --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/check-configuration-status.json @@ -0,0 +1,73 @@ +{ + "summary": "Check configuration status", + "description": "This endpoint allows you to check the status of the most recent configuration process:\n\nNote that you may need to wait several seconds after you start a process before you can check its status.\n\nThe different statuses are:\n\n| Status | Description |\n| ------------- | --------------------------------- |\n| `PENDING` | The job has not started yet |\n| `CONFIGURING` | The job is running |\n| `DONE` | The job has finished correctly |\n| `FAILED` | The job has finished unexpectedly |", + "operationId": "enterprise-admin-check-configuration-status", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/management_console/#check-configuration-status" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "status": { + "type": "string" + }, + "progress": { + "type": "array", + "items": { + "type": "object", + "properties": { + "status": { + "type": "string" + }, + "key": { + "type": "string" + } + }, + "required": [ + "status", + "key" + ] + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/setup/api/configcheck" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/check-maintenance-status.json b/openapi/ghe-2.14/operations/enterprise-admin/check-maintenance-status.json new file mode 100644 index 0000000000..295940e055 --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/check-maintenance-status.json @@ -0,0 +1,76 @@ +{ + "summary": "Check maintenance status", + "description": "Check your installation's maintenance status:", + "operationId": "enterprise-admin-check-maintenance-status", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/management_console/#check-maintenance-status" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "status": { + "type": "string" + }, + "scheduled_time": { + "type": "string" + }, + "connection_services": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "number": { + "type": "number" + } + }, + "required": [ + "name", + "number" + ] + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/setup/api/maintenance" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/create-global-hook.json b/openapi/ghe-2.14/operations/enterprise-admin/create-global-hook.json new file mode 100644 index 0000000000..dcdf8ac9cd --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/create-global-hook.json @@ -0,0 +1,156 @@ +{ + "summary": "Create a global hook", + "description": "", + "operationId": "enterprise-admin-create-global-hook", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/global_webhooks/#create-a-global-hook" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.superpro-preview+json" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Must be passed as \"web\".", + "type": "string" + }, + "config": { + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.14/v3/enterprise-admin/global_webhooks/#create-hook-config-params).", + "type": "object", + "properties": { + "url": { + "description": "The URL to which the payloads will be delivered.", + "type": "string" + }, + "content_type": { + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "type": "string" + }, + "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/enterprise/2.14/webhooks/#delivery-headers) header.", + "type": "string" + }, + "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.**", + "type": "string" + } + }, + "required": [ + "url" + ] + }, + "events": { + "description": "The [events](https://developer.github.com/enterprise/2.14/v3/activity/events/types/) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", + "type": "array", + "items": { + "type": "string" + } + }, + "active": { + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "type": "boolean", + "default": true + } + }, + "required": [ + "name", + "config" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "type": { + "type": "string" + }, + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "config": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "content_type": { + "type": "string" + }, + "insecure_ssl": { + "type": "string" + }, + "secret": { + "type": "string" + } + } + }, + "updated_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "ping_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.superpro-preview+json\" \\\n https://developer.github.com/admin/hooks \\\n -d '{\"name\":\"name\",\"config\":\"config\",\"config.url\":\"config.url\"}'" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n name: 'name',\n config: 'config',\n 'config.url': 'config.url'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/create-impersonation-o-auth-token.json b/openapi/ghe-2.14/operations/enterprise-admin/create-impersonation-o-auth-token.json new file mode 100644 index 0000000000..0795b54f4f --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/create-impersonation-o-auth-token.json @@ -0,0 +1,129 @@ +{ + "summary": "Create an impersonation OAuth token", + "description": "", + "operationId": "enterprise-admin-create-impersonation-o-auth-token", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/users/#create-an-impersonation-oauth-token" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "scopes": { + "description": "A list of [scopes](https://developer.github.com/enterprise/2.14/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "url": { + "type": "string" + }, + "scopes": { + "type": "array", + "items": { + "type": "string" + } + }, + "token": { + "type": "string" + }, + "token_last_eight": { + "type": "string" + }, + "hashed_token": { + "type": "string" + }, + "app": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "client_id": { + "type": "string" + } + } + }, + "note": { + "type": "string" + }, + "note_url": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "fingerprint": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/admin/users//authorizations" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/create-org.json b/openapi/ghe-2.14/operations/enterprise-admin/create-org.json new file mode 100644 index 0000000000..7340b48e81 --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/create-org.json @@ -0,0 +1,115 @@ +{ + "summary": "Create an organization", + "description": "", + "operationId": "enterprise-admin-create-org", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/orgs/#create-an-organization" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "login": { + "description": "The organization's username.", + "type": "string" + }, + "admin": { + "description": "The login of the user who will manage this organization.", + "type": "string" + }, + "profile_name": { + "description": "The organization's display name.", + "type": "string" + } + }, + "required": [ + "login", + "admin" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/admin/organizations \\\n -d '{\"login\":\"login\",\"admin\":\"admin\"}'" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n login: 'login',\n admin: 'admin'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/create-pre-receive-environment.json b/openapi/ghe-2.14/operations/enterprise-admin/create-pre-receive-environment.json new file mode 100644 index 0000000000..b6a96b5f51 --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/create-pre-receive-environment.json @@ -0,0 +1,116 @@ +{ + "summary": "Create a pre-receive environment", + "description": "", + "operationId": "enterprise-admin-create-pre-receive-environment", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/pre_receive_environments/#create-a-pre-receive-environment" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "The new pre-receive environment's name.", + "type": "string" + }, + "image_url": { + "description": "URL from which to download a tarball of this environment.", + "type": "string" + } + }, + "required": [ + "name", + "image_url" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "image_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "default_environment": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "hooks_count": { + "type": "number" + }, + "download": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "state": { + "type": "string" + }, + "downloaded_at": { + "type": "string" + }, + "message": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/admin/pre-receive-environments \\\n -d '{\"name\":\"name\",\"image_url\":\"image_url\"}'" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n name: 'name',\n image_url: 'image_url'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/create-pre-receive-hook.json b/openapi/ghe-2.14/operations/enterprise-admin/create-pre-receive-hook.json new file mode 100644 index 0000000000..ba49adc305 --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/create-pre-receive-hook.json @@ -0,0 +1,173 @@ +{ + "summary": "Create a pre-receive hook", + "description": "", + "operationId": "enterprise-admin-create-pre-receive-hook", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/pre_receive_hooks/#create-a-pre-receive-hook" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "The name of the hook.", + "type": "string" + }, + "script": { + "description": "The script that the hook runs.", + "type": "string" + }, + "script_repository": { + "description": "The GitHub repository where the script is kept.", + "type": "object", + "properties": {} + }, + "environment": { + "description": "The pre-receive environment where the script is executed.", + "type": "object", + "properties": {} + }, + "enforcement": { + "description": "The state of enforcement for this hook. default: `disabled`", + "type": "string" + }, + "allow_downstream_configuration": { + "description": "Whether enforcement can be overridden at the org or repo level. default: `false`", + "type": "boolean" + } + }, + "required": [ + "name", + "script", + "script_repository", + "environment" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "enforcement": { + "type": "string" + }, + "script": { + "type": "string" + }, + "script_repository": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "full_name": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + } + } + }, + "environment": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "image_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "default_environment": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "hooks_count": { + "type": "number" + }, + "download": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "state": { + "type": "string" + }, + "downloaded_at": { + "type": "string" + }, + "message": { + "type": "string" + } + } + } + } + }, + "allow_downstream_configuration": { + "type": "boolean" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/admin/pre-receive-hooks \\\n -d '{\"name\":\"name\",\"script\":\"script\",\"script_repository\":\"script_repository\",\"environment\":\"environment\"}'" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n name: 'name',\n script: 'script',\n script_repository: 'script_repository',\n environment: 'environment'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/create-user.json b/openapi/ghe-2.14/operations/enterprise-admin/create-user.json new file mode 100644 index 0000000000..275127813a --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/create-user.json @@ -0,0 +1,128 @@ +{ + "summary": "Create a new user", + "description": "If an external authentication mechanism is used, the login name should match the login name in the external system. If you are using LDAP authentication, you should also [update the LDAP mapping](https://developer.github.com/enterprise/2.14/v3/enterprise-admin/ldap/#update-ldap-mapping-for-a-user) for the user.\n\nThe login name will be normalized to only contain alphanumeric characters or single hyphens. For example, if you send `\"octo_cat\"` as the login, a user named `\"octo-cat\"` will be created.\n\nIf the login name or email address is already associated with an account, the server will return a `422` response.", + "operationId": "enterprise-admin-create-user", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/users/#create-a-new-user" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "login": { + "description": "The user's username.", + "type": "string" + }, + "email": { + "description": "**Required for built-in authentication.** The user's email address. This parameter can be omitted when using CAS, LDAP, or SAML. For details on built-in and centrally-managed authentication, see the the [GitHub Enterprise authentication guide](https://help.github.com/enterprise/2.14/admin/guides/user-management/authenticating-users-for-your-github-enterprise-server-instance/).", + "type": "string" + } + }, + "required": [ + "login" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/admin/users \\\n -d '{\"login\":\"login\"}'" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n login: 'login'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/delete-global-hook.json b/openapi/ghe-2.14/operations/enterprise-admin/delete-global-hook.json new file mode 100644 index 0000000000..d6792df1b4 --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/delete-global-hook.json @@ -0,0 +1,54 @@ +{ + "summary": "Delete a global hook", + "description": "", + "operationId": "enterprise-admin-delete-global-hook", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/global_webhooks/#delete-a-global-hook" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.superpro-preview+json" + }, + "required": true + }, + { + "name": "hook_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "hook_id parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.superpro-preview+json\" \\\n https://developer.github.com/admin/hooks/" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n hook_id: 'hook_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/delete-impersonation-o-auth-token.json b/openapi/ghe-2.14/operations/enterprise-admin/delete-impersonation-o-auth-token.json new file mode 100644 index 0000000000..452f7c5959 --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/delete-impersonation-o-auth-token.json @@ -0,0 +1,53 @@ +{ + "summary": "Delete an impersonation OAuth token", + "description": "", + "operationId": "enterprise-admin-delete-impersonation-o-auth-token", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/users/#delete-an-impersonation-oauth-token" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/admin/users//authorizations" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/delete-pre-receive-environment.json b/openapi/ghe-2.14/operations/enterprise-admin/delete-pre-receive-environment.json new file mode 100644 index 0000000000..6174d120d3 --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/delete-pre-receive-environment.json @@ -0,0 +1,53 @@ +{ + "summary": "Delete a pre-receive environment", + "description": "If you attempt to delete an environment that cannot be deleted, you will get a response like this:\n\nThe possible error messages are:\n\n* _Cannot modify or delete the default environment_\n* _Cannot delete environment that has hooks_\n* _Cannot delete environment when download is in progress_", + "operationId": "enterprise-admin-delete-pre-receive-environment", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/pre_receive_environments/#delete-a-pre-receive-environment" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "pre_receive_environment_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "pre_receive_environment_id parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/admin/pre-receive-environments/" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n pre_receive_environment_id: 'pre_receive_environment_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/delete-pre-receive-hook.json b/openapi/ghe-2.14/operations/enterprise-admin/delete-pre-receive-hook.json new file mode 100644 index 0000000000..9090bbf45f --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/delete-pre-receive-hook.json @@ -0,0 +1,53 @@ +{ + "summary": "Delete a pre-receive hook", + "description": "", + "operationId": "enterprise-admin-delete-pre-receive-hook", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/pre_receive_hooks/#delete-a-pre-receive-hook" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "pre_receive_hook_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "pre_receive_hook_id parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/admin/pre_receive_hooks/" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n pre_receive_hook_id: 'pre_receive_hook_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/delete-public-key.json b/openapi/ghe-2.14/operations/enterprise-admin/delete-public-key.json new file mode 100644 index 0000000000..aa3e4fadbd --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/delete-public-key.json @@ -0,0 +1,53 @@ +{ + "summary": "Delete a public key", + "description": "", + "operationId": "enterprise-admin-delete-public-key", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/users/#delete-a-public-key" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "key_ids", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "key_ids parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/admin/keys/" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n key_ids: 'key_ids'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/delete-user.json b/openapi/ghe-2.14/operations/enterprise-admin/delete-user.json new file mode 100644 index 0000000000..73d2fbb754 --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/delete-user.json @@ -0,0 +1,53 @@ +{ + "summary": "Delete a user", + "description": "Deleting a user will delete all their repositories, gists, applications, and personal settings. [Suspending a user](https://developer.github.com/enterprise/2.14/v3/enterprise-admin/users/#suspend-a-user) is often a better option.\n\nYou can delete any user account except your own.", + "operationId": "enterprise-admin-delete-user", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/users/#delete-a-user" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/admin/users/" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/demote-site-administrator-to-ordinary-user.json b/openapi/ghe-2.14/operations/enterprise-admin/demote-site-administrator-to-ordinary-user.json new file mode 100644 index 0000000000..0f2fe5321e --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/demote-site-administrator-to-ordinary-user.json @@ -0,0 +1,53 @@ +{ + "summary": "Demote a site administrator to an ordinary user", + "description": "You can demote any user account except your own.", + "operationId": "enterprise-admin-demote-site-administrator-to-ordinary-user", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/users/#demote-a-site-administrator-to-an-ordinary-user" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/users//site_admin" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/enable-or-disable-maintenance-mode.json b/openapi/ghe-2.14/operations/enterprise-admin/enable-or-disable-maintenance-mode.json new file mode 100644 index 0000000000..a84d1747e3 --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/enable-or-disable-maintenance-mode.json @@ -0,0 +1,94 @@ +{ + "summary": "Enable or disable maintenance mode", + "description": "The possible values for `enabled` are `true` and `false`. When it's `false`, the attribute `when` is ignored and the maintenance mode is turned off. `when` defines the time period when the maintenance was enabled.\n\nThe possible values for `when` are `now` or any date parseable by [mojombo/chronic](https://github.com/mojombo/chronic).", + "operationId": "enterprise-admin-enable-or-disable-maintenance-mode", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/management_console/#enable-or-disable-maintenance-mode" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "maintenance": { + "description": "A JSON string with the attributes `enabled` and `when`.", + "type": "string" + } + }, + "required": [ + "maintenance" + ] + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "status": { + "type": "string" + }, + "scheduled_time": { + "type": "string" + }, + "connection_services": { + "type": "array", + "items": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "number": { + "type": "number" + } + }, + "required": [ + "name", + "number" + ] + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/setup/api/maintenance \\\n -d '{\"maintenance\":\"maintenance\"}'" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n maintenance: 'maintenance'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/get-global-hook.json b/openapi/ghe-2.14/operations/enterprise-admin/get-global-hook.json new file mode 100644 index 0000000000..3d264d6146 --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/get-global-hook.json @@ -0,0 +1,109 @@ +{ + "summary": "Get single global hook", + "description": "", + "operationId": "enterprise-admin-get-global-hook", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/global_webhooks/#get-single-global-hook" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.superpro-preview+json" + }, + "required": true + }, + { + "name": "hook_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "hook_id parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "type": { + "type": "string" + }, + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "config": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "content_type": { + "type": "string" + }, + "insecure_ssl": { + "type": "string" + }, + "secret": { + "type": "string" + } + } + }, + "updated_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "ping_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.superpro-preview+json\" \\\n https://developer.github.com/admin/hooks/" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n hook_id: 'hook_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/get-license-information.json b/openapi/ghe-2.14/operations/enterprise-admin/get-license-information.json new file mode 100644 index 0000000000..c5bab64e9d --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/get-license-information.json @@ -0,0 +1,70 @@ +{ + "summary": "Get license information", + "description": "", + "operationId": "enterprise-admin-get-license-information", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/license/#get-license-information" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "seats": { + "type": "number" + }, + "seats_used": { + "type": "number" + }, + "seats_available": { + "type": "number" + }, + "kind": { + "type": "string" + }, + "days_until_expiration": { + "type": "number" + }, + "expire_at": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/enterprise/settings/license" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/get-pre-receive-environment-download-status.json b/openapi/ghe-2.14/operations/enterprise-admin/get-pre-receive-environment-download-status.json new file mode 100644 index 0000000000..2e7df1f66c --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/get-pre-receive-environment-download-status.json @@ -0,0 +1,80 @@ +{ + "summary": "Get a pre-receive environment's download status", + "description": "In addition to seeing the download status at the `/admin/pre-receive-environments/:pre_receive_environment_id`, there is also a separate endpoint for just the status.\n\nPossible values for `state` are `not_started`, `in_progress`, `success`, `failed`.", + "operationId": "enterprise-admin-get-pre-receive-environment-download-status", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/pre_receive_environments/#get-a-pre-receive-environments-download-status" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "pre_receive_environment_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "pre_receive_environment_id parameter" + }, + { + "name": "state", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "description": "The state of the most recent download." + }, + { + "name": "downloaded_at", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "description": "The time when the most recent download started." + }, + { + "name": "message", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "description": "On failure, this will have any error messages produced." + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/admin/pre-receive-environments//downloads/latest" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n pre_receive_environment_id: 'pre_receive_environment_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/get-pre-receive-environment.json b/openapi/ghe-2.14/operations/enterprise-admin/get-pre-receive-environment.json new file mode 100644 index 0000000000..6c2e361d12 --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/get-pre-receive-environment.json @@ -0,0 +1,53 @@ +{ + "summary": "Get a single pre-receive environment", + "description": "", + "operationId": "enterprise-admin-get-pre-receive-environment", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/pre_receive_environments/#get-a-single-pre-receive-environment" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "pre_receive_environment_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "pre_receive_environment_id parameter" + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/admin/pre-receive-environments/" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n pre_receive_environment_id: 'pre_receive_environment_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/get-pre-receive-hook-for-org.json b/openapi/ghe-2.14/operations/enterprise-admin/get-pre-receive-hook-for-org.json new file mode 100644 index 0000000000..965c243b61 --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/get-pre-receive-hook-for-org.json @@ -0,0 +1,62 @@ +{ + "summary": "Get a single pre-receive hook for organization", + "description": "", + "operationId": "enterprise-admin-get-pre-receive-hook-for-org", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/org_pre_receive_hooks/#get-a-single-pre-receive-hook" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "org", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "org parameter" + }, + { + "name": "pre_receive_hook_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "pre_receive_hook_id parameter" + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/orgs//pre-receive-hooks/:pre_receive_hook_id" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n org: 'org',\n pre_receive_hook_id: 'pre_receive_hook_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/get-pre-receive-hook-for-repo.json b/openapi/ghe-2.14/operations/enterprise-admin/get-pre-receive-hook-for-repo.json new file mode 100644 index 0000000000..2b2c944afd --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/get-pre-receive-hook-for-repo.json @@ -0,0 +1,71 @@ +{ + "summary": "Get a single pre-receive hook for repository", + "description": "", + "operationId": "enterprise-admin-get-pre-receive-hook-for-repo", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/repo_pre_receive_hooks/#get-a-single-pre-receive-hook" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "pre_receive_hook_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "pre_receive_hook_id parameter" + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/pre-receive-hooks/:pre_receive_hook_id" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n owner: 'octocat',\n repo: 'hello-world',\n pre_receive_hook_id: 'pre_receive_hook_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/get-pre-receive-hook.json b/openapi/ghe-2.14/operations/enterprise-admin/get-pre-receive-hook.json new file mode 100644 index 0000000000..6aa64d4924 --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/get-pre-receive-hook.json @@ -0,0 +1,53 @@ +{ + "summary": "Get a single pre-receive hook", + "description": "", + "operationId": "enterprise-admin-get-pre-receive-hook", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/pre_receive_hooks/#get-a-single-pre-receive-hook" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "pre_receive_hook_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "pre_receive_hook_id parameter" + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/admin/pre-receive-hooks/" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n pre_receive_hook_id: 'pre_receive_hook_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/get-type-stats.json b/openapi/ghe-2.14/operations/enterprise-admin/get-type-stats.json new file mode 100644 index 0000000000..ae95a4d6ea --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/get-type-stats.json @@ -0,0 +1,213 @@ +{ + "summary": "Get statistics", + "description": "There are a variety of types to choose from:\n\n| Type | Description |\n| ------------ | --------------------------------------------------------------------------------------------------- |\n| `issues` | The number of open and closed issues. |\n| `hooks` | The number of active and inactive hooks. |\n| `milestones` | The number of open and closed milestones. |\n| `orgs` | The number of organizations, teams, team members, and disabled organizations. |\n| `comments` | The number of comments on issues, pull requests, commits, and gists. |\n| `pages` | The number of GitHub Pages sites. |\n| `users` | The number of suspended and admin users. |\n| `gists` | The number of private and public gists. |\n| `pulls` | The number of merged, mergeable, and unmergeable pull requests. |\n| `repos` | The number of organization-owned repositories, root repositories, forks, pushed commits, and wikis. |\n| `all` | All of the statistics listed above. |\n\nThese statistics are cached and will be updated approximately every 10 minutes.", + "operationId": "enterprise-admin-get-type-stats", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/admin_stats/#get-statistics" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "type", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "type parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "repos": { + "type": "object", + "properties": { + "total_repos": { + "type": "number" + }, + "root_repos": { + "type": "number" + }, + "fork_repos": { + "type": "number" + }, + "org_repos": { + "type": "number" + }, + "total_pushes": { + "type": "number" + }, + "total_wikis": { + "type": "number" + } + } + }, + "hooks": { + "type": "object", + "properties": { + "total_hooks": { + "type": "number" + }, + "active_hooks": { + "type": "number" + }, + "inactive_hooks": { + "type": "number" + } + } + }, + "pages": { + "type": "object", + "properties": { + "total_pages": { + "type": "number" + } + } + }, + "orgs": { + "type": "object", + "properties": { + "total_orgs": { + "type": "number" + }, + "disabled_orgs": { + "type": "number" + }, + "total_teams": { + "type": "number" + }, + "total_team_members": { + "type": "number" + } + } + }, + "users": { + "type": "object", + "properties": { + "total_users": { + "type": "number" + }, + "admin_users": { + "type": "number" + }, + "suspended_users": { + "type": "number" + } + } + }, + "pulls": { + "type": "object", + "properties": { + "total_pulls": { + "type": "number" + }, + "merged_pulls": { + "type": "number" + }, + "mergeable_pulls": { + "type": "number" + }, + "unmergeable_pulls": { + "type": "number" + } + } + }, + "issues": { + "type": "object", + "properties": { + "total_issues": { + "type": "number" + }, + "open_issues": { + "type": "number" + }, + "closed_issues": { + "type": "number" + } + } + }, + "milestones": { + "type": "object", + "properties": { + "total_milestones": { + "type": "number" + }, + "open_milestones": { + "type": "number" + }, + "closed_milestones": { + "type": "number" + } + } + }, + "gists": { + "type": "object", + "properties": { + "total_gists": { + "type": "number" + }, + "private_gists": { + "type": "number" + }, + "public_gists": { + "type": "number" + } + } + }, + "comments": { + "type": "object", + "properties": { + "total_commit_comments": { + "type": "number" + }, + "total_gist_comments": { + "type": "number" + }, + "total_issue_comments": { + "type": "number" + }, + "total_pull_request_comments": { + "type": "number" + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/enterprise/stats/" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n type: 'type'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/list-global-hooks.json b/openapi/ghe-2.14/operations/enterprise-admin/list-global-hooks.json new file mode 100644 index 0000000000..0d49e025b3 --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/list-global-hooks.json @@ -0,0 +1,70 @@ +{ + "summary": "List global hooks", + "description": "", + "operationId": "enterprise-admin-list-global-hooks", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/global_webhooks/#list-global-hooks" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.superpro-preview+json" + }, + "required": true + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.superpro-preview+json\" \\\n https://developer.github.com/admin/hooks" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/list-pre-receive-environments.json b/openapi/ghe-2.14/operations/enterprise-admin/list-pre-receive-environments.json new file mode 100644 index 0000000000..560ade22f4 --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/list-pre-receive-environments.json @@ -0,0 +1,64 @@ +{ + "summary": "List pre-receive environments", + "description": "", + "operationId": "enterprise-admin-list-pre-receive-environments", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/pre_receive_environments/#list-pre-receive-environments" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/admin/pre-receive-environments" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/list-pre-receive-hooks-for-org.json b/openapi/ghe-2.14/operations/enterprise-admin/list-pre-receive-hooks-for-org.json new file mode 100644 index 0000000000..c7aff40cde --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/list-pre-receive-hooks-for-org.json @@ -0,0 +1,73 @@ +{ + "summary": "List pre-receive hooks for organization", + "description": "List all pre-receive hooks that are enabled or testing for this organization as well as any disabled hooks that can be configured at the organization level. Globally disabled pre-receive hooks that do not allow downstream configuration are not listed.", + "operationId": "enterprise-admin-list-pre-receive-hooks-for-org", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/org_pre_receive_hooks/#list-pre-receive-hooks" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "org", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "org parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/orgs//pre-receive-hooks" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n org: 'org'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/list-pre-receive-hooks-for-repo.json b/openapi/ghe-2.14/operations/enterprise-admin/list-pre-receive-hooks-for-repo.json new file mode 100644 index 0000000000..21a5766dab --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/list-pre-receive-hooks-for-repo.json @@ -0,0 +1,82 @@ +{ + "summary": "List pre-receive hooks for repository", + "description": "List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed.", + "operationId": "enterprise-admin-list-pre-receive-hooks-for-repo", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/repo_pre_receive_hooks/#list-pre-receive-hooks" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/pre-receive-hooks" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/list-pre-receive-hooks.json b/openapi/ghe-2.14/operations/enterprise-admin/list-pre-receive-hooks.json new file mode 100644 index 0000000000..20ee8dda0a --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/list-pre-receive-hooks.json @@ -0,0 +1,64 @@ +{ + "summary": "List pre-receive hooks", + "description": "", + "operationId": "enterprise-admin-list-pre-receive-hooks", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/pre_receive_hooks/#list-pre-receive-hooks" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/admin/pre-receive-hooks" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/modify-settings.json b/openapi/ghe-2.14/operations/enterprise-admin/modify-settings.json new file mode 100644 index 0000000000..eff8aac7e4 --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/modify-settings.json @@ -0,0 +1,62 @@ +{ + "summary": "Modify settings", + "description": "For a list of the available settings, see the [Retrieve settings endpoint](https://developer.github.com/enterprise/2.14/v3/enterprise-admin/management_console/#retrieve-settings).", + "operationId": "enterprise-admin-modify-settings", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/management_console/#modify-settings" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "settings": { + "description": "A JSON string with the new settings. Note that you only need to pass the specific settings you want to modify.", + "type": "string" + } + }, + "required": [ + "settings" + ] + } + } + } + }, + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPUT \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/setup/api/settings \\\n -d '{\"settings\":\"settings\"}'" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n settings: 'settings'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/ping-global-hook.json b/openapi/ghe-2.14/operations/enterprise-admin/ping-global-hook.json new file mode 100644 index 0000000000..c8c930b37b --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/ping-global-hook.json @@ -0,0 +1,54 @@ +{ + "summary": "Ping a global hook", + "description": "This will trigger a [ping event](https://developer.github.com/enterprise/2.14/webhooks/#ping-event) to be sent to the hook.", + "operationId": "enterprise-admin-ping-global-hook", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/global_webhooks/#ping-a-global-hook" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.superpro-preview+json" + }, + "required": true + }, + { + "name": "hook_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "hook_id parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.superpro-preview+json\" \\\n https://developer.github.com/admin/hooks//pings" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n hook_id: 'hook_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/promote-ordinary-user-to-site-administrator.json b/openapi/ghe-2.14/operations/enterprise-admin/promote-ordinary-user-to-site-administrator.json new file mode 100644 index 0000000000..9be484cc3a --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/promote-ordinary-user-to-site-administrator.json @@ -0,0 +1,53 @@ +{ + "summary": "Promote an ordinary user to a site administrator", + "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/enterprise/2.14/v3/#http-verbs).\"", + "operationId": "enterprise-admin-promote-ordinary-user-to-site-administrator", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/users/#promote-an-ordinary-user-to-a-site-administrator" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPUT \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/users//site_admin" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/queue-indexing-job.json b/openapi/ghe-2.14/operations/enterprise-admin/queue-indexing-job.json new file mode 100644 index 0000000000..5f3e074b27 --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/queue-indexing-job.json @@ -0,0 +1,73 @@ +{ + "summary": "Queue an indexing job", + "description": "You can index the following targets (replace `:owner` with the name of a user or organization account and `:repository` with the name of a repository):\n\n| Target | Description |\n| --------------------------- | -------------------------------------------------------------------- |\n| `:owner` | A user or organization account. |\n| `:owner/:repository` | A repository. |\n| `:owner/*` | All of a user or organization's repositories. |\n| `:owner/:repository/issues` | All the issues in a repository. |\n| `:owner/*/issues` | All the issues in all of a user or organization's repositories. |\n| `:owner/:repository/code` | All the source code in a repository. |\n| `:owner/*/code` | All the source code in all of a user or organization's repositories. |", + "operationId": "enterprise-admin-queue-indexing-job", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/search_indexing/#queue-an-indexing-job" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "target": { + "description": "A string representing the item to index.", + "type": "string" + } + }, + "required": [ + "target" + ] + } + } + } + }, + "responses": { + "202": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "message": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/staff/indexing_jobs \\\n -d '{\"target\":\"target\"}'" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n target: 'target'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/remove-authorized-ssh-key.json b/openapi/ghe-2.14/operations/enterprise-admin/remove-authorized-ssh-key.json new file mode 100644 index 0000000000..044d790875 --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/remove-authorized-ssh-key.json @@ -0,0 +1,67 @@ +{ + "summary": "Remove an authorized SSH key", + "description": "", + "operationId": "enterprise-admin-remove-authorized-ssh-key", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/management_console/#remove-an-authorized-ssh-key" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "authorized_key": { + "description": "The path to the public SSH key.", + "type": "string" + } + }, + "required": [ + "authorized_key" + ] + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/setup/api/settings/authorized-keys \\\n -d '{\"authorized_key\":\"authorized_key\"}'" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n authorized_key: 'authorized_key'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/remove-enforcement-overrides-for-pre-receive-hook-for-org.json b/openapi/ghe-2.14/operations/enterprise-admin/remove-enforcement-overrides-for-pre-receive-hook-for-org.json new file mode 100644 index 0000000000..14a7de3719 --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/remove-enforcement-overrides-for-pre-receive-hook-for-org.json @@ -0,0 +1,62 @@ +{ + "summary": "Remove enforcement overrides for a pre-receive hook for organization", + "description": "Removes any overrides for this hook at the org level for this org.", + "operationId": "enterprise-admin-remove-enforcement-overrides-for-pre-receive-hook-for-org", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/org_pre_receive_hooks/#remove-enforcement-overrides-for-a-pre-receive-hook" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "org", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "org parameter" + }, + { + "name": "pre_receive_hook_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "pre_receive_hook_id parameter" + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/orgs//pre-receive-hooks/:pre_receive_hook_id" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n org: 'org',\n pre_receive_hook_id: 'pre_receive_hook_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/remove-enforcement-overrides-for-pre-receive-hook-for-repo.json b/openapi/ghe-2.14/operations/enterprise-admin/remove-enforcement-overrides-for-pre-receive-hook-for-repo.json new file mode 100644 index 0000000000..d8fcaaf68f --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/remove-enforcement-overrides-for-pre-receive-hook-for-repo.json @@ -0,0 +1,91 @@ +{ + "summary": "Remove enforcement overrides for a pre-receive hook for repository", + "description": "Deletes any overridden enforcement on this repository for the specified hook.\n\nResponds with effective values inherited from owner and/or global level.", + "operationId": "enterprise-admin-remove-enforcement-overrides-for-pre-receive-hook-for-repo", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/repo_pre_receive_hooks/#remove-enforcement-overrides-for-a-pre-receive-hook" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "pre_receive_hook_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "pre_receive_hook_id parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "enforcement": { + "type": "string" + }, + "configuration_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/pre-receive-hooks/:pre_receive_hook_id" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n owner: 'octocat',\n repo: 'hello-world',\n pre_receive_hook_id: 'pre_receive_hook_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/rename-org.json b/openapi/ghe-2.14/operations/enterprise-admin/rename-org.json new file mode 100644 index 0000000000..9aa0672910 --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/rename-org.json @@ -0,0 +1,85 @@ +{ + "summary": "Rename an organization", + "description": "", + "operationId": "enterprise-admin-rename-org", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/orgs/#rename-an-organization" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "org", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "org parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "login": { + "description": "The organization's new name.", + "type": "string" + } + }, + "required": [ + "login" + ] + } + } + } + }, + "responses": { + "202": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "message": { + "type": "string" + }, + "url": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPATCH \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/admin/organizations/ \\\n -d '{\"login\":\"login\"}'" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n org: 'org',\n login: 'login'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/rename-user.json b/openapi/ghe-2.14/operations/enterprise-admin/rename-user.json new file mode 100644 index 0000000000..7b27f94e49 --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/rename-user.json @@ -0,0 +1,85 @@ +{ + "summary": "Rename an existing user", + "description": "", + "operationId": "enterprise-admin-rename-user", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/users/#rename-an-existing-user" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "login": { + "description": "The user's new username.", + "type": "string" + } + }, + "required": [ + "login" + ] + } + } + } + }, + "responses": { + "202": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "message": { + "type": "string" + }, + "url": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPATCH \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/admin/users/ \\\n -d '{\"login\":\"login\"}'" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n username: 'username',\n login: 'login'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/retrieve-authorized-ssh-keys.json b/openapi/ghe-2.14/operations/enterprise-admin/retrieve-authorized-ssh-keys.json new file mode 100644 index 0000000000..674eb1a511 --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/retrieve-authorized-ssh-keys.json @@ -0,0 +1,49 @@ +{ + "summary": "Retrieve authorized SSH keys", + "description": "", + "operationId": "enterprise-admin-retrieve-authorized-ssh-keys", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/management_console/#retrieve-authorized-ssh-keys" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/setup/api/settings/authorized-keys" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/retrieve-settings.json b/openapi/ghe-2.14/operations/enterprise-admin/retrieve-settings.json new file mode 100644 index 0000000000..bd953aca67 --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/retrieve-settings.json @@ -0,0 +1,452 @@ +{ + "summary": "Retrieve settings", + "description": "", + "operationId": "enterprise-admin-retrieve-settings", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/management_console/#retrieve-settings" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "enterprise": { + "type": "object", + "properties": { + "private_mode": { + "type": "boolean" + }, + "public_pages": { + "type": "boolean" + }, + "subdomain_isolation": { + "type": "boolean" + }, + "signup_enabled": { + "type": "boolean" + }, + "github_hostname": { + "type": "string" + }, + "identicons_host": { + "type": "string" + }, + "http_proxy": { + "type": "string" + }, + "auth_mode": { + "type": "string" + }, + "expire_sessions": { + "type": "boolean" + }, + "admin_password": { + "type": "string" + }, + "configuration_id": { + "type": "number" + }, + "configuration_run_count": { + "type": "number" + }, + "avatar": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "uri": { + "type": "string" + } + } + }, + "customer": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "email": { + "type": "string" + }, + "uuid": { + "type": "string" + }, + "secret_key_data": { + "type": "string" + }, + "public_key_data": { + "type": "string" + } + } + }, + "license": { + "type": "object", + "properties": { + "seats": { + "type": "number" + }, + "evaluation": { + "type": "boolean" + }, + "perpetual": { + "type": "boolean" + }, + "unlimited_seating": { + "type": "boolean" + }, + "support_key": { + "type": "string" + }, + "ssh_allowed": { + "type": "boolean" + }, + "cluster_support": { + "type": "boolean" + }, + "expire_at": { + "type": "string" + } + } + }, + "github_ssl": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "cert": { + "type": "string" + }, + "key": { + "type": "string" + } + } + }, + "ldap": { + "type": "object", + "properties": { + "host": { + "type": "string" + }, + "port": { + "type": "number" + }, + "base": { + "type": "array", + "items": {} + }, + "uid": { + "type": "string" + }, + "bind_dn": { + "type": "string" + }, + "password": { + "type": "string" + }, + "method": { + "type": "string" + }, + "search_strategy": { + "type": "string" + }, + "user_groups": { + "type": "array", + "items": {} + }, + "admin_group": { + "type": "string" + }, + "virtual_attribute_enabled": { + "type": "boolean" + }, + "recursive_group_search": { + "type": "boolean" + }, + "posix_support": { + "type": "boolean" + }, + "user_sync_emails": { + "type": "boolean" + }, + "user_sync_keys": { + "type": "boolean" + }, + "user_sync_interval": { + "type": "number" + }, + "team_sync_interval": { + "type": "number" + }, + "sync_enabled": { + "type": "boolean" + }, + "reconciliation": { + "type": "object", + "properties": { + "user": { + "type": "string" + }, + "org": { + "type": "string" + } + } + }, + "profile": { + "type": "object", + "properties": { + "uid": { + "type": "string" + }, + "name": { + "type": "string" + }, + "mail": { + "type": "string" + }, + "key": { + "type": "string" + } + } + } + } + }, + "cas": { + "type": "object", + "properties": { + "url": { + "type": "string" + } + } + }, + "saml": { + "type": "object", + "properties": { + "sso_url": { + "type": "string" + }, + "certificate": { + "type": "string" + }, + "certificate_path": { + "type": "string" + }, + "issuer": { + "type": "string" + }, + "idp_initiated_sso": { + "type": "boolean" + }, + "disable_admin_demote": { + "type": "boolean" + } + } + }, + "github_oauth": { + "type": "object", + "properties": { + "client_id": { + "type": "string" + }, + "client_secret": { + "type": "string" + }, + "organization_name": { + "type": "string" + }, + "organization_team": { + "type": "string" + } + } + }, + "smtp": { + "type": "object", + "properties": { + "smtp": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "address": { + "type": "string" + }, + "authentication": { + "type": "string" + }, + "port": { + "type": "string" + }, + "domain": { + "type": "string" + }, + "username": { + "type": "string" + }, + "user_name": { + "type": "string" + }, + "enable_starttls_auto": { + "type": "boolean" + }, + "password": { + "type": "string" + }, + "smtp.discard-to-noreply-address": { + "type": "boolean" + }, + "support_address": { + "type": "string" + }, + "support_address_type": { + "type": "string" + }, + "noreply_address": { + "type": "string" + } + } + } + } + }, + "ntp": { + "type": "object", + "properties": { + "primary_server": { + "type": "string" + }, + "secondary_server": { + "type": "string" + } + } + }, + "timezone": { + "type": "string" + }, + "snmp": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "community": { + "type": "string" + } + } + }, + "syslog": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "server": { + "type": "string" + }, + "protocol_name": { + "type": "string" + } + } + }, + "assets": { + "type": "string" + }, + "pages": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + } + } + }, + "collectd": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "server": { + "type": "string" + }, + "port": { + "type": "number" + }, + "encryption": { + "type": "string" + }, + "username": { + "type": "string" + }, + "password": { + "type": "string" + } + } + }, + "mapping": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "tileserver": { + "type": "string" + }, + "basemap": { + "type": "string" + }, + "token": { + "type": "string" + } + } + }, + "load_balancer": { + "type": "string" + } + } + }, + "run_list": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/setup/api/settings" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/start-configuration-process.json b/openapi/ghe-2.14/operations/enterprise-admin/start-configuration-process.json new file mode 100644 index 0000000000..08b860fac5 --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/start-configuration-process.json @@ -0,0 +1,49 @@ +{ + "summary": "Start a configuration process", + "description": "This endpoint allows you to start a configuration process at any time for your updated settings to take effect:", + "operationId": "enterprise-admin-start-configuration-process", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/management_console/#start-a-configuration-process" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + } + ], + "responses": { + "202": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/setup/api/configure" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/suspend-user.json b/openapi/ghe-2.14/operations/enterprise-admin/suspend-user.json new file mode 100644 index 0000000000..e89dfa60c0 --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/suspend-user.json @@ -0,0 +1,68 @@ +{ + "summary": "Suspend a user", + "description": "If your GitHub Enterprise instance uses [LDAP Sync with Active Directory LDAP servers](https://help.github.com/enterprise/admin/guides/user-management/using-ldap), Active Directory LDAP-authenticated users cannot be suspended through this API. If you attempt to suspend an Active Directory LDAP-authenticated user through this API, it will return a `403` response.\n\nYou can suspend any user account except your own.\n\nNote that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://developer.github.com/enterprise/2.14/v3/#http-verbs).\"", + "operationId": "enterprise-admin-suspend-user", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/users/#suspend-a-user" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "reason": { + "description": "The reason the user is being suspended. This message will be logged in the [audit log](https://help.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Suspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", + "type": "string" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPUT \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/users//suspended" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/sync-ldap-mapping-for-team.json b/openapi/ghe-2.14/operations/enterprise-admin/sync-ldap-mapping-for-team.json new file mode 100644 index 0000000000..a9baa9f05a --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/sync-ldap-mapping-for-team.json @@ -0,0 +1,64 @@ +{ + "summary": "Sync LDAP mapping for a team", + "description": "Note that this API call does not automatically initiate an LDAP sync. Rather, if a `201` is returned, the sync job is queued successfully, and is performed when the instance is ready.", + "operationId": "enterprise-admin-sync-ldap-mapping-for-team", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/ldap/#sync-ldap-mapping-for-a-team" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "team_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "team_id parameter" + } + ], + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/admin/ldap/teams//sync" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n team_id: 'team_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/sync-ldap-mapping-for-user.json b/openapi/ghe-2.14/operations/enterprise-admin/sync-ldap-mapping-for-user.json new file mode 100644 index 0000000000..dde8ce81e5 --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/sync-ldap-mapping-for-user.json @@ -0,0 +1,64 @@ +{ + "summary": "Sync LDAP mapping for a user", + "description": "Note that this API call does not automatically initiate an LDAP sync. Rather, if a `201` is returned, the sync job is queued successfully, and is performed when the instance is ready.", + "operationId": "enterprise-admin-sync-ldap-mapping-for-user", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/ldap/#sync-ldap-mapping-for-a-user" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + } + ], + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/admin/ldap/users//sync" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/trigger-pre-receive-environment-download.json b/openapi/ghe-2.14/operations/enterprise-admin/trigger-pre-receive-environment-download.json new file mode 100644 index 0000000000..59086d8d44 --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/trigger-pre-receive-environment-download.json @@ -0,0 +1,73 @@ +{ + "summary": "Trigger a pre-receive environment download", + "description": "Triggers a new download of the environment tarball from the environment's `image_url`. When the download is finished, the newly downloaded tarball will overwrite the existing environment.\n\nIf a download cannot be triggered, you will get a reponse like this:\n\nThe possible error messages are:\n\n* _Cannot modify or delete the default environment_\n* _Can not start a new download when a download is in progress_", + "operationId": "enterprise-admin-trigger-pre-receive-environment-download", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/pre_receive_environments/#trigger-a-pre-receive-environment-download" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "pre_receive_environment_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "pre_receive_environment_id parameter" + } + ], + "responses": { + "202": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "state": { + "type": "string" + }, + "downloaded_at": { + "type": "string" + }, + "message": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/admin/pre-receive-environments//downloads" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n pre_receive_environment_id: 'pre_receive_environment_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/unsuspend-user.json b/openapi/ghe-2.14/operations/enterprise-admin/unsuspend-user.json new file mode 100644 index 0000000000..14a923f748 --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/unsuspend-user.json @@ -0,0 +1,68 @@ +{ + "summary": "Unsuspend a user", + "description": "If your GitHub Enterprise instance uses [LDAP Sync with Active Directory LDAP servers](https://help.github.com/enterprise/admin/guides/user-management/using-ldap), this API is disabled and will return a `403` response. Active Directory LDAP-authenticated users cannot be unsuspended using the API.", + "operationId": "enterprise-admin-unsuspend-user", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/users/#unsuspend-a-user" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "reason": { + "description": "The reason the user is being unsuspended. This message will be logged in the [audit log](https://help.github.com/enterprise/admin/articles/audit-logging/). If you don't provide a `reason`, it will default to \"Unsuspended via API by _SITE\\_ADMINISTRATOR_\", where _SITE\\_ADMINISTRATOR_ is the person who performed the action.", + "type": "string" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/users//suspended" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/update-global-hook.json b/openapi/ghe-2.14/operations/enterprise-admin/update-global-hook.json new file mode 100644 index 0000000000..18bb80144d --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/update-global-hook.json @@ -0,0 +1,154 @@ +{ + "summary": "Edit a global hook", + "description": "Parameters that are not provided will be overwritten with the default value or removed if no default exists.", + "operationId": "enterprise-admin-update-global-hook", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/global_webhooks/#edit-a-global-hook" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.superpro-preview+json" + }, + "required": true + }, + { + "name": "hook_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "hook_id parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "config": { + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.14/v3/enterprise-admin/global_webhooks/#update-hook-config-params).", + "type": "object", + "properties": { + "url": { + "description": "The URL to which the payloads will be delivered.", + "type": "string" + }, + "content_type": { + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "type": "string" + }, + "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/enterprise/2.14/webhooks/#delivery-headers) header.", + "type": "string" + }, + "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.**", + "type": "string" + } + }, + "required": [ + "url" + ] + }, + "events": { + "description": "The [events](https://developer.github.com/enterprise/2.14/v3/activity/events/types/) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", + "type": "array", + "items": { + "type": "string" + } + }, + "active": { + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "type": "boolean", + "default": true + } + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "type": { + "type": "string" + }, + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "config": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "content_type": { + "type": "string" + }, + "insecure_ssl": { + "type": "string" + } + } + }, + "updated_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "ping_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPATCH \\\n -H\"Accept: application/vnd.github.superpro-preview+json\" \\\n https://developer.github.com/admin/hooks/ \\\n -d '{\"config.url\":\"config.url\"}'" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n hook_id: 'hook_id',\n 'config.url': 'config.url'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/update-ldap-mapping-for-team.json b/openapi/ghe-2.14/operations/enterprise-admin/update-ldap-mapping-for-team.json new file mode 100644 index 0000000000..aa631be183 --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/update-ldap-mapping-for-team.json @@ -0,0 +1,112 @@ +{ + "summary": "Update LDAP mapping for a team", + "description": "Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://help.github.com/enterprise/admin/guides/user-management/using-ldap/#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create team](https://developer.github.com/enterprise/2.14/v3/teams/#create-team) endpoint to create a team with LDAP mapping.\n\nIf you pass the `hellcat-preview` media type, you can also update the LDAP mapping of a child team.", + "operationId": "enterprise-admin-update-ldap-mapping-for-team", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/ldap/#update-ldap-mapping-for-a-team" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "team_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "team_id parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "ldap_dn": { + "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", + "type": "string" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "ldap_dn": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string" + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPATCH \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/admin/ldap/teams//mapping" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n team_id: 'team_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/update-ldap-mapping-for-user.json b/openapi/ghe-2.14/operations/enterprise-admin/update-ldap-mapping-for-user.json new file mode 100644 index 0000000000..f2db4dd9ac --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/update-ldap-mapping-for-user.json @@ -0,0 +1,133 @@ +{ + "summary": "Update LDAP mapping for a user", + "description": "", + "operationId": "enterprise-admin-update-ldap-mapping-for-user", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/ldap/#update-ldap-mapping-for-a-user" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "ldap_dn": { + "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.", + "type": "string" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "ldap_dn": { + "type": "string" + }, + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPATCH \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/admin/ldap/users//mapping" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/update-pre-receive-environment.json b/openapi/ghe-2.14/operations/enterprise-admin/update-pre-receive-environment.json new file mode 100644 index 0000000000..8e31bc09df --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/update-pre-receive-environment.json @@ -0,0 +1,121 @@ +{ + "summary": "Edit a pre-receive environment", + "description": "If you attempt to modify the default environment, you will get a response like this:", + "operationId": "enterprise-admin-update-pre-receive-environment", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/pre_receive_environments/#edit-a-pre-receive-environment" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "pre_receive_environment_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "pre_receive_environment_id parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "This pre-receive environment's new name.", + "type": "string" + }, + "image_url": { + "description": "URL from which to download a tarball of this environment.", + "type": "string" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "image_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "default_environment": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "hooks_count": { + "type": "number" + }, + "download": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "state": { + "type": "string" + }, + "downloaded_at": { + "type": "string" + }, + "message": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPATCH \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/admin/pre-receive-environments/" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n pre_receive_environment_id: 'pre_receive_environment_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/update-pre-receive-hook-enforcement-for-org.json b/openapi/ghe-2.14/operations/enterprise-admin/update-pre-receive-hook-enforcement-for-org.json new file mode 100644 index 0000000000..b91de6cdcf --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/update-pre-receive-hook-enforcement-for-org.json @@ -0,0 +1,85 @@ +{ + "summary": "Update pre-receive hook enforcement for organization", + "description": "For pre-receive hooks which are allowed to be configured at the org level, you can set `enforcement` and `allow_downstream_configuration`", + "operationId": "enterprise-admin-update-pre-receive-hook-enforcement-for-org", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/org_pre_receive_hooks/#update-pre-receive-hook-enforcement" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "org", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "org parameter" + }, + { + "name": "pre_receive_hook_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "pre_receive_hook_id parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "enforcement": { + "type": "string" + }, + "configuration_url": { + "type": "string" + }, + "allow_downstream_configuration": { + "type": "boolean" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPATCH \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/orgs//pre-receive-hooks/:pre_receive_hook_id" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n org: 'org',\n pre_receive_hook_id: 'pre_receive_hook_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/update-pre-receive-hook-enforcement-for-repo.json b/openapi/ghe-2.14/operations/enterprise-admin/update-pre-receive-hook-enforcement-for-repo.json new file mode 100644 index 0000000000..78c32bae41 --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/update-pre-receive-hook-enforcement-for-repo.json @@ -0,0 +1,91 @@ +{ + "summary": "Update pre-receive hook enforcement for repository", + "description": "For pre-receive hooks which are allowed to be configured at the repo level, you can set `enforcement`", + "operationId": "enterprise-admin-update-pre-receive-hook-enforcement-for-repo", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/repo_pre_receive_hooks/#update-pre-receive-hook-enforcement" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "pre_receive_hook_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "pre_receive_hook_id parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "enforcement": { + "type": "string" + }, + "configuration_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPATCH \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/pre-receive-hooks/:pre_receive_hook_id" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n owner: 'octocat',\n repo: 'hello-world',\n pre_receive_hook_id: 'pre_receive_hook_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/update-pre-receive-hook.json b/openapi/ghe-2.14/operations/enterprise-admin/update-pre-receive-hook.json new file mode 100644 index 0000000000..d579fce34e --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/update-pre-receive-hook.json @@ -0,0 +1,139 @@ +{ + "summary": "Edit a pre-receive hook", + "description": "", + "operationId": "enterprise-admin-update-pre-receive-hook", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/pre_receive_hooks/#edit-a-pre-receive-hook" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "pre_receive_hook_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "pre_receive_hook_id parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "enforcement": { + "type": "string" + }, + "script": { + "type": "string" + }, + "script_repository": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "full_name": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + } + } + }, + "environment": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "image_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "default_environment": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "hooks_count": { + "type": "number" + }, + "download": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "state": { + "type": "string" + }, + "downloaded_at": { + "type": "string" + }, + "message": { + "type": "string" + } + } + } + } + }, + "allow_downstream_configuration": { + "type": "boolean" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPATCH \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/admin/pre_receive_hooks/" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n pre_receive_hook_id: 'pre_receive_hook_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/upgrade-license.json b/openapi/ghe-2.14/operations/enterprise-admin/upgrade-license.json new file mode 100644 index 0000000000..0e959ab12e --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/upgrade-license.json @@ -0,0 +1,64 @@ +{ + "summary": "Upgrade a license", + "description": "This API upgrades your license and also triggers the configuration process:", + "operationId": "enterprise-admin-upgrade-license", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/management_console/#upgrade-a-license" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "license": { + "description": "The content of your new _.ghl_ license file.", + "type": "string" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/setup/api/upgrade" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/enterprise-admin/upload-license-for-first-time.json b/openapi/ghe-2.14/operations/enterprise-admin/upload-license-for-first-time.json new file mode 100644 index 0000000000..23623e9eb1 --- /dev/null +++ b/openapi/ghe-2.14/operations/enterprise-admin/upload-license-for-first-time.json @@ -0,0 +1,75 @@ +{ + "summary": "Upload a license for the first time", + "description": "When you boot a GitHub Enterprise instance for the first time, you can use the following endpoint to upload a license:\n\nNote that you need to POST to [`/setup/api/configure`](https://developer.github.com/enterprise/2.14/v3/enterprise-admin/management_console/#start-a-configuration-process) to start the actual configuration process.\n\nWhen using this endpoint, your GitHub Enterprise instance must have a password set. This can be accomplished two ways:\n\n1. If you're working directly with the API before accessing the web interface, you must pass in the password parameter to set your password.\n2. If you set up your instance via the web interface before accessing the API, your calls to this endpoint do not need the password parameter.\n\nFor a list of the available settings, see the [Retrieve settings endpoint](https://developer.github.com/enterprise/2.14/v3/enterprise-admin/management_console/#retrieve-settings).", + "operationId": "enterprise-admin-upload-license-for-first-time", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/enterprise-admin/management_console/#upload-a-license-for-the-first-time" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "license": { + "description": "The content of your _.ghl_ license file.", + "type": "string" + }, + "password": { + "description": "You **must** provide a password _only if_ you are uploading your license for the first time. If you previously set a password through the web interface, you don't need this parameter.", + "type": "string" + }, + "settings": { + "description": "An optional JSON string containing the installation settings.", + "type": "string" + } + }, + "required": [ + "license" + ] + } + } + } + }, + "responses": { + "202": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/setup/api/start \\\n -d '{\"license\":\"license\"}'" + }, + { + "lang": "JS", + "source": "octokit.enterprise-admin.get({\n license: 'license'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/gists/check-is-starred.json b/openapi/ghe-2.14/operations/gists/check-is-starred.json new file mode 100644 index 0000000000..78b503c102 --- /dev/null +++ b/openapi/ghe-2.14/operations/gists/check-is-starred.json @@ -0,0 +1,53 @@ +{ + "summary": "Check if a gist is starred", + "description": "", + "operationId": "gists-check-is-starred", + "tags": [ + "gists" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/gists/#check-if-a-gist-is-starred" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "gist_id", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "gist_id parameter" + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/gists//star" + }, + { + "lang": "JS", + "source": "octokit.gists.get({\n gist_id: 'gist_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/gists/create-comment.json b/openapi/ghe-2.14/operations/gists/create-comment.json new file mode 100644 index 0000000000..a1a3965ccc --- /dev/null +++ b/openapi/ghe-2.14/operations/gists/create-comment.json @@ -0,0 +1,156 @@ +{ + "summary": "Create a comment", + "description": "", + "operationId": "gists-create-comment", + "tags": [ + "gists" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/gists/comments/#create-a-comment" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "gist_id", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "gist_id parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "description": "The comment text.", + "type": "string" + } + }, + "required": [ + "body" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "body": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/gists//comments \\\n -d '{\"body\":\"body\"}'" + }, + { + "lang": "JS", + "source": "octokit.gists.get({\n gist_id: 'gist_id',\n body: 'body'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/gists/create.json b/openapi/ghe-2.14/operations/gists/create.json new file mode 100644 index 0000000000..8106160534 --- /dev/null +++ b/openapi/ghe-2.14/operations/gists/create.json @@ -0,0 +1,470 @@ +{ + "summary": "Create a gist", + "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.", + "operationId": "gists-create", + "tags": [ + "gists" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/gists/#create-a-gist" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "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`.", + "type": "object", + "properties": { + "content": { + "description": "The content of the file.", + "type": "string" + } + } + }, + "description": { + "description": "A descriptive name for this gist.", + "type": "string" + }, + "public": { + "description": "When `true`, the gist will be public and available for anyone to see.", + "type": "boolean", + "default": false + } + }, + "required": [ + "files" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { + "type": "object", + "properties": { + "hello_world.rb": { + "type": "object", + "properties": { + "filename": { + "type": "string" + }, + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "number" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } + } + }, + "hello_world.py": { + "type": "object", + "properties": { + "filename": { + "type": "string" + }, + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "number" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } + } + }, + "hello_world_ruby.txt": { + "type": "object", + "properties": { + "filename": { + "type": "string" + }, + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "number" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } + } + }, + "hello_world_python.txt": { + "type": "object", + "properties": { + "filename": { + "type": "string" + }, + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "number" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } + } + } + } + }, + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string" + }, + "comments": { + "type": "number" + }, + "user": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "truncated": { + "type": "boolean" + }, + "forks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + } + }, + "history": { + "type": "array", + "items": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "version": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "change_status": { + "type": "object", + "properties": { + "deletions": { + "type": "number" + }, + "additions": { + "type": "number" + }, + "total": { + "type": "number" + } + } + }, + "committed_at": { + "type": "string" + } + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/gists \\\n -d '{\"files\":\"files\"}'" + }, + { + "lang": "JS", + "source": "octokit.gists.get({\n files: 'files'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/gists/delete-comment.json b/openapi/ghe-2.14/operations/gists/delete-comment.json new file mode 100644 index 0000000000..53792144d8 --- /dev/null +++ b/openapi/ghe-2.14/operations/gists/delete-comment.json @@ -0,0 +1,62 @@ +{ + "summary": "Delete a comment", + "description": "", + "operationId": "gists-delete-comment", + "tags": [ + "gists" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/gists/comments/#delete-a-comment" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "gist_id", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "gist_id parameter" + }, + { + "name": "comment_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "comment_id parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/gists//comments/:comment_id" + }, + { + "lang": "JS", + "source": "octokit.gists.get({\n gist_id: 'gist_id',\n comment_id: 'comment_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/gists/delete.json b/openapi/ghe-2.14/operations/gists/delete.json new file mode 100644 index 0000000000..1bf7cb966f --- /dev/null +++ b/openapi/ghe-2.14/operations/gists/delete.json @@ -0,0 +1,53 @@ +{ + "summary": "Delete a gist", + "description": "", + "operationId": "gists-delete", + "tags": [ + "gists" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/gists/#delete-a-gist" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "gist_id", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "gist_id parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/gists/" + }, + { + "lang": "JS", + "source": "octokit.gists.get({\n gist_id: 'gist_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/gists/fork.json b/openapi/ghe-2.14/operations/gists/fork.json new file mode 100644 index 0000000000..26ac4dd3e4 --- /dev/null +++ b/openapi/ghe-2.14/operations/gists/fork.json @@ -0,0 +1,193 @@ +{ + "summary": "Fork a gist", + "description": "**Note**: This was previously `/gists/:gist_id/fork`.", + "operationId": "gists-fork", + "tags": [ + "gists" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/gists/#fork-a-gist" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "gist_id", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "gist_id parameter" + } + ], + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { + "type": "object", + "properties": { + "hello_world.rb": { + "type": "object", + "properties": { + "filename": { + "type": "string" + }, + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "number" + } + } + } + } + }, + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string" + }, + "comments": { + "type": "number" + }, + "user": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "truncated": { + "type": "boolean" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/gists//forks" + }, + { + "lang": "JS", + "source": "octokit.gists.get({\n gist_id: 'gist_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/gists/get-comment.json b/openapi/ghe-2.14/operations/gists/get-comment.json new file mode 100644 index 0000000000..dc6d7eefff --- /dev/null +++ b/openapi/ghe-2.14/operations/gists/get-comment.json @@ -0,0 +1,147 @@ +{ + "summary": "Get a single comment", + "description": "", + "operationId": "gists-get-comment", + "tags": [ + "gists" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/gists/comments/#get-a-single-comment" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "gist_id", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "gist_id parameter" + }, + { + "name": "comment_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "comment_id parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "body": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/gists//comments/:comment_id" + }, + { + "lang": "JS", + "source": "octokit.gists.get({\n gist_id: 'gist_id',\n comment_id: 'comment_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/gists/get-revision.json b/openapi/ghe-2.14/operations/gists/get-revision.json new file mode 100644 index 0000000000..741665b1df --- /dev/null +++ b/openapi/ghe-2.14/operations/gists/get-revision.json @@ -0,0 +1,455 @@ +{ + "summary": "Get a specific revision of a gist", + "description": "", + "operationId": "gists-get-revision", + "tags": [ + "gists" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/gists/#get-a-specific-revision-of-a-gist" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "gist_id", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "gist_id parameter" + }, + { + "name": "sha", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "sha parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { + "type": "object", + "properties": { + "hello_world.rb": { + "type": "object", + "properties": { + "filename": { + "type": "string" + }, + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "number" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } + } + }, + "hello_world.py": { + "type": "object", + "properties": { + "filename": { + "type": "string" + }, + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "number" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } + } + }, + "hello_world_ruby.txt": { + "type": "object", + "properties": { + "filename": { + "type": "string" + }, + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "number" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } + } + }, + "hello_world_python.txt": { + "type": "object", + "properties": { + "filename": { + "type": "string" + }, + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "number" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } + } + } + } + }, + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string" + }, + "comments": { + "type": "number" + }, + "user": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "truncated": { + "type": "boolean" + }, + "forks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + } + }, + "history": { + "type": "array", + "items": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "version": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "change_status": { + "type": "object", + "properties": { + "deletions": { + "type": "number" + }, + "additions": { + "type": "number" + }, + "total": { + "type": "number" + } + } + }, + "committed_at": { + "type": "string" + } + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/gists//:sha" + }, + { + "lang": "JS", + "source": "octokit.gists.get({\n gist_id: 'gist_id',\n sha: 'sha'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/gists/get.json b/openapi/ghe-2.14/operations/gists/get.json new file mode 100644 index 0000000000..622a68a9b8 --- /dev/null +++ b/openapi/ghe-2.14/operations/gists/get.json @@ -0,0 +1,446 @@ +{ + "summary": "Get a single gist", + "description": "", + "operationId": "gists-get", + "tags": [ + "gists" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/gists/#get-a-single-gist" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "gist_id", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "gist_id parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { + "type": "object", + "properties": { + "hello_world.rb": { + "type": "object", + "properties": { + "filename": { + "type": "string" + }, + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "number" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } + } + }, + "hello_world.py": { + "type": "object", + "properties": { + "filename": { + "type": "string" + }, + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "number" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } + } + }, + "hello_world_ruby.txt": { + "type": "object", + "properties": { + "filename": { + "type": "string" + }, + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "number" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } + } + }, + "hello_world_python.txt": { + "type": "object", + "properties": { + "filename": { + "type": "string" + }, + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "number" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } + } + } + } + }, + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string" + }, + "comments": { + "type": "number" + }, + "user": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "truncated": { + "type": "boolean" + }, + "forks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + } + }, + "history": { + "type": "array", + "items": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "version": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "change_status": { + "type": "object", + "properties": { + "deletions": { + "type": "number" + }, + "additions": { + "type": "number" + }, + "total": { + "type": "number" + } + } + }, + "committed_at": { + "type": "string" + } + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/gists/" + }, + { + "lang": "JS", + "source": "octokit.gists.get({\n gist_id: 'gist_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/gists/list-comments.json b/openapi/ghe-2.14/operations/gists/list-comments.json new file mode 100644 index 0000000000..fd46ab6024 --- /dev/null +++ b/openapi/ghe-2.14/operations/gists/list-comments.json @@ -0,0 +1,78 @@ +{ + "summary": "List comments on a gist", + "description": "", + "operationId": "gists-list-comments", + "tags": [ + "gists" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/gists/comments/#list-comments-on-a-gist" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "gist_id", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "gist_id parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/gists//comments" + }, + { + "lang": "JS", + "source": "octokit.gists.get({\n gist_id: 'gist_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/gists/list-commits.json b/openapi/ghe-2.14/operations/gists/list-commits.json new file mode 100644 index 0000000000..3165be4ecf --- /dev/null +++ b/openapi/ghe-2.14/operations/gists/list-commits.json @@ -0,0 +1,78 @@ +{ + "summary": "List gist commits", + "description": "", + "operationId": "gists-list-commits", + "tags": [ + "gists" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/gists/#list-gist-commits" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "gist_id", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "gist_id parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/gists//commits" + }, + { + "lang": "JS", + "source": "octokit.gists.get({\n gist_id: 'gist_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/gists/list-forks.json b/openapi/ghe-2.14/operations/gists/list-forks.json new file mode 100644 index 0000000000..7df6160a88 --- /dev/null +++ b/openapi/ghe-2.14/operations/gists/list-forks.json @@ -0,0 +1,78 @@ +{ + "summary": "List gist forks", + "description": "", + "operationId": "gists-list-forks", + "tags": [ + "gists" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/gists/#list-gist-forks" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "gist_id", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "gist_id parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/gists//forks" + }, + { + "lang": "JS", + "source": "octokit.gists.get({\n gist_id: 'gist_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/gists/list-public-for-user.json b/openapi/ghe-2.14/operations/gists/list-public-for-user.json new file mode 100644 index 0000000000..e3a9644b39 --- /dev/null +++ b/openapi/ghe-2.14/operations/gists/list-public-for-user.json @@ -0,0 +1,87 @@ +{ + "summary": "List public gists for the specified user", + "description": "", + "operationId": "gists-list-public-for-user", + "tags": [ + "gists" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/gists/#list-a-users-gists" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "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." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/users//gists" + }, + { + "lang": "JS", + "source": "octokit.gists.get({\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/gists/list-public.json b/openapi/ghe-2.14/operations/gists/list-public.json new file mode 100644 index 0000000000..bb9943206b --- /dev/null +++ b/openapi/ghe-2.14/operations/gists/list-public.json @@ -0,0 +1,78 @@ +{ + "summary": "List all public gists", + "description": "List all public gists sorted by most recently updated to least recently updated.\n\nNote: With [pagination](https://developer.github.com/enterprise/2.14/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.", + "operationId": "gists-list-public", + "tags": [ + "gists" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/gists/#list-all-public-gists" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "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." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/gists/public" + }, + { + "lang": "JS", + "source": "octokit.gists.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/gists/list-starred.json b/openapi/ghe-2.14/operations/gists/list-starred.json new file mode 100644 index 0000000000..0f378cc3ca --- /dev/null +++ b/openapi/ghe-2.14/operations/gists/list-starred.json @@ -0,0 +1,78 @@ +{ + "summary": "List starred gists", + "description": "List the authenticated user's starred gists:", + "operationId": "gists-list-starred", + "tags": [ + "gists" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/gists/#list-starred-gists" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "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." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/gists/starred" + }, + { + "lang": "JS", + "source": "octokit.gists.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/gists/list.json b/openapi/ghe-2.14/operations/gists/list.json new file mode 100644 index 0000000000..215cd686bf --- /dev/null +++ b/openapi/ghe-2.14/operations/gists/list.json @@ -0,0 +1,78 @@ +{ + "summary": "List the authenticated user's gists or if called anonymously, this will return all public gists", + "description": "", + "operationId": "gists-list", + "tags": [ + "gists" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/gists/#list-a-users-gists" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "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." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/gists" + }, + { + "lang": "JS", + "source": "octokit.gists.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/gists/star.json b/openapi/ghe-2.14/operations/gists/star.json new file mode 100644 index 0000000000..268f57fd2e --- /dev/null +++ b/openapi/ghe-2.14/operations/gists/star.json @@ -0,0 +1,53 @@ +{ + "summary": "Star a gist", + "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/enterprise/2.14/v3/#http-verbs).\"", + "operationId": "gists-star", + "tags": [ + "gists" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/gists/#star-a-gist" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "gist_id", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "gist_id parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPUT \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/gists//star" + }, + { + "lang": "JS", + "source": "octokit.gists.get({\n gist_id: 'gist_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/gists/unstar.json b/openapi/ghe-2.14/operations/gists/unstar.json new file mode 100644 index 0000000000..aa068a36ce --- /dev/null +++ b/openapi/ghe-2.14/operations/gists/unstar.json @@ -0,0 +1,53 @@ +{ + "summary": "Unstar a gist", + "description": "", + "operationId": "gists-unstar", + "tags": [ + "gists" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/gists/#unstar-a-gist" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "gist_id", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "gist_id parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/gists//star" + }, + { + "lang": "JS", + "source": "octokit.gists.get({\n gist_id: 'gist_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/gists/update-comment.json b/openapi/ghe-2.14/operations/gists/update-comment.json new file mode 100644 index 0000000000..7b07ef21a8 --- /dev/null +++ b/openapi/ghe-2.14/operations/gists/update-comment.json @@ -0,0 +1,165 @@ +{ + "summary": "Edit a comment", + "description": "", + "operationId": "gists-update-comment", + "tags": [ + "gists" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/gists/comments/#edit-a-comment" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "gist_id", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "gist_id parameter" + }, + { + "name": "comment_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "comment_id parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "description": "The comment text.", + "type": "string" + } + }, + "required": [ + "body" + ] + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "body": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPATCH \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/gists//comments/:comment_id \\\n -d '{\"body\":\"body\"}'" + }, + { + "lang": "JS", + "source": "octokit.gists.get({\n gist_id: 'gist_id',\n comment_id: 'comment_id',\n body: 'body'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/gists/update.json b/openapi/ghe-2.14/operations/gists/update.json new file mode 100644 index 0000000000..c12b365d0f --- /dev/null +++ b/openapi/ghe-2.14/operations/gists/update.json @@ -0,0 +1,475 @@ +{ + "summary": "Edit a gist", + "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.", + "operationId": "gists-update", + "tags": [ + "gists" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/gists/#edit-a-gist" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "gist_id", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "gist_id parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "description": { + "description": "A descriptive name for this gist.", + "type": "string" + }, + "files": { + "description": "The filenames and content that make up this gist.", + "type": "object", + "properties": { + "content": { + "description": "The updated content of the file.", + "type": "string" + }, + "filename": { + "description": "The new name for this file. To delete a file, set the value of the filename to `null`.", + "type": "string" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "git_pull_url": { + "type": "string" + }, + "git_push_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "files": { + "type": "object", + "properties": { + "hello_world.rb": { + "type": "object", + "properties": { + "filename": { + "type": "string" + }, + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "number" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } + } + }, + "hello_world.py": { + "type": "object", + "properties": { + "filename": { + "type": "string" + }, + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "number" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } + } + }, + "hello_world.md": { + "type": "object", + "properties": { + "filename": { + "type": "string" + }, + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "number" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } + } + }, + "new_file.txt": { + "type": "object", + "properties": { + "filename": { + "type": "string" + }, + "type": { + "type": "string" + }, + "language": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "size": { + "type": "number" + }, + "truncated": { + "type": "boolean" + }, + "content": { + "type": "string" + } + } + } + } + }, + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "description": { + "type": "string" + }, + "comments": { + "type": "number" + }, + "user": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "truncated": { + "type": "boolean" + }, + "forks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "url": { + "type": "string" + }, + "id": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + } + }, + "history": { + "type": "array", + "items": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "version": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "change_status": { + "type": "object", + "properties": { + "deletions": { + "type": "number" + }, + "additions": { + "type": "number" + }, + "total": { + "type": "number" + } + } + }, + "committed_at": { + "type": "string" + } + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPATCH \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/gists/" + }, + { + "lang": "JS", + "source": "octokit.gists.get({\n gist_id: 'gist_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/git/create-blob.json b/openapi/ghe-2.14/operations/git/create-blob.json new file mode 100644 index 0000000000..efaa6db239 --- /dev/null +++ b/openapi/ghe-2.14/operations/git/create-blob.json @@ -0,0 +1,99 @@ +{ + "summary": "Create a blob", + "description": "", + "operationId": "git-create-blob", + "tags": [ + "git" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/git/blobs/#create-a-blob" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "content": { + "description": "The new blob's content.", + "type": "string" + }, + "encoding": { + "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", + "type": "string", + "default": "utf-8" + } + }, + "required": [ + "content" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "sha": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/git/blobs \\\n -d '{\"content\":\"content\"}'" + }, + { + "lang": "JS", + "source": "octokit.git.get({\n owner: 'octocat',\n repo: 'hello-world',\n content: 'content'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/git/create-commit.json b/openapi/ghe-2.14/operations/git/create-commit.json new file mode 100644 index 0000000000..b136a57200 --- /dev/null +++ b/openapi/ghe-2.14/operations/git/create-commit.json @@ -0,0 +1,223 @@ +{ + "summary": "Create a commit", + "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. |", + "operationId": "git-create-commit", + "tags": [ + "git" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/git/commits/#create-a-commit" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "description": "The commit message", + "type": "string" + }, + "tree": { + "description": "The SHA of the tree object this commit points to", + "type": "string" + }, + "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.", + "type": "array", + "items": { + "type": "string" + } + }, + "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.", + "type": "object", + "properties": { + "name": { + "description": "The name of the author (or committer) of the commit", + "type": "string" + }, + "email": { + "description": "The email of the author (or committer) of the commit", + "type": "string" + }, + "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`.", + "type": "string" + } + } + }, + "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.", + "type": "object", + "properties": { + "name": { + "description": "The name of the author (or committer) of the commit", + "type": "string" + }, + "email": { + "description": "The email of the author (or committer) of the commit", + "type": "string" + }, + "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`.", + "type": "string" + } + } + }, + "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.", + "type": "string" + } + }, + "required": [ + "message", + "tree", + "parents" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "sha": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "author": { + "type": "object", + "properties": { + "date": { + "type": "string" + }, + "name": { + "type": "string" + }, + "email": { + "type": "string" + } + } + }, + "committer": { + "type": "object", + "properties": { + "date": { + "type": "string" + }, + "name": { + "type": "string" + }, + "email": { + "type": "string" + } + } + }, + "message": { + "type": "string" + }, + "tree": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "sha": { + "type": "string" + } + } + }, + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "sha": { + "type": "string" + } + } + } + }, + "verification": { + "type": "object", + "properties": { + "verified": { + "type": "boolean" + }, + "reason": { + "type": "string" + }, + "signature": { + "type": "string" + }, + "payload": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/git/commits \\\n -d '{\"message\":\"message\",\"tree\":\"tree\",\"parents\":\"parents\"}'" + }, + { + "lang": "JS", + "source": "octokit.git.get({\n owner: 'octocat',\n repo: 'hello-world',\n message: 'message',\n tree: 'tree',\n parents: 'parents'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/git/create-ref.json b/openapi/ghe-2.14/operations/git/create-ref.json new file mode 100644 index 0000000000..e2665a5254 --- /dev/null +++ b/openapi/ghe-2.14/operations/git/create-ref.json @@ -0,0 +1,116 @@ +{ + "summary": "Create a reference", + "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.", + "operationId": "git-create-ref", + "tags": [ + "git" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/git/refs/#create-a-reference" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "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.", + "type": "string" + }, + "sha": { + "description": "The SHA1 value for this reference.", + "type": "string" + } + }, + "required": [ + "ref", + "sha" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "ref": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "object": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "url": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/git/refs \\\n -d '{\"ref\":\"ref\",\"sha\":\"sha\"}'" + }, + { + "lang": "JS", + "source": "octokit.git.get({\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref',\n sha: 'sha'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/git/create-tag.json b/openapi/ghe-2.14/operations/git/create-tag.json new file mode 100644 index 0000000000..a96bbbfbbd --- /dev/null +++ b/openapi/ghe-2.14/operations/git/create-tag.json @@ -0,0 +1,186 @@ +{ + "summary": "Create a tag object", + "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/enterprise/2.14/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/enterprise/2.14/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. |", + "operationId": "git-create-tag", + "tags": [ + "git" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/git/tags/#create-a-tag-object" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "tag": { + "description": "The tag's name. This is typically a version (e.g., \"v0.0.1\").", + "type": "string" + }, + "message": { + "description": "The tag message.", + "type": "string" + }, + "object": { + "description": "The SHA of the git object this is tagging.", + "type": "string" + }, + "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`.", + "type": "string", + "enum": [ + "commit", + "tree", + "blob" + ] + }, + "tagger": { + "description": "An object with information about the individual creating the tag.", + "type": "object", + "properties": { + "name": { + "description": "The name of the author of the tag", + "type": "string" + }, + "email": { + "description": "The email of the author of the tag", + "type": "string" + }, + "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`.", + "type": "string" + } + } + } + }, + "required": [ + "tag", + "message", + "object", + "type" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "node_id": { + "type": "string" + }, + "tag": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "url": { + "type": "string" + }, + "message": { + "type": "string" + }, + "tagger": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "email": { + "type": "string" + }, + "date": { + "type": "string" + } + } + }, + "object": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "url": { + "type": "string" + } + } + }, + "verification": { + "type": "object", + "properties": { + "verified": { + "type": "boolean" + }, + "reason": { + "type": "string" + }, + "signature": { + "type": "string" + }, + "payload": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/git/tags \\\n -d '{\"tag\":\"tag\",\"message\":\"message\",\"object\":\"object\",\"type\":\"type\"}'" + }, + { + "lang": "JS", + "source": "octokit.git.get({\n owner: 'octocat',\n repo: 'hello-world',\n tag: 'tag',\n message: 'message',\n object: 'object',\n type: 'type'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/git/create-tree.json b/openapi/ghe-2.14/operations/git/create-tree.json new file mode 100644 index 0000000000..a56e47ea8e --- /dev/null +++ b/openapi/ghe-2.14/operations/git/create-tree.json @@ -0,0 +1,161 @@ +{ + "summary": "Create a tree", + "description": "The tree creation API will take nested entries as well. If both a tree and a nested path modifying that tree are specified, it will overwrite the contents of that tree with the new path contents and write a new tree out.", + "operationId": "git-create-tree", + "tags": [ + "git" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/git/trees/#create-a-tree" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "tree": { + "description": "Objects (of `path`, `mode`, `type`, and `sha`) specifying a tree structure.", + "type": "array", + "items": { + "type": "object", + "properties": { + "path": { + "description": "The file referenced in the tree.", + "type": "string" + }, + "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.", + "type": "string", + "enum": [ + "100644", + "100755", + "040000", + "160000", + "120000" + ] + }, + "type": { + "description": "Either `blob`, `tree`, or `commit`.", + "type": "string", + "enum": [ + "blob", + "tree", + "commit" + ] + }, + "sha": { + "description": "The SHA1 checksum ID of the object in the tree. Also called `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.", + "type": "string" + }, + "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.", + "type": "string" + } + } + } + }, + "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.", + "type": "string" + } + }, + "required": [ + "tree" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "sha": { + "type": "string" + }, + "url": { + "type": "string" + }, + "tree": { + "type": "array", + "items": { + "type": "object", + "properties": { + "path": { + "type": "string" + }, + "mode": { + "type": "string" + }, + "type": { + "type": "string" + }, + "size": { + "type": "number" + }, + "sha": { + "type": "string" + }, + "url": { + "type": "string" + } + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/git/trees \\\n -d '{\"tree\":\"tree\"}'" + }, + { + "lang": "JS", + "source": "octokit.git.get({\n owner: 'octocat',\n repo: 'hello-world',\n tree: 'tree'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/git/delete-ref.json b/openapi/ghe-2.14/operations/git/delete-ref.json new file mode 100644 index 0000000000..c886ab7c86 --- /dev/null +++ b/openapi/ghe-2.14/operations/git/delete-ref.json @@ -0,0 +1,71 @@ +{ + "summary": "Delete a reference", + "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```", + "operationId": "git-delete-ref", + "tags": [ + "git" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/git/refs/#delete-a-reference" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "ref", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "ref parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/git/refs/:ref" + }, + { + "lang": "JS", + "source": "octokit.git.get({\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/git/get-blob.json b/openapi/ghe-2.14/operations/git/get-blob.json new file mode 100644 index 0000000000..3512d984e3 --- /dev/null +++ b/openapi/ghe-2.14/operations/git/get-blob.json @@ -0,0 +1,94 @@ +{ + "summary": "Get a blob", + "description": "The `content` in the response will always be Base64 encoded.\n\n_Note_: This API supports blobs up to 100 megabytes in size.", + "operationId": "git-get-blob", + "tags": [ + "git" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/git/blobs/#get-a-blob" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "file_sha", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "file_sha parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "content": { + "type": "string" + }, + "encoding": { + "type": "string" + }, + "url": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "size": { + "type": "number" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/git/blobs/:file_sha" + }, + { + "lang": "JS", + "source": "octokit.git.get({\n owner: 'octocat',\n repo: 'hello-world',\n file_sha: 'file_sha'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/git/get-commit.json b/openapi/ghe-2.14/operations/git/get-commit.json new file mode 100644 index 0000000000..18b92967c5 --- /dev/null +++ b/openapi/ghe-2.14/operations/git/get-commit.json @@ -0,0 +1,158 @@ +{ + "summary": "Get a commit", + "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. |", + "operationId": "git-get-commit", + "tags": [ + "git" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/git/commits/#get-a-commit" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "commit_sha", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "commit_sha parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "sha": { + "type": "string" + }, + "url": { + "type": "string" + }, + "author": { + "type": "object", + "properties": { + "date": { + "type": "string" + }, + "name": { + "type": "string" + }, + "email": { + "type": "string" + } + } + }, + "committer": { + "type": "object", + "properties": { + "date": { + "type": "string" + }, + "name": { + "type": "string" + }, + "email": { + "type": "string" + } + } + }, + "message": { + "type": "string" + }, + "tree": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "sha": { + "type": "string" + } + } + }, + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "sha": { + "type": "string" + } + } + } + }, + "verification": { + "type": "object", + "properties": { + "verified": { + "type": "boolean" + }, + "reason": { + "type": "string" + }, + "signature": { + "type": "string" + }, + "payload": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/git/commits/:commit_sha" + }, + { + "lang": "JS", + "source": "octokit.git.get({\n owner: 'octocat',\n repo: 'hello-world',\n commit_sha: 'commit_sha'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/git/get-ref.json b/openapi/ghe-2.14/operations/git/get-ref.json new file mode 100644 index 0000000000..a2be26bae4 --- /dev/null +++ b/openapi/ghe-2.14/operations/git/get-ref.json @@ -0,0 +1,71 @@ +{ + "summary": "Get a reference", + "description": "Returns a branch or tag reference. Other than the [REST API](https://developer.github.com/v3/git/refs/#get-a-reference) it always returns a single reference. If the REST API returns with an array then the method responds with an error.", + "operationId": "git-get-ref", + "tags": [ + "git" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/git/refs/#get-a-reference" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "ref", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "Must be formatted as `heads/branch`, not just `branch`" + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/git/refs/:ref" + }, + { + "lang": "JS", + "source": "octokit.git.get({\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/git/get-tag.json b/openapi/ghe-2.14/operations/git/get-tag.json new file mode 100644 index 0000000000..f8aabb596a --- /dev/null +++ b/openapi/ghe-2.14/operations/git/get-tag.json @@ -0,0 +1,139 @@ +{ + "summary": "Get a tag", + "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. |", + "operationId": "git-get-tag", + "tags": [ + "git" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/git/tags/#get-a-tag" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "tag_sha", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "tag_sha parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "node_id": { + "type": "string" + }, + "tag": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "url": { + "type": "string" + }, + "message": { + "type": "string" + }, + "tagger": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "email": { + "type": "string" + }, + "date": { + "type": "string" + } + } + }, + "object": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "url": { + "type": "string" + } + } + }, + "verification": { + "type": "object", + "properties": { + "verified": { + "type": "boolean" + }, + "reason": { + "type": "string" + }, + "signature": { + "type": "string" + }, + "payload": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/git/tags/:tag_sha" + }, + { + "lang": "JS", + "source": "octokit.git.get({\n owner: 'octocat',\n repo: 'hello-world',\n tag_sha: 'tag_sha'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/git/get-tree.json b/openapi/ghe-2.14/operations/git/get-tree.json new file mode 100644 index 0000000000..8c17de3589 --- /dev/null +++ b/openapi/ghe-2.14/operations/git/get-tree.json @@ -0,0 +1,82 @@ +{ + "summary": "Get a tree", + "description": "If `truncated` in the response is `true`, the number of items in the `tree` array exceeded our maximum limit. If you need to fetch more items, omit the `recursive` parameter, and fetch one sub-tree at a time. If you need to fetch even more items, you can clone the repository and iterate over the Git data locally.", + "operationId": "git-get-tree", + "tags": [ + "git" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/git/trees/#get-a-tree" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "tree_sha", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "tree_sha parameter" + }, + { + "name": "recursive", + "in": "query", + "schema": { + "type": "integer", + "enum": [ + 1 + ] + }, + "description": "recursive parameter" + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/git/trees/:tree_sha" + }, + { + "lang": "JS", + "source": "octokit.git.get({\n owner: 'octocat',\n repo: 'hello-world',\n tree_sha: 'tree_sha'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/git/update-ref.json b/openapi/ghe-2.14/operations/git/update-ref.json new file mode 100644 index 0000000000..fdcc01c1c3 --- /dev/null +++ b/openapi/ghe-2.14/operations/git/update-ref.json @@ -0,0 +1,125 @@ +{ + "summary": "Update a reference", + "description": "", + "operationId": "git-update-ref", + "tags": [ + "git" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/git/refs/#update-a-reference" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "ref", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "ref parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "sha": { + "description": "The SHA1 value to set this reference to", + "type": "string" + }, + "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.", + "type": "boolean", + "default": false + } + }, + "required": [ + "sha" + ] + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "ref": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "object": { + "type": "object", + "properties": { + "type": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "url": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPATCH \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/git/refs/:ref \\\n -d '{\"sha\":\"sha\"}'" + }, + { + "lang": "JS", + "source": "octokit.git.get({\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref',\n sha: 'sha'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/gitignore/get-template.json b/openapi/ghe-2.14/operations/gitignore/get-template.json new file mode 100644 index 0000000000..4948803044 --- /dev/null +++ b/openapi/ghe-2.14/operations/gitignore/get-template.json @@ -0,0 +1,67 @@ +{ + "summary": "Get a single template", + "description": "The API also allows fetching the source of a single template.\n\nUse the raw [media type](https://developer.github.com/enterprise/2.14/v3/media/) to get the raw contents.\n\n", + "operationId": "gitignore-get-template", + "tags": [ + "gitignore" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/gitignore/#get-a-single-template" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "name", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "name parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "type": "string" + }, + "source": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/gitignore/templates/" + }, + { + "lang": "JS", + "source": "octokit.gitignore.get({\n name: 'name'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/gitignore/list-templates.json b/openapi/ghe-2.14/operations/gitignore/list-templates.json new file mode 100644 index 0000000000..84c3a0907c --- /dev/null +++ b/openapi/ghe-2.14/operations/gitignore/list-templates.json @@ -0,0 +1,49 @@ +{ + "summary": "Listing available templates", + "description": "List all templates available to pass as an option when [creating a repository](https://developer.github.com/enterprise/2.14/v3/repos/#create).", + "operationId": "gitignore-list-templates", + "tags": [ + "gitignore" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/gitignore/#listing-available-templates" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/gitignore/templates" + }, + { + "lang": "JS", + "source": "octokit.gitignore.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/issues/add-assignees.json b/openapi/ghe-2.14/operations/issues/add-assignees.json new file mode 100644 index 0000000000..0985919b55 --- /dev/null +++ b/openapi/ghe-2.14/operations/issues/add-assignees.json @@ -0,0 +1,516 @@ +{ + "summary": "Add assignees to an issue", + "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.", + "operationId": "issues-add-assignees", + "tags": [ + "issues" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/issues/assignees/#add-assignees-to-an-issue" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "issue_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "issue_number parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "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._", + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repository_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "number": { + "type": "number" + }, + "state": { + "type": "string" + }, + "title": { + "type": "string" + }, + "body": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "color": { + "type": "string" + }, + "default": { + "type": "boolean" + } + } + } + }, + "assignee": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "assignees": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + }, + "required": [ + "login", + "id", + "node_id", + "avatar_url", + "gravatar_id", + "url", + "html_url", + "followers_url", + "following_url", + "gists_url", + "starred_url", + "subscriptions_url", + "organizations_url", + "repos_url", + "events_url", + "received_events_url", + "type", + "site_admin" + ] + } + }, + "milestone": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "number" + }, + "state": { + "type": "string" + }, + "title": { + "type": "string" + }, + "description": { + "type": "string" + }, + "creator": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "open_issues": { + "type": "number" + }, + "closed_issues": { + "type": "number" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "closed_at": { + "type": "string" + }, + "due_on": { + "type": "string" + } + } + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": "string" + }, + "comments": { + "type": "number" + }, + "pull_request": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "diff_url": { + "type": "string" + }, + "patch_url": { + "type": "string" + } + } + }, + "closed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/issues/:issue_number/assignees" + }, + { + "lang": "JS", + "source": "octokit.issues.get({\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 1\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-04-10", + "note": "\"number\" parameter renamed to \"issue_number\"", + "meta": { + "before": "number", + "after": "issue_number" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/issues/add-labels.json b/openapi/ghe-2.14/operations/issues/add-labels.json new file mode 100644 index 0000000000..c9c0681f6f --- /dev/null +++ b/openapi/ghe-2.14/operations/issues/add-labels.json @@ -0,0 +1,97 @@ +{ + "summary": "Add labels to an issue", + "description": "", + "operationId": "issues-add-labels", + "tags": [ + "issues" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/issues/labels/#add-labels-to-an-issue" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "issue_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "issue_number parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "string", + "description": "labels parameter" + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/issues/:issue_number/labels \\\n -d '{\"labels\":\"labels\"}'" + }, + { + "lang": "JS", + "source": "octokit.issues.get({\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 1,\n labels: 'labels'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false, + "requestBodyParameterName": "labels" + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-04-10", + "note": "\"number\" parameter renamed to \"issue_number\"", + "meta": { + "before": "number", + "after": "issue_number" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/issues/check-assignee.json b/openapi/ghe-2.14/operations/issues/check-assignee.json new file mode 100644 index 0000000000..513bd8b745 --- /dev/null +++ b/openapi/ghe-2.14/operations/issues/check-assignee.json @@ -0,0 +1,71 @@ +{ + "summary": "Check assignee", + "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.", + "operationId": "issues-check-assignee", + "tags": [ + "issues" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/issues/assignees/#check-assignee" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "assignee", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "assignee parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/assignees/:assignee" + }, + { + "lang": "JS", + "source": "octokit.issues.get({\n owner: 'octocat',\n repo: 'hello-world',\n assignee: 'assignee'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/issues/create-comment.json b/openapi/ghe-2.14/operations/issues/create-comment.json new file mode 100644 index 0000000000..8f89267392 --- /dev/null +++ b/openapi/ghe-2.14/operations/issues/create-comment.json @@ -0,0 +1,187 @@ +{ + "summary": "Create a comment", + "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/enterprise/2.14/v3/#abuse-rate-limits)\" for details.", + "operationId": "issues-create-comment", + "tags": [ + "issues" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/issues/comments/#create-a-comment" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "issue_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "issue_number parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "description": "The contents of the comment.", + "type": "string" + } + }, + "required": [ + "body" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "body": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/issues/:issue_number/comments \\\n -d '{\"body\":\"body\"}'" + }, + { + "lang": "JS", + "source": "octokit.issues.get({\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 1,\n body: 'body'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-04-10", + "note": "\"number\" parameter renamed to \"issue_number\"", + "meta": { + "before": "number", + "after": "issue_number" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/issues/create-label.json b/openapi/ghe-2.14/operations/issues/create-label.json new file mode 100644 index 0000000000..4e5f578f13 --- /dev/null +++ b/openapi/ghe-2.14/operations/issues/create-label.json @@ -0,0 +1,118 @@ +{ + "summary": "Create a label", + "description": "", + "operationId": "issues-create-label", + "tags": [ + "issues" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/issues/labels/#create-a-label" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "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/).", + "type": "string" + }, + "color": { + "description": "The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.", + "type": "string" + }, + "description": { + "description": "A short description of the label.", + "type": "string" + } + }, + "required": [ + "name", + "color" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "color": { + "type": "string" + }, + "default": { + "type": "boolean" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/labels \\\n -d '{\"name\":\"name\",\"color\":\"color\"}'" + }, + { + "lang": "JS", + "source": "octokit.issues.get({\n owner: 'octocat',\n repo: 'hello-world',\n name: 'name',\n color: 'color'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/issues/create-milestone.json b/openapi/ghe-2.14/operations/issues/create-milestone.json new file mode 100644 index 0000000000..df7e550d63 --- /dev/null +++ b/openapi/ghe-2.14/operations/issues/create-milestone.json @@ -0,0 +1,209 @@ +{ + "summary": "Create a milestone", + "description": "", + "operationId": "issues-create-milestone", + "tags": [ + "issues" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/issues/milestones/#create-a-milestone" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "state": { + "description": "The state of the milestone. Either `open` or `closed`.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "description": { + "description": "A description of the milestone.", + "type": "string" + }, + "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`.", + "type": "string" + } + }, + "required": [ + "title" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "number" + }, + "state": { + "type": "string" + }, + "title": { + "type": "string" + }, + "description": { + "type": "string" + }, + "creator": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "open_issues": { + "type": "number" + }, + "closed_issues": { + "type": "number" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "closed_at": { + "type": "string" + }, + "due_on": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/milestones \\\n -d '{\"title\":\"title\"}'" + }, + { + "lang": "JS", + "source": "octokit.issues.get({\n owner: 'octocat',\n repo: 'hello-world',\n title: 'title'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/issues/create.json b/openapi/ghe-2.14/operations/issues/create.json new file mode 100644 index 0000000000..8e016d7800 --- /dev/null +++ b/openapi/ghe-2.14/operations/issues/create.json @@ -0,0 +1,562 @@ +{ + "summary": "Create an issue", + "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/enterprise/2.14/v3/#abuse-rate-limits)\" for details.", + "operationId": "issues-create", + "tags": [ + "issues" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/issues/#create-an-issue" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "description": "The title of the issue.", + "type": "string" + }, + "body": { + "description": "The contents of the issue.", + "type": "string" + }, + "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.**_", + "type": "string" + }, + "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._", + "type": "integer" + }, + "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._", + "type": "array", + "items": { + "type": "string" + } + }, + "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._", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "title" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repository_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "number": { + "type": "number" + }, + "state": { + "type": "string" + }, + "title": { + "type": "string" + }, + "body": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "color": { + "type": "string" + }, + "default": { + "type": "boolean" + } + } + } + }, + "assignee": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "assignees": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + }, + "milestone": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "number" + }, + "state": { + "type": "string" + }, + "title": { + "type": "string" + }, + "description": { + "type": "string" + }, + "creator": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "open_issues": { + "type": "number" + }, + "closed_issues": { + "type": "number" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "closed_at": { + "type": "string" + }, + "due_on": { + "type": "string" + } + } + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": "string" + }, + "comments": { + "type": "number" + }, + "pull_request": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "diff_url": { + "type": "string" + }, + "patch_url": { + "type": "string" + } + } + }, + "closed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "closed_by": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/issues \\\n -d '{\"title\":\"title\"}'" + }, + { + "lang": "JS", + "source": "octokit.issues.get({\n owner: 'octocat',\n repo: 'hello-world',\n title: 'title'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/issues/delete-comment.json b/openapi/ghe-2.14/operations/issues/delete-comment.json new file mode 100644 index 0000000000..5eb4e53508 --- /dev/null +++ b/openapi/ghe-2.14/operations/issues/delete-comment.json @@ -0,0 +1,71 @@ +{ + "summary": "Delete a comment", + "description": "", + "operationId": "issues-delete-comment", + "tags": [ + "issues" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/issues/comments/#delete-a-comment" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "comment_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "comment_id parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/issues/comments/:comment_id" + }, + { + "lang": "JS", + "source": "octokit.issues.get({\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 'comment_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/issues/delete-label.json b/openapi/ghe-2.14/operations/issues/delete-label.json new file mode 100644 index 0000000000..4a8fb195bf --- /dev/null +++ b/openapi/ghe-2.14/operations/issues/delete-label.json @@ -0,0 +1,71 @@ +{ + "summary": "Delete a label", + "description": "", + "operationId": "issues-delete-label", + "tags": [ + "issues" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/issues/labels/#delete-a-label" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "name", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "name parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/labels/:name" + }, + { + "lang": "JS", + "source": "octokit.issues.get({\n owner: 'octocat',\n repo: 'hello-world',\n name: 'name'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/issues/delete-milestone.json b/openapi/ghe-2.14/operations/issues/delete-milestone.json new file mode 100644 index 0000000000..0bc7dfa9be --- /dev/null +++ b/openapi/ghe-2.14/operations/issues/delete-milestone.json @@ -0,0 +1,81 @@ +{ + "summary": "Delete a milestone", + "description": "", + "operationId": "issues-delete-milestone", + "tags": [ + "issues" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/issues/milestones/#delete-a-milestone" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "milestone_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "milestone_number parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/milestones/:milestone_number" + }, + { + "lang": "JS", + "source": "octokit.issues.get({\n owner: 'octocat',\n repo: 'hello-world',\n milestone_number: 'milestone_number'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-04-10", + "note": "\"number\" parameter renamed to \"milestone_number\"", + "meta": { + "before": "number", + "after": "milestone_number" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/issues/get-comment.json b/openapi/ghe-2.14/operations/issues/get-comment.json new file mode 100644 index 0000000000..1b68af14f4 --- /dev/null +++ b/openapi/ghe-2.14/operations/issues/get-comment.json @@ -0,0 +1,179 @@ +{ + "summary": "Get a single comment", + "description": "", + "operationId": "issues-get-comment", + "tags": [ + "issues" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/issues/comments/#get-a-single-comment" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "comment_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "comment_id parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "body": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/issues/comments/:comment_id" + }, + { + "lang": "JS", + "source": "octokit.issues.get({\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 'comment_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/issues/get-event.json b/openapi/ghe-2.14/operations/issues/get-event.json new file mode 100644 index 0000000000..f7a2358ca6 --- /dev/null +++ b/openapi/ghe-2.14/operations/issues/get-event.json @@ -0,0 +1,553 @@ +{ + "summary": "Get a single event", + "description": "", + "operationId": "issues-get-event", + "tags": [ + "issues" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/issues/events/#get-a-single-event" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "event_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "event_id parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "actor": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "event": { + "type": "string" + }, + "commit_id": { + "type": "string" + }, + "commit_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "issue": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repository_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "number": { + "type": "number" + }, + "state": { + "type": "string" + }, + "title": { + "type": "string" + }, + "body": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "color": { + "type": "string" + }, + "default": { + "type": "boolean" + } + } + } + }, + "assignee": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "assignees": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + }, + "milestone": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "number" + }, + "state": { + "type": "string" + }, + "title": { + "type": "string" + }, + "description": { + "type": "string" + }, + "creator": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "open_issues": { + "type": "number" + }, + "closed_issues": { + "type": "number" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "closed_at": { + "type": "string" + }, + "due_on": { + "type": "string" + } + } + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": "string" + }, + "comments": { + "type": "number" + }, + "pull_request": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "diff_url": { + "type": "string" + }, + "patch_url": { + "type": "string" + } + } + }, + "closed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/issues/events/:event_id" + }, + { + "lang": "JS", + "source": "octokit.issues.get({\n owner: 'octocat',\n repo: 'hello-world',\n event_id: 'event_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/issues/get-label.json b/openapi/ghe-2.14/operations/issues/get-label.json new file mode 100644 index 0000000000..f46ec2ebd5 --- /dev/null +++ b/openapi/ghe-2.14/operations/issues/get-label.json @@ -0,0 +1,100 @@ +{ + "summary": "Get a single label", + "description": "", + "operationId": "issues-get-label", + "tags": [ + "issues" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/issues/labels/#get-a-single-label" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "name", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "name parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "color": { + "type": "string" + }, + "default": { + "type": "boolean" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/labels/:name" + }, + { + "lang": "JS", + "source": "octokit.issues.get({\n owner: 'octocat',\n repo: 'hello-world',\n name: 'name'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/issues/get-milestone.json b/openapi/ghe-2.14/operations/issues/get-milestone.json new file mode 100644 index 0000000000..58604cfecf --- /dev/null +++ b/openapi/ghe-2.14/operations/issues/get-milestone.json @@ -0,0 +1,193 @@ +{ + "summary": "Get a single milestone", + "description": "", + "operationId": "issues-get-milestone", + "tags": [ + "issues" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/issues/milestones/#get-a-single-milestone" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "milestone_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "milestone_number parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "number" + }, + "state": { + "type": "string" + }, + "title": { + "type": "string" + }, + "description": { + "type": "string" + }, + "creator": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "open_issues": { + "type": "number" + }, + "closed_issues": { + "type": "number" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "closed_at": { + "type": "string" + }, + "due_on": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/milestones/:milestone_number" + }, + { + "lang": "JS", + "source": "octokit.issues.get({\n owner: 'octocat',\n repo: 'hello-world',\n milestone_number: 'milestone_number'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-04-10", + "note": "\"number\" parameter renamed to \"milestone_number\"", + "meta": { + "before": "number", + "after": "milestone_number" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/issues/get.json b/openapi/ghe-2.14/operations/issues/get.json new file mode 100644 index 0000000000..64ab934d81 --- /dev/null +++ b/openapi/ghe-2.14/operations/issues/get.json @@ -0,0 +1,537 @@ +{ + "summary": "Get a single issue", + "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/enterprise/2.14/v3/pulls/#list-pull-requests)\" endpoint.", + "operationId": "issues-get", + "tags": [ + "issues" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/issues/#get-a-single-issue" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "issue_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "issue_number parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repository_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "number": { + "type": "number" + }, + "state": { + "type": "string" + }, + "title": { + "type": "string" + }, + "body": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "color": { + "type": "string" + }, + "default": { + "type": "boolean" + } + } + } + }, + "assignee": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "assignees": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + }, + "milestone": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "number" + }, + "state": { + "type": "string" + }, + "title": { + "type": "string" + }, + "description": { + "type": "string" + }, + "creator": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "open_issues": { + "type": "number" + }, + "closed_issues": { + "type": "number" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "closed_at": { + "type": "string" + }, + "due_on": { + "type": "string" + } + } + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": "string" + }, + "comments": { + "type": "number" + }, + "pull_request": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "diff_url": { + "type": "string" + }, + "patch_url": { + "type": "string" + } + } + }, + "closed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "closed_by": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/issues/:issue_number" + }, + { + "lang": "JS", + "source": "octokit.issues.get({\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 1\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-04-10", + "note": "\"number\" parameter renamed to \"issue_number\"", + "meta": { + "before": "number", + "after": "issue_number" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/issues/list-assignees.json b/openapi/ghe-2.14/operations/issues/list-assignees.json new file mode 100644 index 0000000000..676f89652d --- /dev/null +++ b/openapi/ghe-2.14/operations/issues/list-assignees.json @@ -0,0 +1,87 @@ +{ + "summary": "List assignees", + "description": "Lists the [available assignees](https://help.github.com/articles/assigning-issues-and-pull-requests-to-other-github-users/) for issues in a repository.", + "operationId": "issues-list-assignees", + "tags": [ + "issues" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/issues/assignees/#list-assignees" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/assignees" + }, + { + "lang": "JS", + "source": "octokit.issues.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/issues/list-comments-for-repo.json b/openapi/ghe-2.14/operations/issues/list-comments-for-repo.json new file mode 100644 index 0000000000..2ba82fa88f --- /dev/null +++ b/openapi/ghe-2.14/operations/issues/list-comments-for-repo.json @@ -0,0 +1,103 @@ +{ + "summary": "List comments in a repository", + "description": "By default, Issue Comments are ordered by ascending ID.", + "operationId": "issues-list-comments-for-repo", + "tags": [ + "issues" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/issues/comments/#list-comments-in-a-repository" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "created", + "updated" + ], + "default": "created" + }, + "required": false, + "description": "Either `created` or `updated`." + }, + { + "name": "direction", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ] + }, + "required": false, + "description": "Either `asc` or `desc`. Ignored without the `sort` parameter." + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "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`." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/issues/comments" + }, + { + "lang": "JS", + "source": "octokit.issues.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/issues/list-comments.json b/openapi/ghe-2.14/operations/issues/list-comments.json new file mode 100644 index 0000000000..b307f31e41 --- /dev/null +++ b/openapi/ghe-2.14/operations/issues/list-comments.json @@ -0,0 +1,115 @@ +{ + "summary": "List comments on an issue", + "description": "Issue Comments are ordered by ascending ID.", + "operationId": "issues-list-comments", + "tags": [ + "issues" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/issues/comments/#list-comments-on-an-issue" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "issue_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "issue_number parameter" + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "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`." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/issues/:issue_number/comments" + }, + { + "lang": "JS", + "source": "octokit.issues.get({\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 1\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-04-10", + "note": "\"number\" parameter renamed to \"issue_number\"", + "meta": { + "before": "number", + "after": "issue_number" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/issues/list-events-for-repo.json b/openapi/ghe-2.14/operations/issues/list-events-for-repo.json new file mode 100644 index 0000000000..343f336b79 --- /dev/null +++ b/openapi/ghe-2.14/operations/issues/list-events-for-repo.json @@ -0,0 +1,87 @@ +{ + "summary": "List events for a repository", + "description": "", + "operationId": "issues-list-events-for-repo", + "tags": [ + "issues" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/issues/events/#list-events-for-a-repository" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/issues/events" + }, + { + "lang": "JS", + "source": "octokit.issues.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/issues/list-events-for-timeline.json b/openapi/ghe-2.14/operations/issues/list-events-for-timeline.json new file mode 100644 index 0000000000..9a8488428e --- /dev/null +++ b/openapi/ghe-2.14/operations/issues/list-events-for-timeline.json @@ -0,0 +1,107 @@ +{ + "summary": "List events for an issue", + "description": "", + "operationId": "issues-list-events-for-timeline", + "tags": [ + "issues" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/issues/timeline/#list-events-for-an-issue" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.mockingbird-preview+json" + }, + "required": true + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "issue_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "issue_number parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.mockingbird-preview+json\" \\\n https://developer.github.com/repos/octocat/:repo/issues/:issue_number/timeline" + }, + { + "lang": "JS", + "source": "octokit.issues.get({\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 1\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-04-10", + "note": "\"number\" parameter renamed to \"issue_number\"", + "meta": { + "before": "number", + "after": "issue_number" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/issues/list-events.json b/openapi/ghe-2.14/operations/issues/list-events.json new file mode 100644 index 0000000000..e934af46dd --- /dev/null +++ b/openapi/ghe-2.14/operations/issues/list-events.json @@ -0,0 +1,106 @@ +{ + "summary": "List events for an issue", + "description": "", + "operationId": "issues-list-events", + "tags": [ + "issues" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/issues/events/#list-events-for-an-issue" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "issue_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "issue_number parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/issues/:issue_number/events" + }, + { + "lang": "JS", + "source": "octokit.issues.get({\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 1\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-04-10", + "note": "\"number\" parameter renamed to \"issue_number\"", + "meta": { + "before": "number", + "after": "issue_number" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/issues/list-for-authenticated-user.json b/openapi/ghe-2.14/operations/issues/list-for-authenticated-user.json new file mode 100644 index 0000000000..d3eba2f477 --- /dev/null +++ b/openapi/ghe-2.14/operations/issues/list-for-authenticated-user.json @@ -0,0 +1,148 @@ +{ + "summary": "List all issues across owned and member repositories assigned to the authenticated user", + "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/enterprise/2.14/v3/pulls/#list-pull-requests)\" endpoint.", + "operationId": "issues-list-for-authenticated-user", + "tags": [ + "issues" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/issues/#list-issues" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "filter", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "assigned", + "created", + "mentioned", + "subscribed", + "all" + ], + "default": "assigned" + }, + "required": false, + "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" + }, + { + "name": "state", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "open", + "closed", + "all" + ], + "default": "open" + }, + "required": false, + "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`." + }, + { + "name": "labels", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "description": "A list of comma separated label names. Example: `bug,ui,@high`" + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "comments" + ], + "default": "created" + }, + "required": false, + "description": "What to sort results by. Can be either `created`, `updated`, `comments`." + }, + { + "name": "direction", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "required": false, + "description": "The direction of the sort. Can be either `asc` or `desc`." + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "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": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/user/issues" + }, + { + "lang": "JS", + "source": "octokit.issues.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/issues/list-for-org.json b/openapi/ghe-2.14/operations/issues/list-for-org.json new file mode 100644 index 0000000000..8c1a2f7d3d --- /dev/null +++ b/openapi/ghe-2.14/operations/issues/list-for-org.json @@ -0,0 +1,157 @@ +{ + "summary": "List all issues for a given organization assigned to the authenticated user", + "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/enterprise/2.14/v3/pulls/#list-pull-requests)\" endpoint.", + "operationId": "issues-list-for-org", + "tags": [ + "issues" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/issues/#list-issues" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "org", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "org parameter" + }, + { + "name": "filter", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "assigned", + "created", + "mentioned", + "subscribed", + "all" + ], + "default": "assigned" + }, + "required": false, + "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" + }, + { + "name": "state", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "open", + "closed", + "all" + ], + "default": "open" + }, + "required": false, + "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`." + }, + { + "name": "labels", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "description": "A list of comma separated label names. Example: `bug,ui,@high`" + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "comments" + ], + "default": "created" + }, + "required": false, + "description": "What to sort results by. Can be either `created`, `updated`, `comments`." + }, + { + "name": "direction", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "required": false, + "description": "The direction of the sort. Can be either `asc` or `desc`." + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "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": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/orgs//issues" + }, + { + "lang": "JS", + "source": "octokit.issues.get({\n org: 'org'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/issues/list-for-repo.json b/openapi/ghe-2.14/operations/issues/list-for-repo.json new file mode 100644 index 0000000000..d8c22d850f --- /dev/null +++ b/openapi/ghe-2.14/operations/issues/list-for-repo.json @@ -0,0 +1,185 @@ +{ + "summary": "List issues for a repository", + "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/enterprise/2.14/v3/pulls/#list-pull-requests)\" endpoint.", + "operationId": "issues-list-for-repo", + "tags": [ + "issues" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/issues/#list-issues-for-a-repository" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "milestone", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "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": "state", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "open", + "closed", + "all" + ], + "default": "open" + }, + "required": false, + "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`." + }, + { + "name": "assignee", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "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": "creator", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "description": "The user that created the issue." + }, + { + "name": "mentioned", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "description": "A user that's mentioned in the issue." + }, + { + "name": "labels", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "description": "A list of comma separated label names. Example: `bug,ui,@high`" + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "comments" + ], + "default": "created" + }, + "required": false, + "description": "What to sort results by. Can be either `created`, `updated`, `comments`." + }, + { + "name": "direction", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "required": false, + "description": "The direction of the sort. Can be either `asc` or `desc`." + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "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": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/issues" + }, + { + "lang": "JS", + "source": "octokit.issues.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/issues/list-labels-for-milestone.json b/openapi/ghe-2.14/operations/issues/list-labels-for-milestone.json new file mode 100644 index 0000000000..7055c49706 --- /dev/null +++ b/openapi/ghe-2.14/operations/issues/list-labels-for-milestone.json @@ -0,0 +1,106 @@ +{ + "summary": "Get labels for every issue in a milestone", + "description": "", + "operationId": "issues-list-labels-for-milestone", + "tags": [ + "issues" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/issues/labels/#get-labels-for-every-issue-in-a-milestone" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "milestone_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "milestone_number parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/milestones/:milestone_number/labels" + }, + { + "lang": "JS", + "source": "octokit.issues.get({\n owner: 'octocat',\n repo: 'hello-world',\n milestone_number: 'milestone_number'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-04-10", + "note": "\"number\" parameter renamed to \"milestone_number\"", + "meta": { + "before": "number", + "after": "milestone_number" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/issues/list-labels-for-repo.json b/openapi/ghe-2.14/operations/issues/list-labels-for-repo.json new file mode 100644 index 0000000000..209b31017c --- /dev/null +++ b/openapi/ghe-2.14/operations/issues/list-labels-for-repo.json @@ -0,0 +1,87 @@ +{ + "summary": "List all labels for this repository", + "description": "", + "operationId": "issues-list-labels-for-repo", + "tags": [ + "issues" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/issues/labels/#list-all-labels-for-this-repository" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/labels" + }, + { + "lang": "JS", + "source": "octokit.issues.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/issues/list-labels-on-issue.json b/openapi/ghe-2.14/operations/issues/list-labels-on-issue.json new file mode 100644 index 0000000000..6068f1793e --- /dev/null +++ b/openapi/ghe-2.14/operations/issues/list-labels-on-issue.json @@ -0,0 +1,106 @@ +{ + "summary": "List labels on an issue", + "description": "", + "operationId": "issues-list-labels-on-issue", + "tags": [ + "issues" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/issues/labels/#list-labels-on-an-issue" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "issue_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "issue_number parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/issues/:issue_number/labels" + }, + { + "lang": "JS", + "source": "octokit.issues.get({\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 1\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-04-10", + "note": "\"number\" parameter renamed to \"issue_number\"", + "meta": { + "before": "number", + "after": "issue_number" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/issues/list-milestones-for-repo.json b/openapi/ghe-2.14/operations/issues/list-milestones-for-repo.json new file mode 100644 index 0000000000..9d4f2899f3 --- /dev/null +++ b/openapi/ghe-2.14/operations/issues/list-milestones-for-repo.json @@ -0,0 +1,130 @@ +{ + "summary": "List milestones for a repository", + "description": "", + "operationId": "issues-list-milestones-for-repo", + "tags": [ + "issues" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/issues/milestones/#list-milestones-for-a-repository" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "state", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "open", + "closed", + "all" + ], + "default": "open" + }, + "required": false, + "description": "The state of the milestone. Either `open`, `closed`, or `all`." + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "due_on", + "completeness" + ], + "default": "due_on" + }, + "required": false, + "description": "What to sort results by. Either `due_on` or `completeness`." + }, + { + "name": "direction", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "asc" + }, + "required": false, + "description": "The direction of the sort. Either `asc` or `desc`." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/milestones" + }, + { + "lang": "JS", + "source": "octokit.issues.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/issues/list.json b/openapi/ghe-2.14/operations/issues/list.json new file mode 100644 index 0000000000..bc4b421c73 --- /dev/null +++ b/openapi/ghe-2.14/operations/issues/list.json @@ -0,0 +1,148 @@ +{ + "summary": "List all issues assigned to the authenticated user across all visible repositories including owned repositories, member repositories, and organization repositories", + "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/enterprise/2.14/v3/pulls/#list-pull-requests)\" endpoint.", + "operationId": "issues-list", + "tags": [ + "issues" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/issues/#list-issues" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "filter", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "assigned", + "created", + "mentioned", + "subscribed", + "all" + ], + "default": "assigned" + }, + "required": false, + "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" + }, + { + "name": "state", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "open", + "closed", + "all" + ], + "default": "open" + }, + "required": false, + "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`." + }, + { + "name": "labels", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "description": "A list of comma separated label names. Example: `bug,ui,@high`" + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "comments" + ], + "default": "created" + }, + "required": false, + "description": "What to sort results by. Can be either `created`, `updated`, `comments`." + }, + { + "name": "direction", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "required": false, + "description": "The direction of the sort. Can be either `asc` or `desc`." + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "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": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/issues" + }, + { + "lang": "JS", + "source": "octokit.issues.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/issues/lock.json b/openapi/ghe-2.14/operations/issues/lock.json new file mode 100644 index 0000000000..76f1fe6853 --- /dev/null +++ b/openapi/ghe-2.14/operations/issues/lock.json @@ -0,0 +1,102 @@ +{ + "summary": "Lock an issue", + "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/enterprise/2.14/v3/#http-verbs).\"", + "operationId": "issues-lock", + "tags": [ + "issues" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/issues/#lock-an-issue" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "issue_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "issue_number parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "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`", + "type": "string", + "enum": [ + "off-topic", + "too heated", + "resolved", + "spam" + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPUT \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/issues/:issue_number/lock" + }, + { + "lang": "JS", + "source": "octokit.issues.get({\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 1\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-04-10", + "note": "\"number\" parameter renamed to \"issue_number\"", + "meta": { + "before": "number", + "after": "issue_number" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/issues/remove-assignees.json b/openapi/ghe-2.14/operations/issues/remove-assignees.json new file mode 100644 index 0000000000..2aa5591833 --- /dev/null +++ b/openapi/ghe-2.14/operations/issues/remove-assignees.json @@ -0,0 +1,496 @@ +{ + "summary": "Remove assignees from an issue", + "description": "Removes one or more assignees from an issue.\n\nThis example removes two of three assignees, leaving the `octocat` assignee.", + "operationId": "issues-remove-assignees", + "tags": [ + "issues" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/issues/assignees/#remove-assignees-from-an-issue" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "issue_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "issue_number parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "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._", + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repository_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "number": { + "type": "number" + }, + "state": { + "type": "string" + }, + "title": { + "type": "string" + }, + "body": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "color": { + "type": "string" + }, + "default": { + "type": "boolean" + } + } + } + }, + "assignee": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "assignees": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + }, + "milestone": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "number" + }, + "state": { + "type": "string" + }, + "title": { + "type": "string" + }, + "description": { + "type": "string" + }, + "creator": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "open_issues": { + "type": "number" + }, + "closed_issues": { + "type": "number" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "closed_at": { + "type": "string" + }, + "due_on": { + "type": "string" + } + } + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": "string" + }, + "comments": { + "type": "number" + }, + "pull_request": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "diff_url": { + "type": "string" + }, + "patch_url": { + "type": "string" + } + } + }, + "closed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/issues/:issue_number/assignees" + }, + { + "lang": "JS", + "source": "octokit.issues.get({\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 1\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-04-10", + "note": "\"number\" parameter renamed to \"issue_number\"", + "meta": { + "before": "number", + "after": "issue_number" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/issues/remove-label.json b/openapi/ghe-2.14/operations/issues/remove-label.json new file mode 100644 index 0000000000..2fa78d0478 --- /dev/null +++ b/openapi/ghe-2.14/operations/issues/remove-label.json @@ -0,0 +1,95 @@ +{ + "summary": "Remove a label from an issue", + "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.", + "operationId": "issues-remove-label", + "tags": [ + "issues" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/issues/labels/#remove-a-label-from-an-issue" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "issue_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "issue_number parameter" + }, + { + "name": "name", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "name parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/issues/:issue_number/labels/:name" + }, + { + "lang": "JS", + "source": "octokit.issues.get({\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 1,\n name: 'name'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-04-10", + "note": "\"number\" parameter renamed to \"issue_number\"", + "meta": { + "before": "number", + "after": "issue_number" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/issues/remove-labels.json b/openapi/ghe-2.14/operations/issues/remove-labels.json new file mode 100644 index 0000000000..ee6f8b1db3 --- /dev/null +++ b/openapi/ghe-2.14/operations/issues/remove-labels.json @@ -0,0 +1,81 @@ +{ + "summary": "Remove all labels from an issue", + "description": "", + "operationId": "issues-remove-labels", + "tags": [ + "issues" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/issues/labels/#remove-all-labels-from-an-issue" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "issue_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "issue_number parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/issues/:issue_number/labels" + }, + { + "lang": "JS", + "source": "octokit.issues.get({\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 1\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-04-10", + "note": "\"number\" parameter renamed to \"issue_number\"", + "meta": { + "before": "number", + "after": "issue_number" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/issues/replace-labels.json b/openapi/ghe-2.14/operations/issues/replace-labels.json new file mode 100644 index 0000000000..3cc55e4798 --- /dev/null +++ b/openapi/ghe-2.14/operations/issues/replace-labels.json @@ -0,0 +1,97 @@ +{ + "summary": "Replace all labels for an issue", + "description": "Sending an empty array (`[]`) will remove all labels from the issue.", + "operationId": "issues-replace-labels", + "tags": [ + "issues" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/issues/labels/#replace-all-labels-for-an-issue" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "issue_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "issue_number parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "string", + "description": "labels parameter" + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPUT \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/issues/:issue_number/labels \\\n -d '{\"labels\":\"labels\"}'" + }, + { + "lang": "JS", + "source": "octokit.issues.get({\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 1,\n labels: 'labels'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false, + "requestBodyParameterName": "labels" + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-04-10", + "note": "\"number\" parameter renamed to \"issue_number\"", + "meta": { + "before": "number", + "after": "issue_number" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/issues/unlock.json b/openapi/ghe-2.14/operations/issues/unlock.json new file mode 100644 index 0000000000..bee67f5a0c --- /dev/null +++ b/openapi/ghe-2.14/operations/issues/unlock.json @@ -0,0 +1,81 @@ +{ + "summary": "Unlock an issue", + "description": "Users with push access can unlock an issue's conversation.", + "operationId": "issues-unlock", + "tags": [ + "issues" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/issues/#unlock-an-issue" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "issue_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "issue_number parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/issues/:issue_number/lock" + }, + { + "lang": "JS", + "source": "octokit.issues.get({\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 1\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-04-10", + "note": "\"number\" parameter renamed to \"issue_number\"", + "meta": { + "before": "number", + "after": "issue_number" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/issues/update-comment.json b/openapi/ghe-2.14/operations/issues/update-comment.json new file mode 100644 index 0000000000..1e58347e47 --- /dev/null +++ b/openapi/ghe-2.14/operations/issues/update-comment.json @@ -0,0 +1,177 @@ +{ + "summary": "Edit a comment", + "description": "", + "operationId": "issues-update-comment", + "tags": [ + "issues" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/issues/comments/#edit-a-comment" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "comment_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "comment_id parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "description": "The contents of the comment.", + "type": "string" + } + }, + "required": [ + "body" + ] + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "body": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPATCH \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/issues/comments/:comment_id \\\n -d '{\"body\":\"body\"}'" + }, + { + "lang": "JS", + "source": "octokit.issues.get({\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 'comment_id',\n body: 'body'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/issues/update-milestone.json b/openapi/ghe-2.14/operations/issues/update-milestone.json new file mode 100644 index 0000000000..b8d43d63db --- /dev/null +++ b/openapi/ghe-2.14/operations/issues/update-milestone.json @@ -0,0 +1,225 @@ +{ + "summary": "Update a milestone", + "description": "", + "operationId": "issues-update-milestone", + "tags": [ + "issues" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/issues/milestones/#update-a-milestone" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "milestone_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "milestone_number parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "description": "The title of the milestone.", + "type": "string" + }, + "state": { + "description": "The state of the milestone. Either `open` or `closed`.", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "description": { + "description": "A description of the milestone.", + "type": "string" + }, + "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`.", + "type": "string" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "number" + }, + "state": { + "type": "string" + }, + "title": { + "type": "string" + }, + "description": { + "type": "string" + }, + "creator": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "open_issues": { + "type": "number" + }, + "closed_issues": { + "type": "number" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "closed_at": { + "type": "string" + }, + "due_on": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPATCH \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/milestones/:milestone_number" + }, + { + "lang": "JS", + "source": "octokit.issues.get({\n owner: 'octocat',\n repo: 'hello-world',\n milestone_number: 'milestone_number'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-04-10", + "note": "\"number\" parameter renamed to \"milestone_number\"", + "meta": { + "before": "number", + "after": "milestone_number" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/issues/update.json b/openapi/ghe-2.14/operations/issues/update.json new file mode 100644 index 0000000000..b47d8e4f5b --- /dev/null +++ b/openapi/ghe-2.14/operations/issues/update.json @@ -0,0 +1,587 @@ +{ + "summary": "Edit an issue", + "description": "Issue owners and users with push access can edit an issue.", + "operationId": "issues-update", + "tags": [ + "issues" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/issues/#edit-an-issue" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "issue_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "issue_number parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "description": "The title of the issue.", + "type": "string" + }, + "body": { + "description": "The contents of the issue.", + "type": "string" + }, + "assignee": { + "description": "Login for the user that this issue should be assigned to. **This field is deprecated.**", + "type": "string" + }, + "state": { + "description": "State of the issue. Either `open` or `closed`.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "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._", + "type": "integer", + "nullable": true + }, + "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._", + "type": "array", + "items": { + "type": "string" + } + }, + "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._", + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repository_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "number": { + "type": "number" + }, + "state": { + "type": "string" + }, + "title": { + "type": "string" + }, + "body": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "color": { + "type": "string" + }, + "default": { + "type": "boolean" + } + } + } + }, + "assignee": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "assignees": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + }, + "milestone": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "number" + }, + "state": { + "type": "string" + }, + "title": { + "type": "string" + }, + "description": { + "type": "string" + }, + "creator": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "open_issues": { + "type": "number" + }, + "closed_issues": { + "type": "number" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "closed_at": { + "type": "string" + }, + "due_on": { + "type": "string" + } + } + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": "string" + }, + "comments": { + "type": "number" + }, + "pull_request": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "diff_url": { + "type": "string" + }, + "patch_url": { + "type": "string" + } + } + }, + "closed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "closed_by": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPATCH \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/issues/:issue_number" + }, + { + "lang": "JS", + "source": "octokit.issues.get({\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 1\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-04-10", + "note": "\"number\" parameter renamed to \"issue_number\"", + "meta": { + "before": "number", + "after": "issue_number" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/licenses/get-for-repo.json b/openapi/ghe-2.14/operations/licenses/get-for-repo.json new file mode 100644 index 0000000000..ad62c7a9bf --- /dev/null +++ b/openapi/ghe-2.14/operations/licenses/get-for-repo.json @@ -0,0 +1,137 @@ +{ + "summary": "Get the contents of a repository's license", + "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/enterprise/2.14/v3/repos/contents/#get-contents), this method also supports [custom media types](https://developer.github.com/enterprise/2.14/v3/repos/contents/#custom-media-types) for retrieving the raw license content or rendered license HTML.", + "operationId": "licenses-get-for-repo", + "tags": [ + "licenses" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/licenses/#get-the-contents-of-a-repositorys-license" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "size": { + "type": "number" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "download_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "content": { + "type": "string" + }, + "encoding": { + "type": "string" + }, + "_links": { + "type": "object", + "properties": { + "self": { + "type": "string" + }, + "git": { + "type": "string" + }, + "html": { + "type": "string" + } + } + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/license" + }, + { + "lang": "JS", + "source": "octokit.licenses.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/licenses/get.json b/openapi/ghe-2.14/operations/licenses/get.json new file mode 100644 index 0000000000..fa1b22fe3c --- /dev/null +++ b/openapi/ghe-2.14/operations/licenses/get.json @@ -0,0 +1,109 @@ +{ + "summary": "Get an individual license", + "description": "", + "operationId": "licenses-get", + "tags": [ + "licenses" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/licenses/#get-an-individual-license" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "license", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "license parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "implementation": { + "type": "string" + }, + "permissions": { + "type": "array", + "items": { + "type": "string" + } + }, + "conditions": { + "type": "array", + "items": { + "type": "string" + } + }, + "limitations": { + "type": "array", + "items": { + "type": "string" + } + }, + "body": { + "type": "string" + }, + "featured": { + "type": "boolean" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/licenses/" + }, + { + "lang": "JS", + "source": "octokit.licenses.get({\n license: 'license'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/licenses/list-commonly-used.json b/openapi/ghe-2.14/operations/licenses/list-commonly-used.json new file mode 100644 index 0000000000..251bb889b4 --- /dev/null +++ b/openapi/ghe-2.14/operations/licenses/list-commonly-used.json @@ -0,0 +1,63 @@ +{ + "summary": "List commonly used licenses", + "description": "", + "operationId": "licenses-list-commonly-used", + "tags": [ + "licenses" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/licenses/#list-commonly-used-licenses" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/licenses" + }, + { + "lang": "JS", + "source": "octokit.licenses.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "idName", + "date": "2019-03-05", + "note": "\"List all licenses\" renamed to \"List commonly used licenses\"", + "meta": { + "before": { + "idName": "list" + }, + "after": { + "idName": "list-commonly-used" + } + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/markdown/render-raw.json b/openapi/ghe-2.14/operations/markdown/render-raw.json new file mode 100644 index 0000000000..87dc796edf --- /dev/null +++ b/openapi/ghe-2.14/operations/markdown/render-raw.json @@ -0,0 +1,71 @@ +{ + "summary": "Render a Markdown document in raw mode", + "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", + "operationId": "markdown-render-raw", + "tags": [ + "markdown" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/markdown/#render-a-markdown-document-in-raw-mode" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "content-type", + "description": "Setting content-type header is required for this endpoint", + "in": "header", + "schema": { + "type": "string", + "enum": [ + "text/plain; charset=utf-8" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "string", + "description": "data parameter" + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/markdown/raw \\\n -d '{\"data\":\"data\"}'" + }, + { + "lang": "JS", + "source": "octokit.markdown.get({\n data: 'data'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false, + "requestBodyParameterName": "data" + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/markdown/render.json b/openapi/ghe-2.14/operations/markdown/render.json new file mode 100644 index 0000000000..e1692d5bc6 --- /dev/null +++ b/openapi/ghe-2.14/operations/markdown/render.json @@ -0,0 +1,80 @@ +{ + "summary": "Render an arbitrary Markdown document", + "description": "", + "operationId": "markdown-render", + "tags": [ + "markdown" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/markdown/#render-an-arbitrary-markdown-document" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "text": { + "description": "The Markdown text to render in HTML. Markdown content must be 400 KB or less.", + "type": "string" + }, + "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.", + "type": "string", + "enum": [ + "markdown", + "gfm" + ], + "default": "markdown" + }, + "context": { + "description": "The repository context to use when creating references in `gfm` mode. Omit this parameter when using `markdown` mode.", + "type": "string" + } + }, + "required": [ + "text" + ] + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/markdown \\\n -d '{\"text\":\"text\"}'" + }, + { + "lang": "JS", + "source": "octokit.markdown.get({\n text: 'text'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/meta/get.json b/openapi/ghe-2.14/operations/meta/get.json new file mode 100644 index 0000000000..36e00cd04c --- /dev/null +++ b/openapi/ghe-2.14/operations/meta/get.json @@ -0,0 +1,61 @@ +{ + "summary": "Get", + "description": "If you access this endpoint on your organization's [GitHub Enterprise](https://enterprise.github.com/) installation, this endpoint provides information about that installation.\n\n**Note:** GitHub Enterprise release 2.17 and higher will discontinue allowing admins to install new GitHub Services, and existing services will stop working in GitHub Enterprise release 2.20 and higher. You can use the [Replacing GitHub Services guide](https://developer.github.com/enterprise/2.14/v3/guides/replacing-github-services) to help you update your services to webhooks.", + "operationId": "meta-get", + "tags": [ + "meta" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/meta/#meta" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "verifiable_password_authentication": { + "type": "boolean" + }, + "installed_version": { + "type": "string" + }, + "github_services_sha": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/meta" + }, + { + "lang": "JS", + "source": "octokit.meta.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/oauth_authorizations/check-authorization.json b/openapi/ghe-2.14/operations/oauth_authorizations/check-authorization.json new file mode 100644 index 0000000000..d3057086e3 --- /dev/null +++ b/openapi/ghe-2.14/operations/oauth_authorizations/check-authorization.json @@ -0,0 +1,179 @@ +{ + "summary": "Check an authorization", + "description": "OAuth applications can use a special API method for checking OAuth token validity without running afoul of normal rate limits for failed login attempts. Authentication works differently with this particular endpoint. You must use [Basic Authentication](https://developer.github.com/enterprise/2.14/v3/auth#basic-authentication) when accessing it, where the username is the OAuth application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`.", + "operationId": "oauth_authorizations-check-authorization", + "tags": [ + "oauth_authorizations" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/oauth_authorizations/#check-an-authorization" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "client_id", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "client_id parameter" + }, + { + "name": "access_token", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "access_token parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "url": { + "type": "string" + }, + "scopes": { + "type": "array", + "items": { + "type": "string" + } + }, + "token": { + "type": "string" + }, + "token_last_eight": { + "type": "string" + }, + "hashed_token": { + "type": "string" + }, + "app": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "client_id": { + "type": "string" + } + } + }, + "note": { + "type": "string" + }, + "note_url": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "fingerprint": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/applications//tokens/:access_token" + }, + { + "lang": "JS", + "source": "octokit.oauth_authorizations.get({\n client_id: 'client_id',\n access_token: 'access_token'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/oauth_authorizations/create-authorization.json b/openapi/ghe-2.14/operations/oauth_authorizations/create-authorization.json new file mode 100644 index 0000000000..7a6a5ebfa7 --- /dev/null +++ b/openapi/ghe-2.14/operations/oauth_authorizations/create-authorization.json @@ -0,0 +1,143 @@ +{ + "summary": "Create a new authorization", + "description": "Creates OAuth tokens using [Basic Authentication](https://developer.github.com/enterprise/2.14/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 \"[Woking with two-factor authentication](https://developer.github.com/enterprise/2.14/v3/auth/#working-with-two-factor-authentication).\"\n\nYou can use this endpoint to create multiple OAuth tokens instead of implementing the [web flow](https://developer.github.com/enterprise/2.14/apps/building-oauth-apps/authorizing-oauth-apps/).\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).", + "operationId": "oauth_authorizations-create-authorization", + "tags": [ + "oauth_authorizations" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/oauth_authorizations/#create-a-new-authorization" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "scopes": { + "description": "A list of scopes that this authorization is in.", + "type": "array", + "items": { + "type": "string" + } + }, + "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.", + "type": "string" + }, + "note_url": { + "description": "A URL to remind you what app the OAuth token is for.", + "type": "string" + }, + "client_id": { + "description": "The 20 character OAuth app client key for which to create the token.", + "type": "string" + }, + "client_secret": { + "description": "The 40 character OAuth app client secret for which to create the token.", + "type": "string" + }, + "fingerprint": { + "description": "A unique string to distinguish an authorization from others created for the same client ID and user.", + "type": "string" + } + }, + "required": [ + "note" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "url": { + "type": "string" + }, + "scopes": { + "type": "array", + "items": { + "type": "string" + } + }, + "token": { + "type": "string" + }, + "token_last_eight": { + "type": "string" + }, + "hashed_token": { + "type": "string" + }, + "app": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "client_id": { + "type": "string" + } + } + }, + "note": { + "type": "string" + }, + "note_url": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "fingerprint": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/authorizations \\\n -d '{\"note\":\"note\"}'" + }, + { + "lang": "JS", + "source": "octokit.oauth_authorizations.get({\n note: 'note'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/oauth_authorizations/delete-authorization.json b/openapi/ghe-2.14/operations/oauth_authorizations/delete-authorization.json new file mode 100644 index 0000000000..e278488b78 --- /dev/null +++ b/openapi/ghe-2.14/operations/oauth_authorizations/delete-authorization.json @@ -0,0 +1,53 @@ +{ + "summary": "Delete an authorization", + "description": "", + "operationId": "oauth_authorizations-delete-authorization", + "tags": [ + "oauth_authorizations" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/oauth_authorizations/#delete-an-authorization" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "authorization_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "authorization_id parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/authorizations/" + }, + { + "lang": "JS", + "source": "octokit.oauth_authorizations.get({\n authorization_id: 'authorization_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/oauth_authorizations/delete-grant.json b/openapi/ghe-2.14/operations/oauth_authorizations/delete-grant.json new file mode 100644 index 0000000000..087a05e3e0 --- /dev/null +++ b/openapi/ghe-2.14/operations/oauth_authorizations/delete-grant.json @@ -0,0 +1,53 @@ +{ + "summary": "Delete a grant", + "description": "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).", + "operationId": "oauth_authorizations-delete-grant", + "tags": [ + "oauth_authorizations" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/oauth_authorizations/#delete-a-grant" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "grant_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "grant_id parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/applications/grants/" + }, + { + "lang": "JS", + "source": "octokit.oauth_authorizations.get({\n grant_id: 'grant_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/oauth_authorizations/get-authorization.json b/openapi/ghe-2.14/operations/oauth_authorizations/get-authorization.json new file mode 100644 index 0000000000..d1bf79fe4c --- /dev/null +++ b/openapi/ghe-2.14/operations/oauth_authorizations/get-authorization.json @@ -0,0 +1,111 @@ +{ + "summary": "Get a single authorization", + "description": "", + "operationId": "oauth_authorizations-get-authorization", + "tags": [ + "oauth_authorizations" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/oauth_authorizations/#get-a-single-authorization" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "authorization_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "authorization_id parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "url": { + "type": "string" + }, + "scopes": { + "type": "array", + "items": { + "type": "string" + } + }, + "token": { + "type": "string" + }, + "token_last_eight": { + "type": "string" + }, + "hashed_token": { + "type": "string" + }, + "app": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "client_id": { + "type": "string" + } + } + }, + "note": { + "type": "string" + }, + "note_url": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "fingerprint": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/authorizations/" + }, + { + "lang": "JS", + "source": "octokit.oauth_authorizations.get({\n authorization_id: 'authorization_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/oauth_authorizations/get-grant.json b/openapi/ghe-2.14/operations/oauth_authorizations/get-grant.json new file mode 100644 index 0000000000..e3849ca248 --- /dev/null +++ b/openapi/ghe-2.14/operations/oauth_authorizations/get-grant.json @@ -0,0 +1,93 @@ +{ + "summary": "Get a single grant", + "description": "", + "operationId": "oauth_authorizations-get-grant", + "tags": [ + "oauth_authorizations" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/oauth_authorizations/#get-a-single-grant" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "grant_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "grant_id parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "url": { + "type": "string" + }, + "app": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "client_id": { + "type": "string" + } + } + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "scopes": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/applications/grants/" + }, + { + "lang": "JS", + "source": "octokit.oauth_authorizations.get({\n grant_id: 'grant_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/oauth_authorizations/get-or-create-authorization-for-app-and-fingerprint.json b/openapi/ghe-2.14/operations/oauth_authorizations/get-or-create-authorization-for-app-and-fingerprint.json new file mode 100644 index 0000000000..8f70dd56d1 --- /dev/null +++ b/openapi/ghe-2.14/operations/oauth_authorizations/get-or-create-authorization-for-app-and-fingerprint.json @@ -0,0 +1,109 @@ +{ + "summary": "Get-or-create an authorization for a specific app and fingerprint", + "description": "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.\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 \"[Woking with two-factor authentication](https://developer.github.com/enterprise/2.14/v3/auth/#working-with-two-factor-authentication).\"", + "operationId": "oauth_authorizations-get-or-create-authorization-for-app-and-fingerprint", + "tags": [ + "oauth_authorizations" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "client_id", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "client_id parameter" + }, + { + "name": "fingerprint", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "fingerprint parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "client_secret": { + "description": "The 40 character OAuth app client secret associated with the client ID specified in the URL.", + "type": "string" + }, + "scopes": { + "description": "A list of scopes that this authorization is in.", + "type": "array", + "items": { + "type": "string" + } + }, + "note": { + "description": "A note to remind you what the OAuth token is for.", + "type": "string" + }, + "note_url": { + "description": "A URL to remind you what app the OAuth token is for.", + "type": "string" + } + }, + "required": [ + "client_secret" + ] + } + } + } + }, + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPUT \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/authorizations/clients//:fingerprint \\\n -d '{\"client_secret\":\"client_secret\"}'" + }, + { + "lang": "JS", + "source": "octokit.oauth_authorizations.get({\n client_id: 'client_id',\n fingerprint: 'fingerprint',\n client_secret: 'client_secret'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "idName", + "date": "2018-12-27", + "note": "`idName` changed for \"Get-or-create an authorization for a specific app and fingerprint\". It now includes `-and-`", + "meta": { + "before": { + "idName": "get-or-create-authorization-for-app-fingerprint" + }, + "after": { + "idName": "get-or-create-authorization-for-app-and-fingerprint" + } + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/oauth_authorizations/get-or-create-authorization-for-app.json b/openapi/ghe-2.14/operations/oauth_authorizations/get-or-create-authorization-for-app.json new file mode 100644 index 0000000000..768a444263 --- /dev/null +++ b/openapi/ghe-2.14/operations/oauth_authorizations/get-or-create-authorization-for-app.json @@ -0,0 +1,90 @@ +{ + "summary": "Get-or-create an authorization for a specific app", + "description": "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.\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 \"[Woking with two-factor authentication](https://developer.github.com/enterprise/2.14/v3/auth/#working-with-two-factor-authentication).\"", + "operationId": "oauth_authorizations-get-or-create-authorization-for-app", + "tags": [ + "oauth_authorizations" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "client_id", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "client_id parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "client_secret": { + "description": "The 40 character OAuth app client secret associated with the client ID specified in the URL.", + "type": "string" + }, + "scopes": { + "description": "A list of scopes that this authorization is in.", + "type": "array", + "items": { + "type": "string" + } + }, + "note": { + "description": "A note to remind you what the OAuth token is for.", + "type": "string" + }, + "note_url": { + "description": "A URL to remind you what app the OAuth token is for.", + "type": "string" + }, + "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/enterprise/2.14/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app-and-fingerprint).", + "type": "string" + } + }, + "required": [ + "client_secret" + ] + } + } + } + }, + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPUT \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/authorizations/clients/ \\\n -d '{\"client_secret\":\"client_secret\"}'" + }, + { + "lang": "JS", + "source": "octokit.oauth_authorizations.get({\n client_id: 'client_id',\n client_secret: 'client_secret'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/oauth_authorizations/list-authorizations.json b/openapi/ghe-2.14/operations/oauth_authorizations/list-authorizations.json new file mode 100644 index 0000000000..4d0dfb4e20 --- /dev/null +++ b/openapi/ghe-2.14/operations/oauth_authorizations/list-authorizations.json @@ -0,0 +1,69 @@ +{ + "summary": "List your authorizations", + "description": "", + "operationId": "oauth_authorizations-list-authorizations", + "tags": [ + "oauth_authorizations" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/oauth_authorizations/#list-your-authorizations" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/authorizations" + }, + { + "lang": "JS", + "source": "octokit.oauth_authorizations.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/oauth_authorizations/list-grants.json b/openapi/ghe-2.14/operations/oauth_authorizations/list-grants.json new file mode 100644 index 0000000000..2252f684ec --- /dev/null +++ b/openapi/ghe-2.14/operations/oauth_authorizations/list-grants.json @@ -0,0 +1,69 @@ +{ + "summary": "List your grants", + "description": "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/enterprise/2.14/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\"]`.", + "operationId": "oauth_authorizations-list-grants", + "tags": [ + "oauth_authorizations" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/oauth_authorizations/#list-your-grants" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/applications/grants" + }, + { + "lang": "JS", + "source": "octokit.oauth_authorizations.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/oauth_authorizations/reset-authorization.json b/openapi/ghe-2.14/operations/oauth_authorizations/reset-authorization.json new file mode 100644 index 0000000000..2acb6d3679 --- /dev/null +++ b/openapi/ghe-2.14/operations/oauth_authorizations/reset-authorization.json @@ -0,0 +1,179 @@ +{ + "summary": "Reset an authorization", + "description": "OAuth applications can use this API method to reset a valid OAuth token without end user involvement. Applications must save the \"token\" property in the response, because changes take effect immediately. You must use [Basic Authentication](https://developer.github.com/enterprise/2.14/v3/auth#basic-authentication) when accessing it, where the username is the OAuth application `client_id` and the password is its `client_secret`. Invalid tokens will return `404 NOT FOUND`.", + "operationId": "oauth_authorizations-reset-authorization", + "tags": [ + "oauth_authorizations" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/oauth_authorizations/#reset-an-authorization" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "client_id", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "client_id parameter" + }, + { + "name": "access_token", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "access_token parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "url": { + "type": "string" + }, + "scopes": { + "type": "array", + "items": { + "type": "string" + } + }, + "token": { + "type": "string" + }, + "token_last_eight": { + "type": "string" + }, + "hashed_token": { + "type": "string" + }, + "app": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "client_id": { + "type": "string" + } + } + }, + "note": { + "type": "string" + }, + "note_url": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "fingerprint": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/applications//tokens/:access_token" + }, + { + "lang": "JS", + "source": "octokit.oauth_authorizations.get({\n client_id: 'client_id',\n access_token: 'access_token'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/oauth_authorizations/revoke-authorization-for-application.json b/openapi/ghe-2.14/operations/oauth_authorizations/revoke-authorization-for-application.json new file mode 100644 index 0000000000..4b63c2217c --- /dev/null +++ b/openapi/ghe-2.14/operations/oauth_authorizations/revoke-authorization-for-application.json @@ -0,0 +1,62 @@ +{ + "summary": "Revoke an authorization for an application", + "description": "OAuth application owners can revoke a single token for an OAuth application. You must use [Basic Authentication](https://developer.github.com/enterprise/2.14/v3/auth#basic-authentication) for this method, where the username is the OAuth application `client_id` and the password is its `client_secret`.", + "operationId": "oauth_authorizations-revoke-authorization-for-application", + "tags": [ + "oauth_authorizations" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/oauth_authorizations/#revoke-an-authorization-for-an-application" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "client_id", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "client_id parameter" + }, + { + "name": "access_token", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "access_token parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/applications//tokens/:access_token" + }, + { + "lang": "JS", + "source": "octokit.oauth_authorizations.get({\n client_id: 'client_id',\n access_token: 'access_token'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/oauth_authorizations/revoke-grant-for-application.json b/openapi/ghe-2.14/operations/oauth_authorizations/revoke-grant-for-application.json new file mode 100644 index 0000000000..cf06dd90d5 --- /dev/null +++ b/openapi/ghe-2.14/operations/oauth_authorizations/revoke-grant-for-application.json @@ -0,0 +1,62 @@ +{ + "summary": "Revoke a grant for an application", + "description": "OAuth application owners can revoke a grant for their OAuth application and a specific user. You must use [Basic Authentication](https://developer.github.com/enterprise/2.14/v3/auth#basic-authentication) for this method, where the username is the OAuth application `client_id` and the password is its `client_secret`. 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 application authorizations settings screen within GitHub](https://github.com/settings/applications#authorized).", + "operationId": "oauth_authorizations-revoke-grant-for-application", + "tags": [ + "oauth_authorizations" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/oauth_authorizations/#revoke-a-grant-for-an-application" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "client_id", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "client_id parameter" + }, + { + "name": "access_token", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "access_token parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/applications//grants/:access_token" + }, + { + "lang": "JS", + "source": "octokit.oauth_authorizations.get({\n client_id: 'client_id',\n access_token: 'access_token'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/oauth_authorizations/update-authorization.json b/openapi/ghe-2.14/operations/oauth_authorizations/update-authorization.json new file mode 100644 index 0000000000..26d1f6fff4 --- /dev/null +++ b/openapi/ghe-2.14/operations/oauth_authorizations/update-authorization.json @@ -0,0 +1,155 @@ +{ + "summary": "Update an existing authorization", + "description": "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 \"[Woking with two-factor authentication](https://developer.github.com/enterprise/2.14/v3/auth/#working-with-two-factor-authentication).\"\n\nYou can only send one of these scope keys at a time.", + "operationId": "oauth_authorizations-update-authorization", + "tags": [ + "oauth_authorizations" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/oauth_authorizations/#update-an-existing-authorization" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "authorization_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "authorization_id parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "scopes": { + "description": "Replaces the authorization scopes with these.", + "type": "array", + "items": { + "type": "string" + } + }, + "add_scopes": { + "description": "A list of scopes to add to this authorization.", + "type": "array", + "items": { + "type": "string" + } + }, + "remove_scopes": { + "description": "A list of scopes to remove from this authorization.", + "type": "array", + "items": { + "type": "string" + } + }, + "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.", + "type": "string" + }, + "note_url": { + "description": "A URL to remind you what app the OAuth token is for.", + "type": "string" + }, + "fingerprint": { + "description": "A unique string to distinguish an authorization from others created for the same client ID and user.", + "type": "string" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "url": { + "type": "string" + }, + "scopes": { + "type": "array", + "items": { + "type": "string" + } + }, + "token": { + "type": "string" + }, + "token_last_eight": { + "type": "string" + }, + "hashed_token": { + "type": "string" + }, + "app": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "client_id": { + "type": "string" + } + } + }, + "note": { + "type": "string" + }, + "note_url": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "fingerprint": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPATCH \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/authorizations/" + }, + { + "lang": "JS", + "source": "octokit.oauth_authorizations.get({\n authorization_id: 'authorization_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/orgs/add-or-update-membership.json b/openapi/ghe-2.14/operations/orgs/add-or-update-membership.json new file mode 100644 index 0000000000..e4633a26aa --- /dev/null +++ b/openapi/ghe-2.14/operations/orgs/add-or-update-membership.json @@ -0,0 +1,202 @@ +{ + "summary": "Add or update organization membership", + "description": "Only authenticated organization owners can add a member to the organization or update the member's role.", + "operationId": "orgs-add-or-update-membership", + "tags": [ + "orgs" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/orgs/members/#add-or-update-organization-membership" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "org", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "org parameter" + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "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.", + "type": "string", + "enum": [ + "admin", + "member" + ], + "default": "member" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "state": { + "type": "string" + }, + "role": { + "type": "string" + }, + "organization_url": { + "type": "string" + }, + "organization": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + } + } + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPUT \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/orgs//memberships/:username" + }, + { + "lang": "JS", + "source": "octokit.orgs.get({\n org: 'org',\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/orgs/check-membership.json b/openapi/ghe-2.14/operations/orgs/check-membership.json new file mode 100644 index 0000000000..56826fc7df --- /dev/null +++ b/openapi/ghe-2.14/operations/orgs/check-membership.json @@ -0,0 +1,62 @@ +{ + "summary": "Check membership", + "description": "Check if a user is, publicly or privately, a member of the organization.", + "operationId": "orgs-check-membership", + "tags": [ + "orgs" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/orgs/members/#check-membership" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "org", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "org parameter" + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/orgs//members/:username" + }, + { + "lang": "JS", + "source": "octokit.orgs.get({\n org: 'org',\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/orgs/check-public-membership.json b/openapi/ghe-2.14/operations/orgs/check-public-membership.json new file mode 100644 index 0000000000..954371addd --- /dev/null +++ b/openapi/ghe-2.14/operations/orgs/check-public-membership.json @@ -0,0 +1,62 @@ +{ + "summary": "Check public membership", + "description": "", + "operationId": "orgs-check-public-membership", + "tags": [ + "orgs" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/orgs/members/#check-public-membership" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "org", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "org parameter" + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/orgs//public_members/:username" + }, + { + "lang": "JS", + "source": "octokit.orgs.get({\n org: 'org',\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/orgs/conceal-membership.json b/openapi/ghe-2.14/operations/orgs/conceal-membership.json new file mode 100644 index 0000000000..54dc8ec0be --- /dev/null +++ b/openapi/ghe-2.14/operations/orgs/conceal-membership.json @@ -0,0 +1,62 @@ +{ + "summary": "Conceal a user's membership", + "description": "", + "operationId": "orgs-conceal-membership", + "tags": [ + "orgs" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/orgs/members/#conceal-a-users-membership" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "org", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "org parameter" + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/orgs//public_members/:username" + }, + { + "lang": "JS", + "source": "octokit.orgs.get({\n org: 'org',\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/orgs/convert-member-to-outside-collaborator.json b/openapi/ghe-2.14/operations/orgs/convert-member-to-outside-collaborator.json new file mode 100644 index 0000000000..5127c6c241 --- /dev/null +++ b/openapi/ghe-2.14/operations/orgs/convert-member-to-outside-collaborator.json @@ -0,0 +1,62 @@ +{ + "summary": "Convert member to outside collaborator", + "description": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://help.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)\".", + "operationId": "orgs-convert-member-to-outside-collaborator", + "tags": [ + "orgs" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/orgs/outside_collaborators/#convert-member-to-outside-collaborator" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "org", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "org parameter" + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPUT \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/orgs//outside_collaborators/:username" + }, + { + "lang": "JS", + "source": "octokit.orgs.get({\n org: 'org',\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/orgs/create-hook.json b/openapi/ghe-2.14/operations/orgs/create-hook.json new file mode 100644 index 0000000000..b238ff30ec --- /dev/null +++ b/openapi/ghe-2.14/operations/orgs/create-hook.json @@ -0,0 +1,158 @@ +{ + "summary": "Create a hook", + "description": "Here's how you can create a hook that posts payloads in JSON format:", + "operationId": "orgs-create-hook", + "tags": [ + "orgs" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/orgs/hooks/#create-a-hook" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "org", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "org parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Must be passed as \"web\".", + "type": "string" + }, + "config": { + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.14/v3/orgs/hooks/#create-hook-config-params).", + "type": "object", + "properties": { + "url": { + "description": "The URL to which the payloads will be delivered.", + "type": "string" + }, + "content_type": { + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "type": "string" + }, + "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/enterprise/2.14/webhooks/#delivery-headers) header.", + "type": "string" + }, + "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.**", + "type": "string" + } + }, + "required": [ + "url" + ] + }, + "events": { + "description": "Determines what [events](https://developer.github.com/enterprise/2.14/v3/activity/events/types/) the hook is triggered for.", + "type": "array", + "default": [ + "push" + ], + "items": { + "type": "string" + } + }, + "active": { + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "type": "boolean", + "default": true + } + }, + "required": [ + "name", + "config" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "url": { + "type": "string" + }, + "ping_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "active": { + "type": "boolean" + }, + "config": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "content_type": { + "type": "string" + } + } + }, + "updated_at": { + "type": "string" + }, + "created_at": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/orgs//hooks \\\n -d '{\"name\":\"name\",\"config\":\"config\",\"config.url\":\"config.url\"}'" + }, + { + "lang": "JS", + "source": "octokit.orgs.get({\n org: 'org',\n name: 'name',\n config: 'config',\n 'config.url': 'config.url'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/orgs/delete-hook.json b/openapi/ghe-2.14/operations/orgs/delete-hook.json new file mode 100644 index 0000000000..00a6480207 --- /dev/null +++ b/openapi/ghe-2.14/operations/orgs/delete-hook.json @@ -0,0 +1,62 @@ +{ + "summary": "Delete a hook", + "description": "", + "operationId": "orgs-delete-hook", + "tags": [ + "orgs" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/orgs/hooks/#delete-a-hook" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "org", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "org parameter" + }, + { + "name": "hook_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "hook_id parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/orgs//hooks/:hook_id" + }, + { + "lang": "JS", + "source": "octokit.orgs.get({\n org: 'org',\n hook_id: 'hook_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/orgs/get-hook.json b/openapi/ghe-2.14/operations/orgs/get-hook.json new file mode 100644 index 0000000000..fa8304e331 --- /dev/null +++ b/openapi/ghe-2.14/operations/orgs/get-hook.json @@ -0,0 +1,108 @@ +{ + "summary": "Get single hook", + "description": "", + "operationId": "orgs-get-hook", + "tags": [ + "orgs" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/orgs/hooks/#get-single-hook" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "org", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "org parameter" + }, + { + "name": "hook_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "hook_id parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "url": { + "type": "string" + }, + "ping_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "active": { + "type": "boolean" + }, + "config": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "content_type": { + "type": "string" + } + } + }, + "updated_at": { + "type": "string" + }, + "created_at": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/orgs//hooks/:hook_id" + }, + { + "lang": "JS", + "source": "octokit.orgs.get({\n org: 'org',\n hook_id: 'hook_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/orgs/get-membership-for-authenticated-user.json b/openapi/ghe-2.14/operations/orgs/get-membership-for-authenticated-user.json new file mode 100644 index 0000000000..0c0baeee62 --- /dev/null +++ b/openapi/ghe-2.14/operations/orgs/get-membership-for-authenticated-user.json @@ -0,0 +1,173 @@ +{ + "summary": "Get your organization membership", + "description": "", + "operationId": "orgs-get-membership-for-authenticated-user", + "tags": [ + "orgs" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/orgs/members/#get-your-organization-membership" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "org", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "org parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "state": { + "type": "string" + }, + "role": { + "type": "string" + }, + "organization_url": { + "type": "string" + }, + "organization": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + } + } + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/user/memberships/orgs/" + }, + { + "lang": "JS", + "source": "octokit.orgs.get({\n org: 'org'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/orgs/get-membership.json b/openapi/ghe-2.14/operations/orgs/get-membership.json new file mode 100644 index 0000000000..4b49ebd499 --- /dev/null +++ b/openapi/ghe-2.14/operations/orgs/get-membership.json @@ -0,0 +1,62 @@ +{ + "summary": "Get organization membership", + "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member.", + "operationId": "orgs-get-membership", + "tags": [ + "orgs" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/orgs/members/#get-organization-membership" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "org", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "org parameter" + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/orgs//memberships/:username" + }, + { + "lang": "JS", + "source": "octokit.orgs.get({\n org: 'org',\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/orgs/get.json b/openapi/ghe-2.14/operations/orgs/get.json new file mode 100644 index 0000000000..a7fb7546b2 --- /dev/null +++ b/openapi/ghe-2.14/operations/orgs/get.json @@ -0,0 +1,180 @@ +{ + "summary": "Get an organization", + "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/).", + "operationId": "orgs-get", + "tags": [ + "orgs" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/orgs/#get-an-organization" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "org", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "org parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "name": { + "type": "string" + }, + "company": { + "type": "string" + }, + "blog": { + "type": "string" + }, + "location": { + "type": "string" + }, + "email": { + "type": "string" + }, + "has_organization_projects": { + "type": "boolean" + }, + "has_repository_projects": { + "type": "boolean" + }, + "public_repos": { + "type": "number" + }, + "public_gists": { + "type": "number" + }, + "followers": { + "type": "number" + }, + "following": { + "type": "number" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "type": { + "type": "string" + }, + "total_private_repos": { + "type": "number" + }, + "owned_private_repos": { + "type": "number" + }, + "private_gists": { + "type": "number" + }, + "disk_usage": { + "type": "number" + }, + "collaborators": { + "type": "number" + }, + "billing_email": { + "type": "string" + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "number" + }, + "private_repos": { + "type": "number" + } + } + }, + "default_repository_settings": { + "type": "string" + }, + "members_can_create_repositories": { + "type": "boolean" + }, + "two_factor_requirement_enabled": { + "type": "boolean" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/orgs/" + }, + { + "lang": "JS", + "source": "octokit.orgs.get({\n org: 'org'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/orgs/list-for-authenticated-user.json b/openapi/ghe-2.14/operations/orgs/list-for-authenticated-user.json new file mode 100644 index 0000000000..f456616695 --- /dev/null +++ b/openapi/ghe-2.14/operations/orgs/list-for-authenticated-user.json @@ -0,0 +1,69 @@ +{ + "summary": "List your organizations", + "description": "List organizations for the authenticated user.\n\n**OAuth scope requirements**\n\nThis only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope. OAuth requests with insufficient scope receive a `403 Forbidden` response.", + "operationId": "orgs-list-for-authenticated-user", + "tags": [ + "orgs" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/orgs/#list-your-organizations" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/user/orgs" + }, + { + "lang": "JS", + "source": "octokit.orgs.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/orgs/list-for-user.json b/openapi/ghe-2.14/operations/orgs/list-for-user.json new file mode 100644 index 0000000000..61397037b4 --- /dev/null +++ b/openapi/ghe-2.14/operations/orgs/list-for-user.json @@ -0,0 +1,78 @@ +{ + "summary": "List user organizations", + "description": "List [public organization memberships](https://help.github.com/articles/publicizing-or-concealing-organization-membership) for the specified user.\n\nThis method only lists _public_ memberships, regardless of authentication. If you need to fetch all of the organization memberships (public and private) for the authenticated user, use the [List your organizations](https://developer.github.com/enterprise/2.14/v3/orgs/#list-your-organizations) API instead.", + "operationId": "orgs-list-for-user", + "tags": [ + "orgs" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/orgs/#list-user-organizations" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/users//orgs" + }, + { + "lang": "JS", + "source": "octokit.orgs.get({\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/orgs/list-hooks.json b/openapi/ghe-2.14/operations/orgs/list-hooks.json new file mode 100644 index 0000000000..6d692de5ef --- /dev/null +++ b/openapi/ghe-2.14/operations/orgs/list-hooks.json @@ -0,0 +1,78 @@ +{ + "summary": "List hooks", + "description": "", + "operationId": "orgs-list-hooks", + "tags": [ + "orgs" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/orgs/hooks/#list-hooks" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "org", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "org parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/orgs//hooks" + }, + { + "lang": "JS", + "source": "octokit.orgs.get({\n org: 'org'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/orgs/list-members.json b/openapi/ghe-2.14/operations/orgs/list-members.json new file mode 100644 index 0000000000..6f6cd68953 --- /dev/null +++ b/openapi/ghe-2.14/operations/orgs/list-members.json @@ -0,0 +1,107 @@ +{ + "summary": "Members list", + "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", + "operationId": "orgs-list-members", + "tags": [ + "orgs" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/orgs/members/#members-list" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "org", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "org parameter" + }, + { + "name": "filter", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "2fa_disabled", + "all" + ], + "default": "all" + }, + "required": false, + "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." + }, + { + "name": "role", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "all", + "admin", + "member" + ], + "default": "all" + }, + "required": false, + "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." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/orgs//members" + }, + { + "lang": "JS", + "source": "octokit.orgs.get({\n org: 'org'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/orgs/list-memberships.json b/openapi/ghe-2.14/operations/orgs/list-memberships.json new file mode 100644 index 0000000000..a6990665b0 --- /dev/null +++ b/openapi/ghe-2.14/operations/orgs/list-memberships.json @@ -0,0 +1,82 @@ +{ + "summary": "List your organization memberships", + "description": "", + "operationId": "orgs-list-memberships", + "tags": [ + "orgs" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/orgs/members/#list-your-organization-memberships" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "state", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "active", + "pending" + ] + }, + "required": false, + "description": "Indicates the state of the memberships to return. Can be either `active` or `pending`. If not specified, the API returns both active and pending memberships." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/user/memberships/orgs" + }, + { + "lang": "JS", + "source": "octokit.orgs.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/orgs/list-outside-collaborators.json b/openapi/ghe-2.14/operations/orgs/list-outside-collaborators.json new file mode 100644 index 0000000000..0ed0221dbe --- /dev/null +++ b/openapi/ghe-2.14/operations/orgs/list-outside-collaborators.json @@ -0,0 +1,92 @@ +{ + "summary": "List outside collaborators", + "description": "List all users who are outside collaborators of an organization.\n\n", + "operationId": "orgs-list-outside-collaborators", + "tags": [ + "orgs" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/orgs/outside_collaborators/#list-outside-collaborators" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "org", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "org parameter" + }, + { + "name": "filter", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "2fa_disabled", + "all" + ], + "default": "all" + }, + "required": false, + "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." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/orgs//outside_collaborators" + }, + { + "lang": "JS", + "source": "octokit.orgs.get({\n org: 'org'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/orgs/list-public-members.json b/openapi/ghe-2.14/operations/orgs/list-public-members.json new file mode 100644 index 0000000000..cb162faf1a --- /dev/null +++ b/openapi/ghe-2.14/operations/orgs/list-public-members.json @@ -0,0 +1,78 @@ +{ + "summary": "Public members list", + "description": "Members of an organization can choose to have their membership publicized or not.", + "operationId": "orgs-list-public-members", + "tags": [ + "orgs" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/orgs/members/#public-members-list" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "org", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "org parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/orgs//public_members" + }, + { + "lang": "JS", + "source": "octokit.orgs.get({\n org: 'org'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/orgs/list.json b/openapi/ghe-2.14/operations/orgs/list.json new file mode 100644 index 0000000000..d716cfc7f7 --- /dev/null +++ b/openapi/ghe-2.14/operations/orgs/list.json @@ -0,0 +1,78 @@ +{ + "summary": "List all organizations", + "description": "Lists all organizations, in the order that they were created on GitHub Enterprise.\n\n**Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://developer.github.com/enterprise/2.14/v3/#link-header) to get the URL for the next page of organizations.", + "operationId": "orgs-list", + "tags": [ + "orgs" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/orgs/#list-all-organizations" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "description": "The integer ID of the last Organization that you've seen." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/organizations" + }, + { + "lang": "JS", + "source": "octokit.orgs.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/orgs/ping-hook.json b/openapi/ghe-2.14/operations/orgs/ping-hook.json new file mode 100644 index 0000000000..12497ff5a4 --- /dev/null +++ b/openapi/ghe-2.14/operations/orgs/ping-hook.json @@ -0,0 +1,62 @@ +{ + "summary": "Ping a hook", + "description": "This will trigger a [ping event](https://developer.github.com/enterprise/2.14/webhooks/#ping-event) to be sent to the hook.", + "operationId": "orgs-ping-hook", + "tags": [ + "orgs" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/orgs/hooks/#ping-a-hook" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "org", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "org parameter" + }, + { + "name": "hook_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "hook_id parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/orgs//hooks/:hook_id/pings" + }, + { + "lang": "JS", + "source": "octokit.orgs.get({\n org: 'org',\n hook_id: 'hook_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/orgs/publicize-membership.json b/openapi/ghe-2.14/operations/orgs/publicize-membership.json new file mode 100644 index 0000000000..ca65b5592b --- /dev/null +++ b/openapi/ghe-2.14/operations/orgs/publicize-membership.json @@ -0,0 +1,62 @@ +{ + "summary": "Publicize a user's membership", + "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/enterprise/2.14/v3/#http-verbs).\"", + "operationId": "orgs-publicize-membership", + "tags": [ + "orgs" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/orgs/members/#publicize-a-users-membership" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "org", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "org parameter" + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPUT \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/orgs//public_members/:username" + }, + { + "lang": "JS", + "source": "octokit.orgs.get({\n org: 'org',\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/orgs/remove-member.json b/openapi/ghe-2.14/operations/orgs/remove-member.json new file mode 100644 index 0000000000..390f41b039 --- /dev/null +++ b/openapi/ghe-2.14/operations/orgs/remove-member.json @@ -0,0 +1,62 @@ +{ + "summary": "Remove a member", + "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.", + "operationId": "orgs-remove-member", + "tags": [ + "orgs" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/orgs/members/#remove-a-member" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "org", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "org parameter" + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/orgs//members/:username" + }, + { + "lang": "JS", + "source": "octokit.orgs.get({\n org: 'org',\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/orgs/remove-membership.json b/openapi/ghe-2.14/operations/orgs/remove-membership.json new file mode 100644 index 0000000000..cfbe97f9ba --- /dev/null +++ b/openapi/ghe-2.14/operations/orgs/remove-membership.json @@ -0,0 +1,62 @@ +{ + "summary": "Remove organization membership", + "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.", + "operationId": "orgs-remove-membership", + "tags": [ + "orgs" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/orgs/members/#remove-organization-membership" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "org", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "org parameter" + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/orgs//memberships/:username" + }, + { + "lang": "JS", + "source": "octokit.orgs.get({\n org: 'org',\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/orgs/remove-outside-collaborator.json b/openapi/ghe-2.14/operations/orgs/remove-outside-collaborator.json new file mode 100644 index 0000000000..1dd3fb8de3 --- /dev/null +++ b/openapi/ghe-2.14/operations/orgs/remove-outside-collaborator.json @@ -0,0 +1,62 @@ +{ + "summary": "Remove outside collaborator", + "description": "Removing a user from this list will remove them from all the organization's repositories.", + "operationId": "orgs-remove-outside-collaborator", + "tags": [ + "orgs" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/orgs/outside_collaborators/#remove-outside-collaborator" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "org", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "org parameter" + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/orgs//outside_collaborators/:username" + }, + { + "lang": "JS", + "source": "octokit.orgs.get({\n org: 'org',\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/orgs/update-hook.json b/openapi/ghe-2.14/operations/orgs/update-hook.json new file mode 100644 index 0000000000..5f867dd2da --- /dev/null +++ b/openapi/ghe-2.14/operations/orgs/update-hook.json @@ -0,0 +1,159 @@ +{ + "summary": "Edit a hook", + "description": "", + "operationId": "orgs-update-hook", + "tags": [ + "orgs" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/orgs/hooks/#edit-a-hook" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "org", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "org parameter" + }, + { + "name": "hook_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "hook_id parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "config": { + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.14/v3/orgs/hooks/#update-hook-config-params).", + "type": "object", + "properties": { + "url": { + "description": "The URL to which the payloads will be delivered.", + "type": "string" + }, + "content_type": { + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "type": "string" + }, + "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/enterprise/2.14/webhooks/#delivery-headers) header.", + "type": "string" + }, + "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.**", + "type": "string" + } + }, + "required": [ + "url" + ] + }, + "events": { + "description": "Determines what [events](https://developer.github.com/enterprise/2.14/v3/activity/events/types/) the hook is triggered for.", + "type": "array", + "default": [ + "push" + ], + "items": { + "type": "string" + } + }, + "active": { + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "type": "boolean", + "default": true + } + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "url": { + "type": "string" + }, + "ping_url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "active": { + "type": "boolean" + }, + "config": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "content_type": { + "type": "string" + } + } + }, + "updated_at": { + "type": "string" + }, + "created_at": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPATCH \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/orgs//hooks/:hook_id \\\n -d '{\"config.url\":\"config.url\"}'" + }, + { + "lang": "JS", + "source": "octokit.orgs.get({\n org: 'org',\n hook_id: 'hook_id',\n 'config.url': 'config.url'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/orgs/update-membership.json b/openapi/ghe-2.14/operations/orgs/update-membership.json new file mode 100644 index 0000000000..2755feb883 --- /dev/null +++ b/openapi/ghe-2.14/operations/orgs/update-membership.json @@ -0,0 +1,194 @@ +{ + "summary": "Edit your organization membership", + "description": "", + "operationId": "orgs-update-membership", + "tags": [ + "orgs" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/orgs/members/#edit-your-organization-membership" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "org", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "org parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "state": { + "description": "The state that the membership should be in. Only `\"active\"` will be accepted.", + "type": "string", + "enum": [ + "active" + ] + } + }, + "required": [ + "state" + ] + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "state": { + "type": "string" + }, + "role": { + "type": "string" + }, + "organization_url": { + "type": "string" + }, + "organization": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + } + } + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPATCH \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/user/memberships/orgs/ \\\n -d '{\"state\":\"state\"}'" + }, + { + "lang": "JS", + "source": "octokit.orgs.get({\n org: 'org',\n state: 'state'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/orgs/update.json b/openapi/ghe-2.14/operations/orgs/update.json new file mode 100644 index 0000000000..95506bded5 --- /dev/null +++ b/openapi/ghe-2.14/operations/orgs/update.json @@ -0,0 +1,239 @@ +{ + "summary": "Edit an organization", + "description": "", + "operationId": "orgs-update", + "tags": [ + "orgs" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/orgs/#edit-an-organization" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "org", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "org parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "billing_email": { + "description": "Billing email address. This address is not publicized.", + "type": "string" + }, + "company": { + "description": "The company name.", + "type": "string" + }, + "email": { + "description": "The publicly visible email address.", + "type": "string" + }, + "location": { + "description": "The location.", + "type": "string" + }, + "name": { + "description": "The shorthand name of the company.", + "type": "string" + }, + "description": { + "description": "The description of the company.", + "type": "string" + }, + "has_organization_projects": { + "description": "Toggles whether organization projects are enabled for the organization.", + "type": "boolean" + }, + "has_repository_projects": { + "description": "Toggles whether repository projects are enabled for repositories that belong to the organization.", + "type": "boolean" + }, + "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.", + "type": "string", + "enum": [ + "read", + "write", + "admin", + "none" + ], + "default": "read" + }, + "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 admin members can create repositories.", + "type": "boolean", + "default": true + } + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "name": { + "type": "string" + }, + "company": { + "type": "string" + }, + "blog": { + "type": "string" + }, + "location": { + "type": "string" + }, + "email": { + "type": "string" + }, + "has_organization_projects": { + "type": "boolean" + }, + "has_repository_projects": { + "type": "boolean" + }, + "public_repos": { + "type": "number" + }, + "public_gists": { + "type": "number" + }, + "followers": { + "type": "number" + }, + "following": { + "type": "number" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "type": { + "type": "string" + }, + "total_private_repos": { + "type": "number" + }, + "owned_private_repos": { + "type": "number" + }, + "private_gists": { + "type": "number" + }, + "disk_usage": { + "type": "number" + }, + "collaborators": { + "type": "number" + }, + "billing_email": { + "type": "string" + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "number" + }, + "private_repos": { + "type": "number" + } + } + }, + "default_repository_settings": { + "type": "string" + }, + "members_can_create_repositories": { + "type": "boolean" + }, + "two_factor_requirement_enabled": { + "type": "boolean" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPATCH \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/orgs/" + }, + { + "lang": "JS", + "source": "octokit.orgs.get({\n org: 'org'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/projects/add-collaborator.json b/openapi/ghe-2.14/operations/projects/add-collaborator.json new file mode 100644 index 0000000000..4438fe84ff --- /dev/null +++ b/openapi/ghe-2.14/operations/projects/add-collaborator.json @@ -0,0 +1,84 @@ +{ + "summary": "Add user as a collaborator", + "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.", + "operationId": "projects-add-collaborator", + "tags": [ + "projects" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/projects/collaborators/#add-user-as-a-collaborator" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.inertia-preview+json" + }, + "required": true + }, + { + "name": "project_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "project_id parameter" + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "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/enterprise/2.14/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.", + "type": "string", + "enum": [ + "read", + "write", + "admin" + ], + "default": "write" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPUT \\\n -H\"Accept: application/vnd.github.inertia-preview+json\" \\\n https://developer.github.com/projects//collaborators/:username" + }, + { + "lang": "JS", + "source": "octokit.projects.get({\n project_id: 'project_id',\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/projects/create-card.json b/openapi/ghe-2.14/operations/projects/create-card.json new file mode 100644 index 0000000000..c2eba39df6 --- /dev/null +++ b/openapi/ghe-2.14/operations/projects/create-card.json @@ -0,0 +1,168 @@ +{ + "summary": "Create a project card", + "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/enterprise/2.14/v3/pulls/#list-pull-requests)\" endpoint.", + "operationId": "projects-create-card", + "tags": [ + "projects" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/projects/cards/#create-a-project-card" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.inertia-preview+json" + }, + "required": true + }, + { + "name": "column_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "column_id parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "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`.", + "type": "string" + }, + "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/enterprise/2.14/v3/issues/#list-issues-for-a-repository) and [List pull requests](https://developer.github.com/enterprise/2.14/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`.", + "type": "integer" + }, + "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.", + "type": "string" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "note": { + "type": "string" + }, + "creator": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "column_url": { + "type": "string" + }, + "content_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.inertia-preview+json\" \\\n https://developer.github.com/projects/columns//cards" + }, + { + "lang": "JS", + "source": "octokit.projects.get({\n column_id: 'column_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/projects/create-column.json b/openapi/ghe-2.14/operations/projects/create-column.json new file mode 100644 index 0000000000..2caf54c86e --- /dev/null +++ b/openapi/ghe-2.14/operations/projects/create-column.json @@ -0,0 +1,72 @@ +{ + "summary": "Create a project column", + "description": "", + "operationId": "projects-create-column", + "tags": [ + "projects" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/projects/columns/#create-a-project-column" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.inertia-preview+json" + }, + "required": true + }, + { + "name": "project_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "project_id parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "The name of the column.", + "type": "string" + } + }, + "required": [ + "name" + ] + } + } + } + }, + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.inertia-preview+json\" \\\n https://developer.github.com/projects//columns \\\n -d '{\"name\":\"name\"}'" + }, + { + "lang": "JS", + "source": "octokit.projects.get({\n project_id: 'project_id',\n name: 'name'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/projects/create-for-org.json b/openapi/ghe-2.14/operations/projects/create-for-org.json new file mode 100644 index 0000000000..bf712dd1f2 --- /dev/null +++ b/openapi/ghe-2.14/operations/projects/create-for-org.json @@ -0,0 +1,199 @@ +{ + "summary": "Create an organization project", + "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.", + "operationId": "projects-create-for-org", + "tags": [ + "projects" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/projects/#create-an-organization-project" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.inertia-preview+json" + }, + "required": true + }, + { + "name": "org", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "org parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "The name of the project.", + "type": "string" + }, + "body": { + "description": "The description of the project.", + "type": "string" + } + }, + "required": [ + "name" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "owner_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "columns_url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "body": { + "type": "string" + }, + "number": { + "type": "number" + }, + "state": { + "type": "string" + }, + "creator": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.inertia-preview+json\" \\\n https://developer.github.com/orgs//projects \\\n -d '{\"name\":\"name\"}'" + }, + { + "lang": "JS", + "source": "octokit.projects.get({\n org: 'org',\n name: 'name'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/projects/create-for-repo.json b/openapi/ghe-2.14/operations/projects/create-for-repo.json new file mode 100644 index 0000000000..462fb3a2c3 --- /dev/null +++ b/openapi/ghe-2.14/operations/projects/create-for-repo.json @@ -0,0 +1,208 @@ +{ + "summary": "Create a repository project", + "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.", + "operationId": "projects-create-for-repo", + "tags": [ + "projects" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/projects/#create-a-repository-project" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.inertia-preview+json" + }, + "required": true + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "The name of the project.", + "type": "string" + }, + "body": { + "description": "The description of the project.", + "type": "string" + } + }, + "required": [ + "name" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "owner_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "columns_url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "body": { + "type": "string" + }, + "number": { + "type": "number" + }, + "state": { + "type": "string" + }, + "creator": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.inertia-preview+json\" \\\n https://developer.github.com/repos/octocat/:repo/projects \\\n -d '{\"name\":\"name\"}'" + }, + { + "lang": "JS", + "source": "octokit.projects.get({\n owner: 'octocat',\n repo: 'hello-world',\n name: 'name'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/projects/delete-card.json b/openapi/ghe-2.14/operations/projects/delete-card.json new file mode 100644 index 0000000000..13683d8fc2 --- /dev/null +++ b/openapi/ghe-2.14/operations/projects/delete-card.json @@ -0,0 +1,54 @@ +{ + "summary": "Delete a project card", + "description": "", + "operationId": "projects-delete-card", + "tags": [ + "projects" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/projects/cards/#delete-a-project-card" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.inertia-preview+json" + }, + "required": true + }, + { + "name": "card_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "card_id parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.inertia-preview+json\" \\\n https://developer.github.com/projects/columns/cards/" + }, + { + "lang": "JS", + "source": "octokit.projects.get({\n card_id: 'card_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/projects/delete-column.json b/openapi/ghe-2.14/operations/projects/delete-column.json new file mode 100644 index 0000000000..9670d844a9 --- /dev/null +++ b/openapi/ghe-2.14/operations/projects/delete-column.json @@ -0,0 +1,54 @@ +{ + "summary": "Delete a project column", + "description": "", + "operationId": "projects-delete-column", + "tags": [ + "projects" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/projects/columns/#delete-a-project-column" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.inertia-preview+json" + }, + "required": true + }, + { + "name": "column_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "column_id parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.inertia-preview+json\" \\\n https://developer.github.com/projects/columns/" + }, + { + "lang": "JS", + "source": "octokit.projects.get({\n column_id: 'column_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/projects/delete.json b/openapi/ghe-2.14/operations/projects/delete.json new file mode 100644 index 0000000000..bfa332620d --- /dev/null +++ b/openapi/ghe-2.14/operations/projects/delete.json @@ -0,0 +1,54 @@ +{ + "summary": "Delete a project", + "description": "Deletes a project board. Returns a `404 Not Found` status if projects are disabled.", + "operationId": "projects-delete", + "tags": [ + "projects" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/projects/#delete-a-project" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.inertia-preview+json" + }, + "required": true + }, + { + "name": "project_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "project_id parameter" + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.inertia-preview+json\" \\\n https://developer.github.com/projects/" + }, + { + "lang": "JS", + "source": "octokit.projects.get({\n project_id: 'project_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/projects/get-card.json b/openapi/ghe-2.14/operations/projects/get-card.json new file mode 100644 index 0000000000..af16c8a3b5 --- /dev/null +++ b/openapi/ghe-2.14/operations/projects/get-card.json @@ -0,0 +1,54 @@ +{ + "summary": "Get a project card", + "description": "", + "operationId": "projects-get-card", + "tags": [ + "projects" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/projects/cards/#get-a-project-card" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.inertia-preview+json" + }, + "required": true + }, + { + "name": "card_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "card_id parameter" + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.inertia-preview+json\" \\\n https://developer.github.com/projects/columns/cards/" + }, + { + "lang": "JS", + "source": "octokit.projects.get({\n card_id: 'card_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/projects/get-column.json b/openapi/ghe-2.14/operations/projects/get-column.json new file mode 100644 index 0000000000..b8f2c210f9 --- /dev/null +++ b/openapi/ghe-2.14/operations/projects/get-column.json @@ -0,0 +1,54 @@ +{ + "summary": "Get a project column", + "description": "", + "operationId": "projects-get-column", + "tags": [ + "projects" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/projects/columns/#get-a-project-column" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.inertia-preview+json" + }, + "required": true + }, + { + "name": "column_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "column_id parameter" + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.inertia-preview+json\" \\\n https://developer.github.com/projects/columns/" + }, + { + "lang": "JS", + "source": "octokit.projects.get({\n column_id: 'column_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/projects/get.json b/openapi/ghe-2.14/operations/projects/get.json new file mode 100644 index 0000000000..630ffe86d1 --- /dev/null +++ b/openapi/ghe-2.14/operations/projects/get.json @@ -0,0 +1,177 @@ +{ + "summary": "Get a project", + "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.", + "operationId": "projects-get", + "tags": [ + "projects" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/projects/#get-a-project" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.inertia-preview+json" + }, + "required": true + }, + { + "name": "project_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "project_id parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "owner_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "columns_url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "body": { + "type": "string" + }, + "number": { + "type": "number" + }, + "state": { + "type": "string" + }, + "creator": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.inertia-preview+json\" \\\n https://developer.github.com/projects/" + }, + { + "lang": "JS", + "source": "octokit.projects.get({\n project_id: 'project_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/projects/list-cards.json b/openapi/ghe-2.14/operations/projects/list-cards.json new file mode 100644 index 0000000000..9c197678d6 --- /dev/null +++ b/openapi/ghe-2.14/operations/projects/list-cards.json @@ -0,0 +1,79 @@ +{ + "summary": "List project cards", + "description": "", + "operationId": "projects-list-cards", + "tags": [ + "projects" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/projects/cards/#list-project-cards" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.inertia-preview+json" + }, + "required": true + }, + { + "name": "column_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "column_id parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.inertia-preview+json\" \\\n https://developer.github.com/projects/columns//cards" + }, + { + "lang": "JS", + "source": "octokit.projects.get({\n column_id: 'column_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/projects/list-collaborators.json b/openapi/ghe-2.14/operations/projects/list-collaborators.json new file mode 100644 index 0000000000..16a5f25933 --- /dev/null +++ b/openapi/ghe-2.14/operations/projects/list-collaborators.json @@ -0,0 +1,94 @@ +{ + "summary": "List collaborators", + "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.", + "operationId": "projects-list-collaborators", + "tags": [ + "projects" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/projects/collaborators/#list-collaborators" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.inertia-preview+json" + }, + "required": true + }, + { + "name": "project_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "project_id parameter" + }, + { + "name": "affiliation", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "outside", + "direct", + "all" + ], + "default": "all" + }, + "required": false, + "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": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.inertia-preview+json\" \\\n https://developer.github.com/projects//collaborators" + }, + { + "lang": "JS", + "source": "octokit.projects.get({\n project_id: 'project_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/projects/list-columns.json b/openapi/ghe-2.14/operations/projects/list-columns.json new file mode 100644 index 0000000000..c10fdc1cd5 --- /dev/null +++ b/openapi/ghe-2.14/operations/projects/list-columns.json @@ -0,0 +1,79 @@ +{ + "summary": "List project columns", + "description": "", + "operationId": "projects-list-columns", + "tags": [ + "projects" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/projects/columns/#list-project-columns" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.inertia-preview+json" + }, + "required": true + }, + { + "name": "project_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "project_id parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.inertia-preview+json\" \\\n https://developer.github.com/projects//columns" + }, + { + "lang": "JS", + "source": "octokit.projects.get({\n project_id: 'project_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/projects/list-for-org.json b/openapi/ghe-2.14/operations/projects/list-for-org.json new file mode 100644 index 0000000000..611534f595 --- /dev/null +++ b/openapi/ghe-2.14/operations/projects/list-for-org.json @@ -0,0 +1,94 @@ +{ + "summary": "List organization projects", + "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", + "operationId": "projects-list-for-org", + "tags": [ + "projects" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/projects/#list-organization-projects" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.inertia-preview+json" + }, + "required": true + }, + { + "name": "org", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "org parameter" + }, + { + "name": "state", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "open", + "closed", + "all" + ], + "default": "open" + }, + "required": false, + "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.inertia-preview+json\" \\\n https://developer.github.com/orgs//projects" + }, + { + "lang": "JS", + "source": "octokit.projects.get({\n org: 'org'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/projects/list-for-repo.json b/openapi/ghe-2.14/operations/projects/list-for-repo.json new file mode 100644 index 0000000000..18da3d1c6a --- /dev/null +++ b/openapi/ghe-2.14/operations/projects/list-for-repo.json @@ -0,0 +1,103 @@ +{ + "summary": "List repository projects", + "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.", + "operationId": "projects-list-for-repo", + "tags": [ + "projects" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/projects/#list-repository-projects" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.inertia-preview+json" + }, + "required": true + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "state", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "open", + "closed", + "all" + ], + "default": "open" + }, + "required": false, + "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.inertia-preview+json\" \\\n https://developer.github.com/repos/octocat/:repo/projects" + }, + { + "lang": "JS", + "source": "octokit.projects.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/projects/move-card.json b/openapi/ghe-2.14/operations/projects/move-card.json new file mode 100644 index 0000000000..a4c5a0d25b --- /dev/null +++ b/openapi/ghe-2.14/operations/projects/move-card.json @@ -0,0 +1,82 @@ +{ + "summary": "Move a project card", + "description": "", + "operationId": "projects-move-card", + "tags": [ + "projects" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/projects/cards/#move-a-project-card" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.inertia-preview+json" + }, + "required": true + }, + { + "name": "card_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "card_id parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "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`.", + "type": "string", + "pattern": "^(top|bottom|after:\\d+)$" + }, + "column_id": { + "description": "The `id` value of a column in the same project.", + "type": "integer" + } + }, + "required": [ + "position" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.inertia-preview+json\" \\\n https://developer.github.com/projects/columns/cards//moves \\\n -d '{\"position\":\"position\"}'" + }, + { + "lang": "JS", + "source": "octokit.projects.get({\n card_id: 'card_id',\n position: 'position'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/projects/move-column.json b/openapi/ghe-2.14/operations/projects/move-column.json new file mode 100644 index 0000000000..484055ed03 --- /dev/null +++ b/openapi/ghe-2.14/operations/projects/move-column.json @@ -0,0 +1,78 @@ +{ + "summary": "Move a project column", + "description": "", + "operationId": "projects-move-column", + "tags": [ + "projects" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/projects/columns/#move-a-project-column" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.inertia-preview+json" + }, + "required": true + }, + { + "name": "column_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "column_id parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "position": { + "description": "Can be one of `first`, `last`, or `after:`, where `` is the `id` value of a column in the same project.", + "type": "string", + "pattern": "^(first|last|after:\\d+)$" + } + }, + "required": [ + "position" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.inertia-preview+json\" \\\n https://developer.github.com/projects/columns//moves \\\n -d '{\"position\":\"position\"}'" + }, + { + "lang": "JS", + "source": "octokit.projects.get({\n column_id: 'column_id',\n position: 'position'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/projects/remove-collaborator.json b/openapi/ghe-2.14/operations/projects/remove-collaborator.json new file mode 100644 index 0000000000..422b85331c --- /dev/null +++ b/openapi/ghe-2.14/operations/projects/remove-collaborator.json @@ -0,0 +1,63 @@ +{ + "summary": "Remove user as a collaborator", + "description": "Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator.", + "operationId": "projects-remove-collaborator", + "tags": [ + "projects" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/projects/collaborators/#remove-user-as-a-collaborator" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.inertia-preview+json" + }, + "required": true + }, + { + "name": "project_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "project_id parameter" + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.inertia-preview+json\" \\\n https://developer.github.com/projects//collaborators/:username" + }, + { + "lang": "JS", + "source": "octokit.projects.get({\n project_id: 'project_id',\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/projects/review-user-permission-level.json b/openapi/ghe-2.14/operations/projects/review-user-permission-level.json new file mode 100644 index 0000000000..462cc1debf --- /dev/null +++ b/openapi/ghe-2.14/operations/projects/review-user-permission-level.json @@ -0,0 +1,133 @@ +{ + "summary": "Review a user's permission level", + "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.", + "operationId": "projects-review-user-permission-level", + "tags": [ + "projects" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/projects/collaborators/#review-a-users-permission-level" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.inertia-preview+json" + }, + "required": true + }, + { + "name": "project_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "project_id parameter" + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "permission": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.inertia-preview+json\" \\\n https://developer.github.com/projects//collaborators/:username/permission" + }, + { + "lang": "JS", + "source": "octokit.projects.get({\n project_id: 'project_id',\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/projects/update-card.json b/openapi/ghe-2.14/operations/projects/update-card.json new file mode 100644 index 0000000000..eb0be924ba --- /dev/null +++ b/openapi/ghe-2.14/operations/projects/update-card.json @@ -0,0 +1,69 @@ +{ + "summary": "Update a project card", + "description": "", + "operationId": "projects-update-card", + "tags": [ + "projects" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/projects/cards/#update-a-project-card" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.inertia-preview+json" + }, + "required": true + }, + { + "name": "card_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "card_id parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "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`.", + "type": "string" + } + } + } + } + } + }, + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPATCH \\\n -H\"Accept: application/vnd.github.inertia-preview+json\" \\\n https://developer.github.com/projects/columns/cards/" + }, + { + "lang": "JS", + "source": "octokit.projects.get({\n card_id: 'card_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/projects/update-column.json b/openapi/ghe-2.14/operations/projects/update-column.json new file mode 100644 index 0000000000..3d4ac58371 --- /dev/null +++ b/openapi/ghe-2.14/operations/projects/update-column.json @@ -0,0 +1,72 @@ +{ + "summary": "Update a project column", + "description": "", + "operationId": "projects-update-column", + "tags": [ + "projects" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/projects/columns/#update-a-project-column" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.inertia-preview+json" + }, + "required": true + }, + { + "name": "column_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "column_id parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "The new name of the column.", + "type": "string" + } + }, + "required": [ + "name" + ] + } + } + } + }, + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPATCH \\\n -H\"Accept: application/vnd.github.inertia-preview+json\" \\\n https://developer.github.com/projects/columns/ \\\n -d '{\"name\":\"name\"}'" + }, + { + "lang": "JS", + "source": "octokit.projects.get({\n column_id: 'column_id',\n name: 'name'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/projects/update.json b/openapi/ghe-2.14/operations/projects/update.json new file mode 100644 index 0000000000..9be3bcca01 --- /dev/null +++ b/openapi/ghe-2.14/operations/projects/update.json @@ -0,0 +1,212 @@ +{ + "summary": "Update a project", + "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.", + "operationId": "projects-update", + "tags": [ + "projects" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/projects/#update-a-project" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.inertia-preview+json" + }, + "required": true + }, + { + "name": "project_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "project_id parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "The name of the project.", + "type": "string" + }, + "body": { + "description": "The description of the project.", + "type": "string" + }, + "state": { + "description": "State of the project. Either `open` or `closed`.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "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/enterprise/2.14/v3/teams/#add-or-update-team-project) or [Add user as a collaborator](https://developer.github.com/enterprise/2.14/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.", + "type": "string" + }, + "private": { + "description": "Sets the visibility of a project board. Setting `private` is only available for organization 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` - Organization members with the appropriate `organization_permission` can see project boards in an organization account.", + "type": "boolean" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "owner_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "columns_url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "body": { + "type": "string" + }, + "number": { + "type": "number" + }, + "state": { + "type": "string" + }, + "creator": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPATCH \\\n -H\"Accept: application/vnd.github.inertia-preview+json\" \\\n https://developer.github.com/projects/" + }, + { + "lang": "JS", + "source": "octokit.projects.get({\n project_id: 'project_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/pulls/check-if-merged.json b/openapi/ghe-2.14/operations/pulls/check-if-merged.json new file mode 100644 index 0000000000..b6d8f1a4df --- /dev/null +++ b/openapi/ghe-2.14/operations/pulls/check-if-merged.json @@ -0,0 +1,81 @@ +{ + "summary": "Get if a pull request has been merged", + "description": "", + "operationId": "pulls-check-if-merged", + "tags": [ + "pulls" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/pulls/#get-if-a-pull-request-has-been-merged" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "pull_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "pull_number parameter" + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/pulls/:pull_number/merge" + }, + { + "lang": "JS", + "source": "octokit.pulls.get({\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 'pull_number'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-04-10", + "note": "\"number\" parameter renamed to \"pull_number\"", + "meta": { + "before": "number", + "after": "pull_number" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/pulls/create-comment-reply.json b/openapi/ghe-2.14/operations/pulls/create-comment-reply.json new file mode 100644 index 0000000000..62ee9e1888 --- /dev/null +++ b/openapi/ghe-2.14/operations/pulls/create-comment-reply.json @@ -0,0 +1,248 @@ +{ + "summary": "Create a 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/enterprise/2.14/v3/#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/enterprise/2.14/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/enterprise/2.14/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.", + "operationId": "pulls-create-comment-reply", + "tags": [ + "pulls" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/pulls/comments/#create-a-comment" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "pull_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "pull_number parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "description": "The text of the comment.", + "type": "string" + }, + "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.", + "type": "integer" + } + }, + "required": [ + "body", + "in_reply_to" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "pull_request_review_id": { + "type": "number" + }, + "diff_hunk": { + "type": "string" + }, + "path": { + "type": "string" + }, + "position": { + "type": "number" + }, + "original_position": { + "type": "number" + }, + "commit_id": { + "type": "string" + }, + "original_commit_id": { + "type": "string" + }, + "in_reply_to_id": { + "type": "number" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "body": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "pull_request_url": { + "type": "string" + }, + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "html": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "pull_request": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/pulls/:pull_number/comments \\\n -d '{\"body\":\"body\",\"in_reply_to\":\"in_reply_to\"}'" + }, + { + "lang": "JS", + "source": "octokit.pulls.get({\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 'pull_number',\n body: 'body',\n in_reply_to: 'in_reply_to'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-04-10", + "note": "\"number\" parameter renamed to \"pull_number\"", + "meta": { + "before": "number", + "after": "pull_number" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/pulls/create-comment.json b/openapi/ghe-2.14/operations/pulls/create-comment.json new file mode 100644 index 0000000000..e0426db049 --- /dev/null +++ b/openapi/ghe-2.14/operations/pulls/create-comment.json @@ -0,0 +1,258 @@ +{ + "summary": "Create a comment", + "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/enterprise/2.14/v3/#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/enterprise/2.14/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/enterprise/2.14/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.", + "operationId": "pulls-create-comment", + "tags": [ + "pulls" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/pulls/comments/#create-a-comment" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "pull_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "pull_number parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "description": "The text of the comment.", + "type": "string" + }, + "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`.", + "type": "string" + }, + "path": { + "description": "The relative path to the file that necessitates a comment.", + "type": "string" + }, + "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.", + "type": "integer" + } + }, + "required": [ + "body", + "commit_id", + "path", + "position" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "pull_request_review_id": { + "type": "number" + }, + "diff_hunk": { + "type": "string" + }, + "path": { + "type": "string" + }, + "position": { + "type": "number" + }, + "original_position": { + "type": "number" + }, + "commit_id": { + "type": "string" + }, + "original_commit_id": { + "type": "string" + }, + "in_reply_to_id": { + "type": "number" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "body": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "pull_request_url": { + "type": "string" + }, + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "html": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "pull_request": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/pulls/:pull_number/comments \\\n -d '{\"body\":\"body\",\"commit_id\":\"commit_id\",\"path\":\"path\",\"position\":\"position\"}'" + }, + { + "lang": "JS", + "source": "octokit.pulls.get({\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 'pull_number',\n body: 'body',\n commit_id: 'commit_id',\n path: 'path',\n position: 'position'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-04-10", + "note": "\"number\" parameter renamed to \"pull_number\"", + "meta": { + "before": "number", + "after": "pull_number" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/pulls/create-from-issue.json b/openapi/ghe-2.14/operations/pulls/create-from-issue.json new file mode 100644 index 0000000000..e2255bc70b --- /dev/null +++ b/openapi/ghe-2.14/operations/pulls/create-from-issue.json @@ -0,0 +1,1528 @@ +{ + "summary": "Create a Pull Request from an Issue", + "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/enterprise/2.14/v3/#abuse-rate-limits)\" for details.", + "operationId": "pulls-create-from-issue", + "tags": [ + "pulls" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/pulls/#create-a-pull-request" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "issue": { + "description": "The issue number in this repository to turn into a Pull Request.", + "type": "integer" + }, + "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`.", + "type": "string" + }, + "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.", + "type": "string" + }, + "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.", + "type": "boolean" + } + }, + "required": [ + "issue", + "head", + "base" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "diff_url": { + "type": "string" + }, + "patch_url": { + "type": "string" + }, + "issue_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "review_comments_url": { + "type": "string" + }, + "review_comment_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "number": { + "type": "number" + }, + "state": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "title": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "body": { + "type": "string" + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "color": { + "type": "string" + }, + "default": { + "type": "boolean" + } + } + } + }, + "milestone": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "number" + }, + "state": { + "type": "string" + }, + "title": { + "type": "string" + }, + "description": { + "type": "string" + }, + "creator": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "open_issues": { + "type": "number" + }, + "closed_issues": { + "type": "number" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "closed_at": { + "type": "string" + }, + "due_on": { + "type": "string" + } + } + }, + "active_lock_reason": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "closed_at": { + "type": "string" + }, + "merged_at": { + "type": "string" + }, + "merge_commit_sha": { + "type": "string" + }, + "assignee": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "assignees": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + }, + "required": [ + "login", + "id", + "node_id", + "avatar_url", + "gravatar_id", + "url", + "html_url", + "followers_url", + "following_url", + "gists_url", + "starred_url", + "subscriptions_url", + "organizations_url", + "repos_url", + "events_url", + "received_events_url", + "type", + "site_admin" + ] + } + }, + "requested_reviewers": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + }, + "requested_teams": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string" + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": "string" + } + } + } + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "number" + }, + "stargazers_count": { + "type": "number" + }, + "watchers_count": { + "type": "number" + }, + "size": { + "type": "number" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "number" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "number" + }, + "network_count": { + "type": "number" + }, + "anonymous_access_enabled": { + "type": "boolean" + } + } + } + } + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "number" + }, + "stargazers_count": { + "type": "number" + }, + "watchers_count": { + "type": "number" + }, + "size": { + "type": "number" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "number" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "number" + }, + "network_count": { + "type": "number" + }, + "anonymous_access_enabled": { + "type": "boolean" + } + } + } + } + }, + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "html": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "issue": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "comments": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "review_comments": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "review_comment": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "commits": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "statuses": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + } + } + }, + "author_association": { + "type": "string" + }, + "merged": { + "type": "boolean" + }, + "mergeable": { + "type": "boolean" + }, + "rebaseable": { + "type": "boolean" + }, + "mergeable_state": { + "type": "string" + }, + "merged_by": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "comments": { + "type": "number" + }, + "review_comments": { + "type": "number" + }, + "maintainer_can_modify": { + "type": "boolean" + }, + "commits": { + "type": "number" + }, + "additions": { + "type": "number" + }, + "deletions": { + "type": "number" + }, + "changed_files": { + "type": "number" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/pulls \\\n -d '{\"issue\":\"issue\",\"head\":\"head\",\"base\":\"base\"}'" + }, + { + "lang": "JS", + "source": "octokit.pulls.get({\n owner: 'octocat',\n repo: 'hello-world',\n issue: 'issue',\n head: 'head',\n base: 'base'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/pulls/create-review-request.json b/openapi/ghe-2.14/operations/pulls/create-review-request.json new file mode 100644 index 0000000000..1daf6e2e4e --- /dev/null +++ b/openapi/ghe-2.14/operations/pulls/create-review-request.json @@ -0,0 +1,1468 @@ +{ + "summary": "Create a review request", + "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/enterprise/2.14/v3/#abuse-rate-limits)\" for details.", + "operationId": "pulls-create-review-request", + "tags": [ + "pulls" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/pulls/review_requests/#create-a-review-request" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "pull_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "pull_number parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "reviewers": { + "description": "An array of user `login`s that will be requested.", + "type": "array", + "items": { + "type": "string" + } + }, + "team_reviewers": { + "description": "An array of team `slug`s that will be requested.", + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "diff_url": { + "type": "string" + }, + "patch_url": { + "type": "string" + }, + "issue_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "review_comments_url": { + "type": "string" + }, + "review_comment_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "number": { + "type": "number" + }, + "state": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "title": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "body": { + "type": "string" + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "color": { + "type": "string" + }, + "default": { + "type": "boolean" + } + } + } + }, + "milestone": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "number" + }, + "state": { + "type": "string" + }, + "title": { + "type": "string" + }, + "description": { + "type": "string" + }, + "creator": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "open_issues": { + "type": "number" + }, + "closed_issues": { + "type": "number" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "closed_at": { + "type": "string" + }, + "due_on": { + "type": "string" + } + } + }, + "active_lock_reason": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "closed_at": { + "type": "string" + }, + "merged_at": { + "type": "string" + }, + "merge_commit_sha": { + "type": "string" + }, + "assignee": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "assignees": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + }, + "required": [ + "login", + "id", + "node_id", + "avatar_url", + "gravatar_id", + "url", + "html_url", + "followers_url", + "following_url", + "gists_url", + "starred_url", + "subscriptions_url", + "organizations_url", + "repos_url", + "events_url", + "received_events_url", + "type", + "site_admin" + ] + } + }, + "requested_reviewers": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + }, + "required": [ + "login", + "id", + "node_id", + "avatar_url", + "gravatar_id", + "url", + "html_url", + "followers_url", + "following_url", + "gists_url", + "starred_url", + "subscriptions_url", + "organizations_url", + "repos_url", + "events_url", + "received_events_url", + "type", + "site_admin" + ] + } + }, + "requested_teams": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string" + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": "string" + } + } + } + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "number" + }, + "stargazers_count": { + "type": "number" + }, + "watchers_count": { + "type": "number" + }, + "size": { + "type": "number" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "number" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "number" + }, + "network_count": { + "type": "number" + }, + "anonymous_access_enabled": { + "type": "boolean" + } + } + } + } + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "number" + }, + "stargazers_count": { + "type": "number" + }, + "watchers_count": { + "type": "number" + }, + "size": { + "type": "number" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "number" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "number" + }, + "network_count": { + "type": "number" + }, + "anonymous_access_enabled": { + "type": "boolean" + } + } + } + } + }, + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "html": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "issue": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "comments": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "review_comments": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "review_comment": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "commits": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "statuses": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + } + } + }, + "author_association": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/pulls/:pull_number/requested_reviewers" + }, + { + "lang": "JS", + "source": "octokit.pulls.get({\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 'pull_number'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-04-10", + "note": "\"number\" parameter renamed to \"pull_number\"", + "meta": { + "before": "number", + "after": "pull_number" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/pulls/create-review.json b/openapi/ghe-2.14/operations/pulls/create-review.json new file mode 100644 index 0000000000..6029c9fa41 --- /dev/null +++ b/openapi/ghe-2.14/operations/pulls/create-review.json @@ -0,0 +1,244 @@ +{ + "summary": "Create a pull request review", + "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/enterprise/2.14/v3/#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/enterprise/2.14/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/enterprise/2.14/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.", + "operationId": "pulls-create-review", + "tags": [ + "pulls" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/pulls/reviews/#create-a-pull-request-review" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "pull_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "pull_number parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "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.", + "type": "string" + }, + "body": { + "description": "**Required** when using `REQUEST_CHANGES` or `COMMENT` for the `event` parameter. The body text of the pull request review.", + "type": "string" + }, + "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/enterprise/2.14/v3/pulls/reviews/#submit-a-pull-request-review) when you are ready.", + "type": "string", + "enum": [ + "APPROVE", + "REQUEST_CHANGES", + "COMMENT" + ] + }, + "comments": { + "description": "Use the following table to specify the location, destination, and contents of the draft review comment.", + "type": "array", + "items": { + "type": "object", + "properties": { + "path": { + "description": "The relative path to the file that necessitates a review comment.", + "type": "string" + }, + "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.", + "type": "integer" + }, + "body": { + "description": "Text of the review comment.", + "type": "string" + } + }, + "required": [ + "path", + "position", + "body" + ] + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "body": { + "type": "string" + }, + "commit_id": { + "type": "string" + }, + "state": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "pull_request_url": { + "type": "string" + }, + "_links": { + "type": "object", + "properties": { + "html": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "pull_request": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/pulls/:pull_number/reviews \\\n -d '{\"comments[].path\":\"comments[].path\",\"comments[].position\":\"comments[].position\",\"comments[].body\":\"comments[].body\"}'" + }, + { + "lang": "JS", + "source": "octokit.pulls.get({\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 'pull_number',\n 'comments[].path': 'comments[].path',\n 'comments[].position': 'comments[].position',\n 'comments[].body': 'comments[].body'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-04-10", + "note": "\"number\" parameter renamed to \"pull_number\"", + "meta": { + "before": "number", + "after": "pull_number" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/pulls/create.json b/openapi/ghe-2.14/operations/pulls/create.json new file mode 100644 index 0000000000..5453d1019a --- /dev/null +++ b/openapi/ghe-2.14/operations/pulls/create.json @@ -0,0 +1,1532 @@ +{ + "summary": "Create a pull request", + "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/enterprise/2.14/v3/#abuse-rate-limits)\" for details.", + "operationId": "pulls-create", + "tags": [ + "pulls" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/pulls/#create-a-pull-request" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "description": "The title of the pull request.", + "type": "string" + }, + "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`.", + "type": "string" + }, + "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.", + "type": "string" + }, + "body": { + "description": "The contents of the pull request.", + "type": "string" + }, + "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.", + "type": "boolean" + } + }, + "required": [ + "title", + "head", + "base" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "diff_url": { + "type": "string" + }, + "patch_url": { + "type": "string" + }, + "issue_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "review_comments_url": { + "type": "string" + }, + "review_comment_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "number": { + "type": "number" + }, + "state": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "title": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "body": { + "type": "string" + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "color": { + "type": "string" + }, + "default": { + "type": "boolean" + } + } + } + }, + "milestone": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "number" + }, + "state": { + "type": "string" + }, + "title": { + "type": "string" + }, + "description": { + "type": "string" + }, + "creator": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "open_issues": { + "type": "number" + }, + "closed_issues": { + "type": "number" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "closed_at": { + "type": "string" + }, + "due_on": { + "type": "string" + } + } + }, + "active_lock_reason": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "closed_at": { + "type": "string" + }, + "merged_at": { + "type": "string" + }, + "merge_commit_sha": { + "type": "string" + }, + "assignee": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "assignees": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + }, + "required": [ + "login", + "id", + "node_id", + "avatar_url", + "gravatar_id", + "url", + "html_url", + "followers_url", + "following_url", + "gists_url", + "starred_url", + "subscriptions_url", + "organizations_url", + "repos_url", + "events_url", + "received_events_url", + "type", + "site_admin" + ] + } + }, + "requested_reviewers": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + }, + "requested_teams": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string" + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": "string" + } + } + } + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "number" + }, + "stargazers_count": { + "type": "number" + }, + "watchers_count": { + "type": "number" + }, + "size": { + "type": "number" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "number" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "number" + }, + "network_count": { + "type": "number" + }, + "anonymous_access_enabled": { + "type": "boolean" + } + } + } + } + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "number" + }, + "stargazers_count": { + "type": "number" + }, + "watchers_count": { + "type": "number" + }, + "size": { + "type": "number" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "number" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "number" + }, + "network_count": { + "type": "number" + }, + "anonymous_access_enabled": { + "type": "boolean" + } + } + } + } + }, + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "html": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "issue": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "comments": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "review_comments": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "review_comment": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "commits": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "statuses": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + } + } + }, + "author_association": { + "type": "string" + }, + "merged": { + "type": "boolean" + }, + "mergeable": { + "type": "boolean" + }, + "rebaseable": { + "type": "boolean" + }, + "mergeable_state": { + "type": "string" + }, + "merged_by": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "comments": { + "type": "number" + }, + "review_comments": { + "type": "number" + }, + "maintainer_can_modify": { + "type": "boolean" + }, + "commits": { + "type": "number" + }, + "additions": { + "type": "number" + }, + "deletions": { + "type": "number" + }, + "changed_files": { + "type": "number" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/pulls \\\n -d '{\"title\":\"title\",\"head\":\"head\",\"base\":\"base\"}'" + }, + { + "lang": "JS", + "source": "octokit.pulls.get({\n owner: 'octocat',\n repo: 'hello-world',\n title: 'title',\n head: 'head',\n base: 'base'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/pulls/delete-comment.json b/openapi/ghe-2.14/operations/pulls/delete-comment.json new file mode 100644 index 0000000000..f167d04ae8 --- /dev/null +++ b/openapi/ghe-2.14/operations/pulls/delete-comment.json @@ -0,0 +1,71 @@ +{ + "summary": "Delete a comment", + "description": "", + "operationId": "pulls-delete-comment", + "tags": [ + "pulls" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/pulls/comments/#delete-a-comment" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "comment_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "comment_id parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/pulls/comments/:comment_id" + }, + { + "lang": "JS", + "source": "octokit.pulls.get({\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 'comment_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/pulls/delete-pending-review.json b/openapi/ghe-2.14/operations/pulls/delete-pending-review.json new file mode 100644 index 0000000000..1236b0fac6 --- /dev/null +++ b/openapi/ghe-2.14/operations/pulls/delete-pending-review.json @@ -0,0 +1,199 @@ +{ + "summary": "Delete a pending review", + "description": "", + "operationId": "pulls-delete-pending-review", + "tags": [ + "pulls" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/pulls/reviews/#delete-a-pending-review" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "pull_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "pull_number parameter" + }, + { + "name": "review_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "review_id parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "body": { + "type": "string" + }, + "commit_id": { + "type": "string" + }, + "state": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "pull_request_url": { + "type": "string" + }, + "_links": { + "type": "object", + "properties": { + "html": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "pull_request": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/pulls/:pull_number/reviews/:review_id" + }, + { + "lang": "JS", + "source": "octokit.pulls.get({\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 'pull_number',\n review_id: 'review_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-04-10", + "note": "\"number\" parameter renamed to \"pull_number\"", + "meta": { + "before": "number", + "after": "pull_number" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/pulls/delete-review-request.json b/openapi/ghe-2.14/operations/pulls/delete-review-request.json new file mode 100644 index 0000000000..6e3820aebe --- /dev/null +++ b/openapi/ghe-2.14/operations/pulls/delete-review-request.json @@ -0,0 +1,111 @@ +{ + "summary": "Delete a review request", + "description": "", + "operationId": "pulls-delete-review-request", + "tags": [ + "pulls" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/pulls/review_requests/#delete-a-review-request" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "pull_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "pull_number parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "reviewers": { + "description": "An array of user `login`s that will be removed.", + "type": "array", + "items": { + "type": "string" + } + }, + "team_reviewers": { + "description": "An array of team `slug`s that will be removed.", + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/pulls/:pull_number/requested_reviewers" + }, + { + "lang": "JS", + "source": "octokit.pulls.get({\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 'pull_number'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-04-10", + "note": "\"number\" parameter renamed to \"pull_number\"", + "meta": { + "before": "number", + "after": "pull_number" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/pulls/dismiss-review.json b/openapi/ghe-2.14/operations/pulls/dismiss-review.json new file mode 100644 index 0000000000..0662d61dfc --- /dev/null +++ b/openapi/ghe-2.14/operations/pulls/dismiss-review.json @@ -0,0 +1,217 @@ +{ + "summary": "Dismiss a pull request review", + "description": "**Note:** To dismiss a pull request review on a [protected branch](https://developer.github.com/enterprise/2.14/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.", + "operationId": "pulls-dismiss-review", + "tags": [ + "pulls" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/pulls/reviews/#dismiss-a-pull-request-review" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "pull_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "pull_number parameter" + }, + { + "name": "review_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "review_id parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "description": "The message for the pull request review dismissal", + "type": "string" + } + }, + "required": [ + "message" + ] + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "body": { + "type": "string" + }, + "commit_id": { + "type": "string" + }, + "state": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "pull_request_url": { + "type": "string" + }, + "_links": { + "type": "object", + "properties": { + "html": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "pull_request": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPUT \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/pulls/:pull_number/reviews/:review_id/dismissals \\\n -d '{\"message\":\"message\"}'" + }, + { + "lang": "JS", + "source": "octokit.pulls.get({\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 'pull_number',\n review_id: 'review_id',\n message: 'message'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-04-10", + "note": "\"number\" parameter renamed to \"pull_number\"", + "meta": { + "before": "number", + "after": "pull_number" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/pulls/get-comment.json b/openapi/ghe-2.14/operations/pulls/get-comment.json new file mode 100644 index 0000000000..14cf33c753 --- /dev/null +++ b/openapi/ghe-2.14/operations/pulls/get-comment.json @@ -0,0 +1,215 @@ +{ + "summary": "Get a single comment", + "description": "", + "operationId": "pulls-get-comment", + "tags": [ + "pulls" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/pulls/comments/#get-a-single-comment" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "comment_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "comment_id parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "pull_request_review_id": { + "type": "number" + }, + "diff_hunk": { + "type": "string" + }, + "path": { + "type": "string" + }, + "position": { + "type": "number" + }, + "original_position": { + "type": "number" + }, + "commit_id": { + "type": "string" + }, + "original_commit_id": { + "type": "string" + }, + "in_reply_to_id": { + "type": "number" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "body": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "pull_request_url": { + "type": "string" + }, + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "html": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "pull_request": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/pulls/comments/:comment_id" + }, + { + "lang": "JS", + "source": "octokit.pulls.get({\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 'comment_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/pulls/get-comments-for-review.json b/openapi/ghe-2.14/operations/pulls/get-comments-for-review.json new file mode 100644 index 0000000000..7ccd67ab57 --- /dev/null +++ b/openapi/ghe-2.14/operations/pulls/get-comments-for-review.json @@ -0,0 +1,115 @@ +{ + "summary": "Get comments for a single review", + "description": "", + "operationId": "pulls-get-comments-for-review", + "tags": [ + "pulls" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/pulls/reviews/#get-comments-for-a-single-review" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "pull_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "pull_number parameter" + }, + { + "name": "review_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "review_id parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/pulls/:pull_number/reviews/:review_id/comments" + }, + { + "lang": "JS", + "source": "octokit.pulls.get({\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 'pull_number',\n review_id: 'review_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-04-10", + "note": "\"number\" parameter renamed to \"pull_number\"", + "meta": { + "before": "number", + "after": "pull_number" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/pulls/get-review.json b/openapi/ghe-2.14/operations/pulls/get-review.json new file mode 100644 index 0000000000..d3c5d11ed4 --- /dev/null +++ b/openapi/ghe-2.14/operations/pulls/get-review.json @@ -0,0 +1,199 @@ +{ + "summary": "Get a single review", + "description": "", + "operationId": "pulls-get-review", + "tags": [ + "pulls" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/pulls/reviews/#get-a-single-review" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "pull_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "pull_number parameter" + }, + { + "name": "review_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "review_id parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "body": { + "type": "string" + }, + "commit_id": { + "type": "string" + }, + "state": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "pull_request_url": { + "type": "string" + }, + "_links": { + "type": "object", + "properties": { + "html": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "pull_request": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/pulls/:pull_number/reviews/:review_id" + }, + { + "lang": "JS", + "source": "octokit.pulls.get({\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 'pull_number',\n review_id: 'review_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-04-10", + "note": "\"number\" parameter renamed to \"pull_number\"", + "meta": { + "before": "number", + "after": "pull_number" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/pulls/get.json b/openapi/ghe-2.14/operations/pulls/get.json new file mode 100644 index 0000000000..02d7d767e6 --- /dev/null +++ b/openapi/ghe-2.14/operations/pulls/get.json @@ -0,0 +1,1515 @@ +{ + "summary": "Get a single pull request", + "description": "Lists details of a pull request by providing its number.\n\nWhen you get, [create](https://developer.github.com/enterprise/2.14/v3/pulls/#create-a-pull-request), or [edit](https://developer.github.com/enterprise/2.14/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/enterprise/2.14/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/enterprise/2.14/v3/media/#commits-commit-comparison-and-pull-requests) to fetch diff and patch formats.", + "operationId": "pulls-get", + "tags": [ + "pulls" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/pulls/#get-a-single-pull-request" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "pull_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "pull_number parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "diff_url": { + "type": "string" + }, + "patch_url": { + "type": "string" + }, + "issue_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "review_comments_url": { + "type": "string" + }, + "review_comment_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "number": { + "type": "number" + }, + "state": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "title": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "body": { + "type": "string" + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "color": { + "type": "string" + }, + "default": { + "type": "boolean" + } + } + } + }, + "milestone": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "number" + }, + "state": { + "type": "string" + }, + "title": { + "type": "string" + }, + "description": { + "type": "string" + }, + "creator": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "open_issues": { + "type": "number" + }, + "closed_issues": { + "type": "number" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "closed_at": { + "type": "string" + }, + "due_on": { + "type": "string" + } + } + }, + "active_lock_reason": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "closed_at": { + "type": "string" + }, + "merged_at": { + "type": "string" + }, + "merge_commit_sha": { + "type": "string" + }, + "assignee": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "assignees": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + }, + "required": [ + "login", + "id", + "node_id", + "avatar_url", + "gravatar_id", + "url", + "html_url", + "followers_url", + "following_url", + "gists_url", + "starred_url", + "subscriptions_url", + "organizations_url", + "repos_url", + "events_url", + "received_events_url", + "type", + "site_admin" + ] + } + }, + "requested_reviewers": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + }, + "requested_teams": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string" + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": "string" + } + } + } + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "number" + }, + "stargazers_count": { + "type": "number" + }, + "watchers_count": { + "type": "number" + }, + "size": { + "type": "number" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "number" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "number" + }, + "network_count": { + "type": "number" + }, + "anonymous_access_enabled": { + "type": "boolean" + } + } + } + } + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "number" + }, + "stargazers_count": { + "type": "number" + }, + "watchers_count": { + "type": "number" + }, + "size": { + "type": "number" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "number" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "number" + }, + "network_count": { + "type": "number" + }, + "anonymous_access_enabled": { + "type": "boolean" + } + } + } + } + }, + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "html": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "issue": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "comments": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "review_comments": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "review_comment": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "commits": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "statuses": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + } + } + }, + "author_association": { + "type": "string" + }, + "merged": { + "type": "boolean" + }, + "mergeable": { + "type": "boolean" + }, + "rebaseable": { + "type": "boolean" + }, + "mergeable_state": { + "type": "string" + }, + "merged_by": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "comments": { + "type": "number" + }, + "review_comments": { + "type": "number" + }, + "maintainer_can_modify": { + "type": "boolean" + }, + "commits": { + "type": "number" + }, + "additions": { + "type": "number" + }, + "deletions": { + "type": "number" + }, + "changed_files": { + "type": "number" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/pulls/:pull_number" + }, + { + "lang": "JS", + "source": "octokit.pulls.get({\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 'pull_number'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-04-10", + "note": "\"number\" parameter renamed to \"pull_number\"", + "meta": { + "before": "number", + "after": "pull_number" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/pulls/list-comments-for-repo.json b/openapi/ghe-2.14/operations/pulls/list-comments-for-repo.json new file mode 100644 index 0000000000..7b80091f4f --- /dev/null +++ b/openapi/ghe-2.14/operations/pulls/list-comments-for-repo.json @@ -0,0 +1,123 @@ +{ + "summary": "List comments in a repository", + "description": "By default, review comments are ordered by ascending ID.", + "operationId": "pulls-list-comments-for-repo", + "tags": [ + "pulls" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/pulls/comments/#list-comments-in-a-repository" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "created", + "updated" + ], + "default": "created" + }, + "required": false, + "description": "Can be either `created` or `updated` comments." + }, + { + "name": "direction", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ] + }, + "required": false, + "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter." + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "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." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/pulls/comments" + }, + { + "lang": "JS", + "source": "octokit.pulls.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/pulls/list-comments.json b/openapi/ghe-2.14/operations/pulls/list-comments.json new file mode 100644 index 0000000000..c9a1aa17ea --- /dev/null +++ b/openapi/ghe-2.14/operations/pulls/list-comments.json @@ -0,0 +1,142 @@ +{ + "summary": "List comments on a pull request", + "description": "By default, review comments are ordered by ascending ID.", + "operationId": "pulls-list-comments", + "tags": [ + "pulls" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/pulls/comments/#list-comments-on-a-pull-request" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "pull_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "pull_number parameter" + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "created", + "updated" + ], + "default": "created" + }, + "required": false, + "description": "Can be either `created` or `updated` comments." + }, + { + "name": "direction", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ] + }, + "required": false, + "description": "Can be either `asc` or `desc`. Ignored without `sort` parameter." + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "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." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/pulls/:pull_number/comments" + }, + { + "lang": "JS", + "source": "octokit.pulls.get({\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 'pull_number'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-04-10", + "note": "\"number\" parameter renamed to \"pull_number\"", + "meta": { + "before": "number", + "after": "pull_number" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/pulls/list-commits.json b/openapi/ghe-2.14/operations/pulls/list-commits.json new file mode 100644 index 0000000000..bfcd6652e4 --- /dev/null +++ b/openapi/ghe-2.14/operations/pulls/list-commits.json @@ -0,0 +1,106 @@ +{ + "summary": "List commits on a pull request", + "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/enterprise/2.14/v3/repos/commits/#list-commits-on-a-repository).", + "operationId": "pulls-list-commits", + "tags": [ + "pulls" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/pulls/#list-commits-on-a-pull-request" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "pull_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "pull_number parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/pulls/:pull_number/commits" + }, + { + "lang": "JS", + "source": "octokit.pulls.get({\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 'pull_number'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-04-10", + "note": "\"number\" parameter renamed to \"pull_number\"", + "meta": { + "before": "number", + "after": "pull_number" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/pulls/list-files.json b/openapi/ghe-2.14/operations/pulls/list-files.json new file mode 100644 index 0000000000..6d30c9acbc --- /dev/null +++ b/openapi/ghe-2.14/operations/pulls/list-files.json @@ -0,0 +1,106 @@ +{ + "summary": "List pull requests files", + "description": "**Note:** The response includes a maximum of 300 files.", + "operationId": "pulls-list-files", + "tags": [ + "pulls" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/pulls/#list-pull-requests-files" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "pull_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "pull_number parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/pulls/:pull_number/files" + }, + { + "lang": "JS", + "source": "octokit.pulls.get({\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 'pull_number'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-04-10", + "note": "\"number\" parameter renamed to \"pull_number\"", + "meta": { + "before": "number", + "after": "pull_number" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/pulls/list-review-requests.json b/openapi/ghe-2.14/operations/pulls/list-review-requests.json new file mode 100644 index 0000000000..d6fa8c79d2 --- /dev/null +++ b/openapi/ghe-2.14/operations/pulls/list-review-requests.json @@ -0,0 +1,212 @@ +{ + "summary": "List review requests", + "description": "", + "operationId": "pulls-list-review-requests", + "tags": [ + "pulls" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/pulls/review_requests/#list-review-requests" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "pull_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "pull_number parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + }, + "teams": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string" + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": "string" + } + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/pulls/:pull_number/requested_reviewers" + }, + { + "lang": "JS", + "source": "octokit.pulls.get({\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 'pull_number'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-04-10", + "note": "\"number\" parameter renamed to \"pull_number\"", + "meta": { + "before": "number", + "after": "pull_number" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/pulls/list-reviews.json b/openapi/ghe-2.14/operations/pulls/list-reviews.json new file mode 100644 index 0000000000..863587143b --- /dev/null +++ b/openapi/ghe-2.14/operations/pulls/list-reviews.json @@ -0,0 +1,106 @@ +{ + "summary": "List reviews on a pull request", + "description": "The list of reviews returns in chronological order.", + "operationId": "pulls-list-reviews", + "tags": [ + "pulls" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/pulls/reviews/#list-reviews-on-a-pull-request" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "pull_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "pull_number parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/pulls/:pull_number/reviews" + }, + { + "lang": "JS", + "source": "octokit.pulls.get({\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 'pull_number'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-04-10", + "note": "\"number\" parameter renamed to \"pull_number\"", + "meta": { + "before": "number", + "after": "pull_number" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/pulls/list.json b/openapi/ghe-2.14/operations/pulls/list.json new file mode 100644 index 0000000000..6d2b68872a --- /dev/null +++ b/openapi/ghe-2.14/operations/pulls/list.json @@ -0,0 +1,149 @@ +{ + "summary": "List pull requests", + "description": "", + "operationId": "pulls-list", + "tags": [ + "pulls" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/pulls/#list-pull-requests" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "state", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "open", + "closed", + "all" + ], + "default": "open" + }, + "required": false, + "description": "Either `open`, `closed`, or `all` to filter by state." + }, + { + "name": "head", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "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": "base", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "description": "Filter pulls by base branch name. Example: `gh-pages`." + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "popularity", + "long-running" + ], + "default": "created" + }, + "required": false, + "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", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ] + }, + "required": false, + "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": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/pulls" + }, + { + "lang": "JS", + "source": "octokit.pulls.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/pulls/merge.json b/openapi/ghe-2.14/operations/pulls/merge.json new file mode 100644 index 0000000000..a4bbe95597 --- /dev/null +++ b/openapi/ghe-2.14/operations/pulls/merge.json @@ -0,0 +1,113 @@ +{ + "summary": "Merge a pull request (Merge Button)", + "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/enterprise/2.14/v3/#abuse-rate-limits)\" for details.", + "operationId": "pulls-merge", + "tags": [ + "pulls" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/pulls/#merge-a-pull-request-merge-button" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "pull_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "pull_number parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "commit_title": { + "description": "Title for the automatic commit message.", + "type": "string" + }, + "commit_message": { + "description": "Extra detail to append to automatic commit message.", + "type": "string" + }, + "sha": { + "description": "SHA that pull request head must match to allow merge.", + "type": "string" + }, + "merge_method": { + "description": "Merge method to use. Possible values are `merge`, `squash` or `rebase`. Default is `merge`.", + "type": "string", + "enum": [ + "merge", + "squash", + "rebase" + ] + } + } + } + } + } + }, + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPUT \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/pulls/:pull_number/merge" + }, + { + "lang": "JS", + "source": "octokit.pulls.get({\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 'pull_number'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-04-10", + "note": "\"number\" parameter renamed to \"pull_number\"", + "meta": { + "before": "number", + "after": "pull_number" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/pulls/submit-review.json b/openapi/ghe-2.14/operations/pulls/submit-review.json new file mode 100644 index 0000000000..f3d6654c2a --- /dev/null +++ b/openapi/ghe-2.14/operations/pulls/submit-review.json @@ -0,0 +1,226 @@ +{ + "summary": "Submit a pull request review", + "description": "", + "operationId": "pulls-submit-review", + "tags": [ + "pulls" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/pulls/reviews/#submit-a-pull-request-review" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "pull_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "pull_number parameter" + }, + { + "name": "review_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "review_id parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "description": "The body text of the pull request review", + "type": "string" + }, + "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.", + "type": "string", + "enum": [ + "APPROVE", + "REQUEST_CHANGES", + "COMMENT" + ] + } + }, + "required": [ + "event" + ] + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "body": { + "type": "string" + }, + "commit_id": { + "type": "string" + }, + "state": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "pull_request_url": { + "type": "string" + }, + "_links": { + "type": "object", + "properties": { + "html": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "pull_request": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/pulls/:pull_number/reviews/:review_id/events \\\n -d '{\"event\":\"event\"}'" + }, + { + "lang": "JS", + "source": "octokit.pulls.get({\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 'pull_number',\n review_id: 'review_id',\n event: 'event'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-04-10", + "note": "\"number\" parameter renamed to \"pull_number\"", + "meta": { + "before": "number", + "after": "pull_number" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/pulls/update-comment.json b/openapi/ghe-2.14/operations/pulls/update-comment.json new file mode 100644 index 0000000000..25eb82df8e --- /dev/null +++ b/openapi/ghe-2.14/operations/pulls/update-comment.json @@ -0,0 +1,233 @@ +{ + "summary": "Edit a comment", + "description": "", + "operationId": "pulls-update-comment", + "tags": [ + "pulls" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/pulls/comments/#edit-a-comment" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "comment_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "comment_id parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "description": "The text of the comment.", + "type": "string" + } + }, + "required": [ + "body" + ] + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "pull_request_review_id": { + "type": "number" + }, + "diff_hunk": { + "type": "string" + }, + "path": { + "type": "string" + }, + "position": { + "type": "number" + }, + "original_position": { + "type": "number" + }, + "commit_id": { + "type": "string" + }, + "original_commit_id": { + "type": "string" + }, + "in_reply_to_id": { + "type": "number" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "body": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "pull_request_url": { + "type": "string" + }, + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "html": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "pull_request": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPATCH \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/pulls/comments/:comment_id \\\n -d '{\"body\":\"body\"}'" + }, + { + "lang": "JS", + "source": "octokit.pulls.get({\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 'comment_id',\n body: 'body'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/pulls/update.json b/openapi/ghe-2.14/operations/pulls/update.json new file mode 100644 index 0000000000..163cc3c817 --- /dev/null +++ b/openapi/ghe-2.14/operations/pulls/update.json @@ -0,0 +1,1550 @@ +{ + "summary": "Update a pull request", + "description": "", + "operationId": "pulls-update", + "tags": [ + "pulls" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/pulls/#update-a-pull-request" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "pull_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "pull_number parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "description": "The title of the pull request.", + "type": "string" + }, + "body": { + "description": "The contents of the pull request.", + "type": "string" + }, + "state": { + "description": "State of this Pull Request. Either `open` or `closed`.", + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "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.", + "type": "string" + }, + "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.", + "type": "boolean" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "diff_url": { + "type": "string" + }, + "patch_url": { + "type": "string" + }, + "issue_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "review_comments_url": { + "type": "string" + }, + "review_comment_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "number": { + "type": "number" + }, + "state": { + "type": "string" + }, + "locked": { + "type": "boolean" + }, + "title": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "body": { + "type": "string" + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "color": { + "type": "string" + }, + "default": { + "type": "boolean" + } + } + } + }, + "milestone": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "number" + }, + "state": { + "type": "string" + }, + "title": { + "type": "string" + }, + "description": { + "type": "string" + }, + "creator": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "open_issues": { + "type": "number" + }, + "closed_issues": { + "type": "number" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "closed_at": { + "type": "string" + }, + "due_on": { + "type": "string" + } + } + }, + "active_lock_reason": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "closed_at": { + "type": "string" + }, + "merged_at": { + "type": "string" + }, + "merge_commit_sha": { + "type": "string" + }, + "assignee": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "assignees": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + }, + "required": [ + "login", + "id", + "node_id", + "avatar_url", + "gravatar_id", + "url", + "html_url", + "followers_url", + "following_url", + "gists_url", + "starred_url", + "subscriptions_url", + "organizations_url", + "repos_url", + "events_url", + "received_events_url", + "type", + "site_admin" + ] + } + }, + "requested_reviewers": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + }, + "requested_teams": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string" + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": "string" + } + } + } + }, + "head": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "number" + }, + "stargazers_count": { + "type": "number" + }, + "watchers_count": { + "type": "number" + }, + "size": { + "type": "number" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "number" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "number" + }, + "network_count": { + "type": "number" + }, + "anonymous_access_enabled": { + "type": "boolean" + } + } + } + } + }, + "base": { + "type": "object", + "properties": { + "label": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "number" + }, + "stargazers_count": { + "type": "number" + }, + "watchers_count": { + "type": "number" + }, + "size": { + "type": "number" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "number" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "number" + }, + "network_count": { + "type": "number" + }, + "anonymous_access_enabled": { + "type": "boolean" + } + } + } + } + }, + "_links": { + "type": "object", + "properties": { + "self": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "html": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "issue": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "comments": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "review_comments": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "review_comment": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "commits": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + }, + "statuses": { + "type": "object", + "properties": { + "href": { + "type": "string" + } + } + } + } + }, + "author_association": { + "type": "string" + }, + "merged": { + "type": "boolean" + }, + "mergeable": { + "type": "boolean" + }, + "rebaseable": { + "type": "boolean" + }, + "mergeable_state": { + "type": "string" + }, + "merged_by": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "comments": { + "type": "number" + }, + "review_comments": { + "type": "number" + }, + "maintainer_can_modify": { + "type": "boolean" + }, + "commits": { + "type": "number" + }, + "additions": { + "type": "number" + }, + "deletions": { + "type": "number" + }, + "changed_files": { + "type": "number" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPATCH \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/pulls/:pull_number" + }, + { + "lang": "JS", + "source": "octokit.pulls.get({\n owner: 'octocat',\n repo: 'hello-world',\n pull_number: 'pull_number'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-04-10", + "note": "\"number\" parameter renamed to \"pull_number\"", + "meta": { + "before": "number", + "after": "pull_number" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/rate_limit/get.json b/openapi/ghe-2.14/operations/rate_limit/get.json new file mode 100644 index 0000000000..c5953b1c3d --- /dev/null +++ b/openapi/ghe-2.14/operations/rate_limit/get.json @@ -0,0 +1,113 @@ +{ + "summary": "Get your current rate limit status", + "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/enterprise/2.14/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/enterprise/2.14/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 three 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/enterprise/2.14/v3/search/).\n* The `graphql` object provides your rate limit status for the [GraphQL API](https://developer.github.com/enterprise/2.14/v4/).\n\nFor more information on the headers and values in the rate limit response, see \"[Rate limiting](https://developer.github.com/enterprise/2.14/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.", + "operationId": "rate_limit-get", + "tags": [ + "rate_limit" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/rate_limit/#get-your-current-rate-limit-status" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "resources": { + "type": "object", + "properties": { + "core": { + "type": "object", + "properties": { + "limit": { + "type": "number" + }, + "remaining": { + "type": "number" + }, + "reset": { + "type": "number" + } + } + }, + "search": { + "type": "object", + "properties": { + "limit": { + "type": "number" + }, + "remaining": { + "type": "number" + }, + "reset": { + "type": "number" + } + } + }, + "graphql": { + "type": "object", + "properties": { + "limit": { + "type": "number" + }, + "remaining": { + "type": "number" + }, + "reset": { + "type": "number" + } + } + } + } + }, + "rate": { + "type": "object", + "properties": { + "limit": { + "type": "number" + }, + "remaining": { + "type": "number" + }, + "reset": { + "type": "number" + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/rate_limit" + }, + { + "lang": "JS", + "source": "octokit.rate_limit.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/reactions/create-for-commit-comment.json b/openapi/ghe-2.14/operations/reactions/create-for-commit-comment.json new file mode 100644 index 0000000000..ad57c6315a --- /dev/null +++ b/openapi/ghe-2.14/operations/reactions/create-for-commit-comment.json @@ -0,0 +1,179 @@ +{ + "summary": "Create reaction for a commit comment", + "description": "Create a reaction to a [commit comment](https://developer.github.com/enterprise/2.14/v3/repos/comments/). A response with a `Status: 200 OK` means that you already added the reaction type to this commit comment.", + "operationId": "reactions-create-for-commit-comment", + "tags": [ + "reactions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/reactions/#create-reaction-for-a-commit-comment" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.squirrel-girl-preview+json" + }, + "required": true + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "comment_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "comment_id parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "content": { + "description": "The [reaction type](https://developer.github.com/enterprise/2.14/v3/reactions/#reaction-types) to add to the commit comment.", + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + } + }, + "required": [ + "content" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "content": { + "type": "string" + }, + "created_at": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://developer.github.com/repos/octocat/:repo/comments/:comment_id/reactions \\\n -d '{\"content\":\"content\"}'" + }, + { + "lang": "JS", + "source": "octokit.reactions.get({\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 'comment_id',\n content: 'content'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/reactions/create-for-issue-comment.json b/openapi/ghe-2.14/operations/reactions/create-for-issue-comment.json new file mode 100644 index 0000000000..4b0e4c4589 --- /dev/null +++ b/openapi/ghe-2.14/operations/reactions/create-for-issue-comment.json @@ -0,0 +1,179 @@ +{ + "summary": "Create reaction for an issue comment", + "description": "Create a reaction to an [issue comment](https://developer.github.com/enterprise/2.14/v3/issues/comments/). A response with a `Status: 200 OK` means that you already added the reaction type to this issue comment.", + "operationId": "reactions-create-for-issue-comment", + "tags": [ + "reactions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/reactions/#create-reaction-for-an-issue-comment" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.squirrel-girl-preview+json" + }, + "required": true + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "comment_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "comment_id parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "content": { + "description": "The [reaction type](https://developer.github.com/enterprise/2.14/v3/reactions/#reaction-types) to add to the issue comment.", + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + } + }, + "required": [ + "content" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "content": { + "type": "string" + }, + "created_at": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://developer.github.com/repos/octocat/:repo/issues/comments/:comment_id/reactions \\\n -d '{\"content\":\"content\"}'" + }, + { + "lang": "JS", + "source": "octokit.reactions.get({\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 'comment_id',\n content: 'content'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/reactions/create-for-issue.json b/openapi/ghe-2.14/operations/reactions/create-for-issue.json new file mode 100644 index 0000000000..7b03c0eb93 --- /dev/null +++ b/openapi/ghe-2.14/operations/reactions/create-for-issue.json @@ -0,0 +1,189 @@ +{ + "summary": "Create reaction for an issue", + "description": "Create a reaction to an [issue](https://developer.github.com/enterprise/2.14/v3/issues/). A response with a `Status: 200 OK` means that you already added the reaction type to this issue.", + "operationId": "reactions-create-for-issue", + "tags": [ + "reactions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/reactions/#create-reaction-for-an-issue" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.squirrel-girl-preview+json" + }, + "required": true + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "issue_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "issue_number parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "content": { + "description": "The [reaction type](https://developer.github.com/enterprise/2.14/v3/reactions/#reaction-types) to add to the issue.", + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + } + }, + "required": [ + "content" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "content": { + "type": "string" + }, + "created_at": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://developer.github.com/repos/octocat/:repo/issues/:issue_number/reactions \\\n -d '{\"content\":\"content\"}'" + }, + { + "lang": "JS", + "source": "octokit.reactions.get({\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 1,\n content: 'content'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-04-10", + "note": "\"number\" parameter renamed to \"issue_number\"", + "meta": { + "before": "number", + "after": "issue_number" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/reactions/create-for-pull-request-review-comment.json b/openapi/ghe-2.14/operations/reactions/create-for-pull-request-review-comment.json new file mode 100644 index 0000000000..4307bdd9f7 --- /dev/null +++ b/openapi/ghe-2.14/operations/reactions/create-for-pull-request-review-comment.json @@ -0,0 +1,179 @@ +{ + "summary": "Create reaction for a pull request review comment", + "description": "Create a reaction to a [pull request review comment](https://developer.github.com/enterprise/2.14/v3/pulls/comments/). A response with a `Status: 200 OK` means that you already added the reaction type to this pull request review comment.", + "operationId": "reactions-create-for-pull-request-review-comment", + "tags": [ + "reactions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/reactions/#create-reaction-for-a-pull-request-review-comment" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.squirrel-girl-preview+json" + }, + "required": true + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "comment_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "comment_id parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "content": { + "description": "The [reaction type](https://developer.github.com/enterprise/2.14/v3/reactions/#reaction-types) to add to the pull request review comment.", + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + } + }, + "required": [ + "content" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "content": { + "type": "string" + }, + "created_at": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://developer.github.com/repos/octocat/:repo/pulls/comments/:comment_id/reactions \\\n -d '{\"content\":\"content\"}'" + }, + { + "lang": "JS", + "source": "octokit.reactions.get({\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 'comment_id',\n content: 'content'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/reactions/create-for-team-discussion-comment.json b/openapi/ghe-2.14/operations/reactions/create-for-team-discussion-comment.json new file mode 100644 index 0000000000..007fa47ea2 --- /dev/null +++ b/openapi/ghe-2.14/operations/reactions/create-for-team-discussion-comment.json @@ -0,0 +1,179 @@ +{ + "summary": "Create reaction for a team discussion comment", + "description": "Create a reaction to a [team discussion comment](https://developer.github.com/enterprise/2.14/v3/teams/discussion_comments/). OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/enterprise/2.14/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.", + "operationId": "reactions-create-for-team-discussion-comment", + "tags": [ + "reactions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/reactions/#create-reaction-for-a-team-discussion-comment" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json" + }, + "required": true + }, + { + "name": "team_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "team_id parameter" + }, + { + "name": "discussion_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "discussion_number parameter" + }, + { + "name": "comment_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "comment_number parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "content": { + "description": "The [reaction type](https://developer.github.com/enterprise/2.14/v3/reactions/#reaction-types) to add to the team discussion comment.", + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + } + }, + "required": [ + "content" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "content": { + "type": "string" + }, + "created_at": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json\" \\\n https://developer.github.com/teams//discussions/:discussion_number/comments/:comment_number/reactions \\\n -d '{\"content\":\"content\"}'" + }, + { + "lang": "JS", + "source": "octokit.reactions.get({\n team_id: 'team_id',\n discussion_number: 'discussion_number',\n comment_number: 'comment_number',\n content: 'content'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/reactions/create-for-team-discussion.json b/openapi/ghe-2.14/operations/reactions/create-for-team-discussion.json new file mode 100644 index 0000000000..4c6e33dbdb --- /dev/null +++ b/openapi/ghe-2.14/operations/reactions/create-for-team-discussion.json @@ -0,0 +1,170 @@ +{ + "summary": "Create reaction for a team discussion", + "description": "Create a reaction to a [team discussion](https://developer.github.com/enterprise/2.14/v3/teams/discussions/). OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/enterprise/2.14/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.", + "operationId": "reactions-create-for-team-discussion", + "tags": [ + "reactions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/reactions/#create-reaction-for-a-team-discussion" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json" + }, + "required": true + }, + { + "name": "team_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "team_id parameter" + }, + { + "name": "discussion_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "discussion_number parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "content": { + "description": "The [reaction type](https://developer.github.com/enterprise/2.14/v3/reactions/#reaction-types) to add to the team discussion.", + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + } + }, + "required": [ + "content" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "content": { + "type": "string" + }, + "created_at": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json\" \\\n https://developer.github.com/teams//discussions/:discussion_number/reactions \\\n -d '{\"content\":\"content\"}'" + }, + { + "lang": "JS", + "source": "octokit.reactions.get({\n team_id: 'team_id',\n discussion_number: 'discussion_number',\n content: 'content'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/reactions/delete.json b/openapi/ghe-2.14/operations/reactions/delete.json new file mode 100644 index 0000000000..61c63c158a --- /dev/null +++ b/openapi/ghe-2.14/operations/reactions/delete.json @@ -0,0 +1,54 @@ +{ + "summary": "Delete a reaction", + "description": "OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/enterprise/2.14/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), when deleting a [team discussion](https://developer.github.com/enterprise/2.14/v3/teams/discussions/) or [team discussion comment](https://developer.github.com/enterprise/2.14/v3/teams/discussion_comments/).", + "operationId": "reactions-delete", + "tags": [ + "reactions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/reactions/#delete-a-reaction" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json" + }, + "required": true + }, + { + "name": "reaction_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "reaction_id parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json\" \\\n https://developer.github.com/reactions/" + }, + { + "lang": "JS", + "source": "octokit.reactions.get({\n reaction_id: 'reaction_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/reactions/list-for-commit-comment.json b/openapi/ghe-2.14/operations/reactions/list-for-commit-comment.json new file mode 100644 index 0000000000..d039b5b94b --- /dev/null +++ b/openapi/ghe-2.14/operations/reactions/list-for-commit-comment.json @@ -0,0 +1,116 @@ +{ + "summary": "List reactions for a commit comment", + "description": "List the reactions to a [commit comment](https://developer.github.com/enterprise/2.14/v3/repos/comments/).", + "operationId": "reactions-list-for-commit-comment", + "tags": [ + "reactions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/reactions/#list-reactions-for-a-commit-comment" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.squirrel-girl-preview+json" + }, + "required": true + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "comment_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "comment_id parameter" + }, + { + "name": "content", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + }, + "required": false, + "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.14/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a commit comment." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://developer.github.com/repos/octocat/:repo/comments/:comment_id/reactions" + }, + { + "lang": "JS", + "source": "octokit.reactions.get({\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 'comment_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/reactions/list-for-issue-comment.json b/openapi/ghe-2.14/operations/reactions/list-for-issue-comment.json new file mode 100644 index 0000000000..eac64aa149 --- /dev/null +++ b/openapi/ghe-2.14/operations/reactions/list-for-issue-comment.json @@ -0,0 +1,116 @@ +{ + "summary": "List reactions for an issue comment", + "description": "List the reactions to an [issue comment](https://developer.github.com/enterprise/2.14/v3/issues/comments/).", + "operationId": "reactions-list-for-issue-comment", + "tags": [ + "reactions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/reactions/#list-reactions-for-an-issue-comment" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.squirrel-girl-preview+json" + }, + "required": true + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "comment_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "comment_id parameter" + }, + { + "name": "content", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + }, + "required": false, + "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.14/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue comment." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://developer.github.com/repos/octocat/:repo/issues/comments/:comment_id/reactions" + }, + { + "lang": "JS", + "source": "octokit.reactions.get({\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 'comment_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/reactions/list-for-issue.json b/openapi/ghe-2.14/operations/reactions/list-for-issue.json new file mode 100644 index 0000000000..58c9587ad8 --- /dev/null +++ b/openapi/ghe-2.14/operations/reactions/list-for-issue.json @@ -0,0 +1,126 @@ +{ + "summary": "List reactions for an issue", + "description": "List the reactions to an [issue](https://developer.github.com/enterprise/2.14/v3/issues/).", + "operationId": "reactions-list-for-issue", + "tags": [ + "reactions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/reactions/#list-reactions-for-an-issue" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.squirrel-girl-preview+json" + }, + "required": true + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "issue_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "issue_number parameter" + }, + { + "name": "content", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + }, + "required": false, + "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.14/v3/reactions/#reaction-types). Omit this parameter to list all reactions to an issue." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://developer.github.com/repos/octocat/:repo/issues/:issue_number/reactions" + }, + { + "lang": "JS", + "source": "octokit.reactions.get({\n owner: 'octocat',\n repo: 'hello-world',\n issue_number: 1\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-04-10", + "note": "\"number\" parameter renamed to \"issue_number\"", + "meta": { + "before": "number", + "after": "issue_number" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/reactions/list-for-pull-request-review-comment.json b/openapi/ghe-2.14/operations/reactions/list-for-pull-request-review-comment.json new file mode 100644 index 0000000000..8bb14bb58b --- /dev/null +++ b/openapi/ghe-2.14/operations/reactions/list-for-pull-request-review-comment.json @@ -0,0 +1,116 @@ +{ + "summary": "List reactions for a pull request review comment", + "description": "List the reactions to a [pull request review comment](https://developer.github.com/enterprise/2.14/v3/pulls/comments/).", + "operationId": "reactions-list-for-pull-request-review-comment", + "tags": [ + "reactions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/reactions/#list-reactions-for-a-pull-request-review-comment" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.squirrel-girl-preview+json" + }, + "required": true + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "comment_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "comment_id parameter" + }, + { + "name": "content", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + }, + "required": false, + "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.14/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a pull request review comment." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://developer.github.com/repos/octocat/:repo/pulls/comments/:comment_id/reactions" + }, + { + "lang": "JS", + "source": "octokit.reactions.get({\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 'comment_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/reactions/list-for-team-discussion-comment.json b/openapi/ghe-2.14/operations/reactions/list-for-team-discussion-comment.json new file mode 100644 index 0000000000..d21d4e1382 --- /dev/null +++ b/openapi/ghe-2.14/operations/reactions/list-for-team-discussion-comment.json @@ -0,0 +1,116 @@ +{ + "summary": "List reactions for a team discussion comment", + "description": "List the reactions to a [team discussion comment](https://developer.github.com/enterprise/2.14/v3/teams/discussion_comments/). OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/enterprise/2.14/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "operationId": "reactions-list-for-team-discussion-comment", + "tags": [ + "reactions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/reactions/#list-reactions-for-a-team-discussion-comment" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json" + }, + "required": true + }, + { + "name": "team_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "team_id parameter" + }, + { + "name": "discussion_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "discussion_number parameter" + }, + { + "name": "comment_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "comment_number parameter" + }, + { + "name": "content", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + }, + "required": false, + "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.14/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion comment." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json\" \\\n https://developer.github.com/teams//discussions/:discussion_number/comments/:comment_number/reactions" + }, + { + "lang": "JS", + "source": "octokit.reactions.get({\n team_id: 'team_id',\n discussion_number: 'discussion_number',\n comment_number: 'comment_number'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/reactions/list-for-team-discussion.json b/openapi/ghe-2.14/operations/reactions/list-for-team-discussion.json new file mode 100644 index 0000000000..806360285c --- /dev/null +++ b/openapi/ghe-2.14/operations/reactions/list-for-team-discussion.json @@ -0,0 +1,107 @@ +{ + "summary": "List reactions for a team discussion", + "description": "List the reactions to a [team discussion](https://developer.github.com/enterprise/2.14/v3/teams/discussions/). OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/enterprise/2.14/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "operationId": "reactions-list-for-team-discussion", + "tags": [ + "reactions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/reactions/#list-reactions-for-a-team-discussion" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json" + }, + "required": true + }, + { + "name": "team_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "team_id parameter" + }, + { + "name": "discussion_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "discussion_number parameter" + }, + { + "name": "content", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + }, + "required": false, + "description": "Returns a single [reaction type](https://developer.github.com/enterprise/2.14/v3/reactions/#reaction-types). Omit this parameter to list all reactions to a team discussion." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.echo-preview+json,application/vnd.github.squirrel-girl-preview+json\" \\\n https://developer.github.com/teams//discussions/:discussion_number/reactions" + }, + { + "lang": "JS", + "source": "octokit.reactions.get({\n team_id: 'team_id',\n discussion_number: 'discussion_number'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/accept-invitation.json b/openapi/ghe-2.14/operations/repos/accept-invitation.json new file mode 100644 index 0000000000..3417c2aeed --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/accept-invitation.json @@ -0,0 +1,53 @@ +{ + "summary": "Accept a repository invitation", + "description": "", + "operationId": "repos-accept-invitation", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/invitations/#accept-a-repository-invitation" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "invitation_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "invitation_id parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPATCH \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/user/repository_invitations/" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n invitation_id: 'invitation_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/add-collaborator.json b/openapi/ghe-2.14/operations/repos/add-collaborator.json new file mode 100644 index 0000000000..73a5419d1a --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/add-collaborator.json @@ -0,0 +1,92 @@ +{ + "summary": "Add user as a collaborator", + "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/enterprise/2.14/v3/#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/enterprise/2.14/v3/#http-verbs).\"", + "operationId": "repos-add-collaborator", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/collaborators/#add-user-as-a-collaborator" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "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.", + "type": "string", + "enum": [ + "pull", + "push", + "admin" + ], + "default": "push" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPUT \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/collaborators/:username" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/add-deploy-key.json b/openapi/ghe-2.14/operations/repos/add-deploy-key.json new file mode 100644 index 0000000000..5978639e46 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/add-deploy-key.json @@ -0,0 +1,117 @@ +{ + "summary": "Add a new deploy key", + "description": "Here's how you can create a read-only deploy key:\n\n", + "operationId": "repos-add-deploy-key", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/keys/#add-a-new-deploy-key" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "description": "A name for the key.", + "type": "string" + }, + "key": { + "description": "The contents of the key.", + "type": "string" + }, + "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/).\"", + "type": "boolean" + } + }, + "required": [ + "key" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "key": { + "type": "string" + }, + "url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "verified": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "read_only": { + "type": "boolean" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/keys \\\n -d '{\"key\":\"key\"}'" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n key: 'key'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/add-protected-branch-admin-enforcement.json b/openapi/ghe-2.14/operations/repos/add-protected-branch-admin-enforcement.json new file mode 100644 index 0000000000..f2d1601ce0 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/add-protected-branch-admin-enforcement.json @@ -0,0 +1,85 @@ +{ + "summary": "Add admin enforcement of protected branch", + "description": "Adding admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", + "operationId": "repos-add-protected-branch-admin-enforcement", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/branches/#add-admin-enforcement-of-protected-branch" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "branch", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "branch parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "enabled": { + "type": "boolean" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/branches/:branch/protection/enforce_admins" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/add-protected-branch-required-signatures.json b/openapi/ghe-2.14/operations/repos/add-protected-branch-required-signatures.json new file mode 100644 index 0000000000..9593617373 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/add-protected-branch-required-signatures.json @@ -0,0 +1,86 @@ +{ + "summary": "Add required signatures of protected branch", + "description": "When 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.", + "operationId": "repos-add-protected-branch-required-signatures", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/branches/#add-required-signatures-of-protected-branch" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.zzzax-preview+json" + }, + "required": true + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "branch", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "branch parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "enabled": { + "type": "boolean" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.zzzax-preview+json\" \\\n https://developer.github.com/repos/octocat/:repo/branches/:branch/protection/required_signatures" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/add-protected-branch-required-status-checks-contexts.json b/openapi/ghe-2.14/operations/repos/add-protected-branch-required-status-checks-contexts.json new file mode 100644 index 0000000000..fde19fe75c --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/add-protected-branch-required-status-checks-contexts.json @@ -0,0 +1,90 @@ +{ + "summary": "Add required status checks contexts of protected branch", + "description": "", + "operationId": "repos-add-protected-branch-required-status-checks-contexts", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/branches/#add-required-status-checks-contexts-of-protected-branch" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "branch", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "branch parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "contexts parameter" + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/branches/:branch/protection/required_status_checks/contexts \\\n -d '{\"contexts\":\"contexts\"}'" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n contexts: 'contexts'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false, + "requestBodyParameterName": "contexts" + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/add-protected-branch-team-restrictions.json b/openapi/ghe-2.14/operations/repos/add-protected-branch-team-restrictions.json new file mode 100644 index 0000000000..21c1eb1082 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/add-protected-branch-team-restrictions.json @@ -0,0 +1,90 @@ +{ + "summary": "Add team restrictions of protected branch", + "description": "Grants the specified teams push access for this branch. If you pass the `hellcat-preview` media type, 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 and teams in total is limited to 100 items. |", + "operationId": "repos-add-protected-branch-team-restrictions", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/branches/#add-team-restrictions-of-protected-branch" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "branch", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "branch parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "teams parameter" + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/branches/:branch/protection/restrictions/teams \\\n -d '{\"teams\":\"teams\"}'" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n teams: 'teams'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false, + "requestBodyParameterName": "teams" + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/add-protected-branch-user-restrictions.json b/openapi/ghe-2.14/operations/repos/add-protected-branch-user-restrictions.json new file mode 100644 index 0000000000..db85e9b79f --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/add-protected-branch-user-restrictions.json @@ -0,0 +1,90 @@ +{ + "summary": "Add user restrictions of protected branch", + "description": "Grants 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 and teams in total is limited to 100 items. |", + "operationId": "repos-add-protected-branch-user-restrictions", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/branches/#add-user-restrictions-of-protected-branch" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "branch", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "branch parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "users parameter" + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/branches/:branch/protection/restrictions/users \\\n -d '{\"users\":\"users\"}'" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n users: 'users'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false, + "requestBodyParameterName": "users" + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/check-collaborator.json b/openapi/ghe-2.14/operations/repos/check-collaborator.json new file mode 100644 index 0000000000..321989dd76 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/check-collaborator.json @@ -0,0 +1,71 @@ +{ + "summary": "Check if a user is a collaborator", + "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\nIf you pass the `hellcat-preview` media type, team members will include the members of child teams.", + "operationId": "repos-check-collaborator", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/collaborators/#check-if-a-user-is-a-collaborator" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/collaborators/:username" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/compare-commits.json b/openapi/ghe-2.14/operations/repos/compare-commits.json new file mode 100644 index 0000000000..def847e372 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/compare-commits.json @@ -0,0 +1,80 @@ +{ + "summary": "Compare two commits", + "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/enterprise/2.14/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/enterprise/2.14/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. |", + "operationId": "repos-compare-commits", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/commits/#compare-two-commits" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "base", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "base parameter" + }, + { + "name": "head", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "head parameter" + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/compare/:base...:head" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n base: 'base',\n head: 'head'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/create-commit-comment.json b/openapi/ghe-2.14/operations/repos/create-commit-comment.json new file mode 100644 index 0000000000..79592caa21 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/create-commit-comment.json @@ -0,0 +1,211 @@ +{ + "summary": "Create a commit comment", + "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/enterprise/2.14/v3/#abuse-rate-limits)\" for details.", + "operationId": "repos-create-commit-comment", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/comments/#create-a-commit-comment" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "commit_sha", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "commit_sha parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "description": "The contents of the comment.", + "type": "string" + }, + "path": { + "description": "Relative path of the file to comment on.", + "type": "string" + }, + "position": { + "description": "Line index in the diff to comment on.", + "type": "integer" + }, + "line": { + "description": "**Deprecated**. Use **position** parameter instead. Line number in the file to comment on.", + "type": "integer" + } + }, + "required": [ + "body" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "html_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "body": { + "type": "string" + }, + "path": { + "type": "string" + }, + "position": { + "type": "number" + }, + "line": { + "type": "number" + }, + "commit_id": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/commits/:commit_sha/comments \\\n -d '{\"body\":\"body\"}'" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n commit_sha: 'commit_sha',\n body: 'body'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-06-07", + "note": "\"sha\" parameter renamed to \"commit_sha\"", + "meta": { + "before": "sha", + "after": "commit_sha" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/repos/create-deployment-status.json b/openapi/ghe-2.14/operations/repos/create-deployment-status.json new file mode 100644 index 0000000000..f3a7b6f64c --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/create-deployment-status.json @@ -0,0 +1,224 @@ +{ + "summary": "Create a deployment status", + "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.", + "operationId": "repos-create-deployment-status", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/deployments/#create-a-deployment-status" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "deployment_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "deployment_id parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "state": { + "description": "The state of the status. Can be one of `error`, `failure`, `inactive`, `pending`, or `success`. **Note:** To use the `inactive` state, you must provide the [`application/vnd.github.ant-man-preview+json`](https://developer.github.com/enterprise/2.14/v3/previews/#enhanced-deployments) custom media type.", + "type": "string", + "enum": [ + "error", + "failure", + "inactive", + "pending", + "success" + ] + }, + "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`.", + "type": "string", + "default": "" + }, + "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.", + "type": "string", + "default": "" + }, + "description": { + "description": "A short description of the status. The maximum description length is 140 characters.", + "type": "string", + "default": "" + }, + "environment_url": { + "description": "Sets the URL for accessing your environment.", + "type": "string", + "default": "" + }, + "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.", + "type": "boolean", + "default": true + } + }, + "required": [ + "state" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "state": { + "type": "string" + }, + "creator": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "description": { + "type": "string" + }, + "target_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "deployment_url": { + "type": "string" + }, + "repository_url": { + "type": "string" + }, + "environment_url": { + "type": "string" + }, + "log_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/deployments/:deployment_id/statuses \\\n -d '{\"state\":\"state\"}'" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n deployment_id: 'deployment_id',\n state: 'state'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/create-deployment.json b/openapi/ghe-2.14/operations/repos/create-deployment.json new file mode 100644 index 0000000000..3c60a9024c --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/create-deployment.json @@ -0,0 +1,121 @@ +{ + "summary": "Create a deployment", + "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/enterprise/2.14/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`.", + "operationId": "repos-create-deployment", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/deployments/#create-a-deployment" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "ref": { + "description": "The ref to deploy. This can be a branch, tag, or SHA.", + "type": "string" + }, + "task": { + "description": "Specifies a task to execute (e.g., `deploy` or `deploy:migrations`).", + "type": "string", + "default": "deploy" + }, + "auto_merge": { + "description": "Attempts to automatically merge the default branch into the requested ref, if it's behind the default branch.", + "type": "boolean", + "default": true + }, + "required_contexts": { + "description": "The [status](https://developer.github.com/enterprise/2.14/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.", + "type": "array", + "items": { + "type": "string" + } + }, + "payload": { + "description": "JSON payload with extra information about the deployment.", + "type": "string", + "default": "" + }, + "environment": { + "description": "Name for the target deployment environment (e.g., `production`, `staging`, `qa`).", + "type": "string", + "default": "production" + }, + "description": { + "description": "Short description of the deployment.", + "type": "string", + "default": "" + }, + "transient_environment": { + "description": "Specifies if the given environment is specific to the deployment and will no longer exist at some point in the future.", + "type": "boolean", + "default": false + }, + "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.", + "type": "boolean" + } + }, + "required": [ + "ref" + ] + } + } + } + }, + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/deployments \\\n -d '{\"ref\":\"ref\"}'" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/create-for-authenticated-user.json b/openapi/ghe-2.14/operations/repos/create-for-authenticated-user.json new file mode 100644 index 0000000000..53108a5c0d --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/create-for-authenticated-user.json @@ -0,0 +1,428 @@ +{ + "summary": "Create a new repository for the authenticated user", + "description": "**Note**: There are two endpoints for creating a repository: one to create a repository on a user account, and one to create a repository in an organization. The organization endpoint is fully enabled for [GitHub Apps](https://developer.github.com/enterprise/2.14/v3/apps/available-endpoints/), whereas the user endpoint is enabled only for [user-to-server requests](https://developer.github.com/enterprise/2.14/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#user-to-server-requests).\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://developer.github.com/enterprise/2.14/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", + "operationId": "repos-create-for-authenticated-user", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/#create" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "description": { + "description": "A short description of the repository.", + "type": "string" + }, + "homepage": { + "description": "A URL with more information about the repository.", + "type": "string" + }, + "private": { + "description": "Either `true` to create a private repository or `false` to create a public one. Creating private repositories requires a paid GitHub account.", + "type": "boolean", + "default": false + }, + "has_issues": { + "description": "Either `true` to enable issues for this repository or `false` to disable them.", + "type": "boolean", + "default": true + }, + "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.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", + "type": "boolean", + "default": true + }, + "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.", + "type": "integer" + }, + "auto_init": { + "description": "Pass `true` to create an initial commit with empty README.", + "type": "boolean", + "default": false + }, + "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\".", + "type": "string" + }, + "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\".", + "type": "string" + }, + "allow_squash_merge": { + "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", + "type": "boolean", + "default": true + }, + "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.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", + "type": "boolean", + "default": true + } + }, + "required": [ + "name" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "number" + }, + "stargazers_count": { + "type": "number" + }, + "watchers_count": { + "type": "number" + }, + "size": { + "type": "number" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "number" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "number" + }, + "network_count": { + "type": "number" + }, + "anonymous_access_enabled": { + "type": "boolean" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/user/repos \\\n -d '{\"name\":\"name\"}'" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n name: 'name'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/create-fork.json b/openapi/ghe-2.14/operations/repos/create-fork.json new file mode 100644 index 0000000000..a280ea8b5f --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/create-fork.json @@ -0,0 +1,383 @@ +{ + "summary": "Create a fork", + "description": "Create a fork for the authenticated user.\n\n**Note**: Forking a Repository happens asynchronously. You may have to wait a short period of time before you can access the git objects. If this takes longer than 5 minutes, be sure to contact [GitHub Enterprise Support](https://enterprise.github.com/support).", + "operationId": "repos-create-fork", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/forks/#create-a-fork" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "organization": { + "description": "Optional parameter to specify the organization name if forking into an organization.", + "type": "string" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "number" + }, + "stargazers_count": { + "type": "number" + }, + "watchers_count": { + "type": "number" + }, + "size": { + "type": "number" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "number" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "number" + }, + "network_count": { + "type": "number" + }, + "anonymous_access_enabled": { + "type": "boolean" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/forks" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/create-hook.json b/openapi/ghe-2.14/operations/repos/create-hook.json new file mode 100644 index 0000000000..01313c2074 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/create-hook.json @@ -0,0 +1,190 @@ +{ + "summary": "Create a hook", + "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\n**Note:** GitHub Enterprise release 2.17 and higher will discontinue allowing admins to install new GitHub Services, and existing services will stop working in GitHub Enterprise release 2.20 and higher. You can use the [Replacing GitHub Services guide](https://developer.github.com/enterprise/2.14/v3/guides/replacing-github-services) to help you update your services to webhooks.\n\nHere's how you can create a hook that posts payloads in JSON format:", + "operationId": "repos-create-hook", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/hooks/#create-a-hook" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Use `web` to create a webhook. To create a GitHub Service, use the name of a valid service. You can use [/hooks](https://api.github.com/hooks) for the list of valid service names. **Note:** GitHub Enterprise release 2.17 and higher will discontinue allowing admins to install GitHub Services. Please see the [Replacing GitHub Services guide](https://developer.github.com/enterprise/2.14/v3/guides/replacing-github-services) for details.", + "type": "string" + }, + "config": { + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.14/v3/repos/hooks/#create-hook-config-params).", + "type": "object", + "properties": { + "url": { + "description": "The URL to which the payloads will be delivered.", + "type": "string" + }, + "content_type": { + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "type": "string" + }, + "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/enterprise/2.14/webhooks/#delivery-headers) header.", + "type": "string" + }, + "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.**", + "type": "string" + } + }, + "required": [ + "url" + ] + }, + "events": { + "description": "Determines what [events](https://developer.github.com/enterprise/2.14/v3/activity/events/types/) the hook is triggered for.", + "type": "array", + "default": [ + "push" + ], + "items": { + "type": "string" + } + }, + "active": { + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "type": "boolean", + "default": true + } + }, + "required": [ + "name", + "config" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "type": { + "type": "string" + }, + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "config": { + "type": "object", + "properties": { + "content_type": { + "type": "string" + }, + "insecure_ssl": { + "type": "string" + }, + "url": { + "type": "string" + } + } + }, + "updated_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "test_url": { + "type": "string" + }, + "ping_url": { + "type": "string" + }, + "last_response": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "status": { + "type": "string" + }, + "message": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/hooks \\\n -d '{\"name\":\"name\",\"config\":\"config\",\"config.url\":\"config.url\"}'" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n name: 'name',\n config: 'config',\n 'config.url': 'config.url'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/create-in-org.json b/openapi/ghe-2.14/operations/repos/create-in-org.json new file mode 100644 index 0000000000..fce12e9001 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/create-in-org.json @@ -0,0 +1,437 @@ +{ + "summary": "Create a new repository in this organization", + "description": "**Note**: There are two endpoints for creating a repository: one to create a repository on a user account, and one to create a repository in an organization. The organization endpoint is fully enabled for [GitHub Apps](https://developer.github.com/enterprise/2.14/v3/apps/available-endpoints/), whereas the user endpoint is enabled only for [user-to-server requests](https://developer.github.com/enterprise/2.14/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps/#user-to-server-requests).\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://developer.github.com/enterprise/2.14/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", + "operationId": "repos-create-in-org", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/#create" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "org", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "org parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "description": { + "description": "A short description of the repository.", + "type": "string" + }, + "homepage": { + "description": "A URL with more information about the repository.", + "type": "string" + }, + "private": { + "description": "Either `true` to create a private repository or `false` to create a public one. Creating private repositories requires a paid GitHub account.", + "type": "boolean", + "default": false + }, + "has_issues": { + "description": "Either `true` to enable issues for this repository or `false` to disable them.", + "type": "boolean", + "default": true + }, + "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.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", + "type": "boolean", + "default": true + }, + "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.", + "type": "integer" + }, + "auto_init": { + "description": "Pass `true` to create an initial commit with empty README.", + "type": "boolean", + "default": false + }, + "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\".", + "type": "string" + }, + "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\".", + "type": "string" + }, + "allow_squash_merge": { + "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", + "type": "boolean", + "default": true + }, + "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.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", + "type": "boolean", + "default": true + } + }, + "required": [ + "name" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "number" + }, + "stargazers_count": { + "type": "number" + }, + "watchers_count": { + "type": "number" + }, + "size": { + "type": "number" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "number" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "number" + }, + "network_count": { + "type": "number" + }, + "anonymous_access_enabled": { + "type": "boolean" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/orgs//repos \\\n -d '{\"name\":\"name\"}'" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n org: 'org',\n name: 'name'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/create-or-update-file.json b/openapi/ghe-2.14/operations/repos/create-or-update-file.json new file mode 100644 index 0000000000..0433dca069 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/create-or-update-file.json @@ -0,0 +1,299 @@ +{ + "summary": "Create or update a file", + "description": "Creates a new file or updates an existing file in a repository.", + "operationId": "repos-create-or-update-file", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/contents/#create-or-update-a-file" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "path", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "path parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "description": "The commit message.", + "type": "string" + }, + "content": { + "description": "The new file content, using Base64 encoding.", + "type": "string" + }, + "sha": { + "description": "**Required if you are updating a file**. The blob SHA of the file being replaced.", + "type": "string" + }, + "branch": { + "description": "The branch name. Default: the repository’s default branch (usually `master`)", + "type": "string" + }, + "committer": { + "description": "The person that committed the file. Default: the authenticated user.", + "type": "object", + "properties": { + "name": { + "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "type": "string" + }, + "email": { + "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "type": "string" + } + }, + "required": [ + "name", + "email" + ] + }, + "author": { + "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", + "type": "object", + "properties": { + "name": { + "description": "The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "type": "string" + }, + "email": { + "description": "The email of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.", + "type": "string" + } + }, + "required": [ + "name", + "email" + ] + } + }, + "required": [ + "message", + "content" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "content": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "size": { + "type": "number" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "download_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "_links": { + "type": "object", + "properties": { + "self": { + "type": "string" + }, + "git": { + "type": "string" + }, + "html": { + "type": "string" + } + } + } + } + }, + "commit": { + "type": "object", + "properties": { + "sha": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "author": { + "type": "object", + "properties": { + "date": { + "type": "string" + }, + "name": { + "type": "string" + }, + "email": { + "type": "string" + } + } + }, + "committer": { + "type": "object", + "properties": { + "date": { + "type": "string" + }, + "name": { + "type": "string" + }, + "email": { + "type": "string" + } + } + }, + "message": { + "type": "string" + }, + "tree": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "sha": { + "type": "string" + } + } + }, + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "sha": { + "type": "string" + } + } + } + }, + "verification": { + "type": "object", + "properties": { + "verified": { + "type": "boolean" + }, + "reason": { + "type": "string" + }, + "signature": { + "type": "string" + }, + "payload": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPUT \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/contents/:path \\\n -d '{\"message\":\"message\",\"content\":\"content\",\"committer.name\":\"committer.name\",\"committer.email\":\"committer.email\",\"author.name\":\"author.name\",\"author.email\":\"author.email\"}'" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n path: 'path',\n message: 'message',\n content: 'content',\n 'committer.name': 'committer.name',\n 'committer.email': 'committer.email',\n 'author.name': 'author.name',\n 'author.email': 'author.email'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "idName", + "date": "2019-06-07", + "note": "\"Create a file\" replaced by \"Create or update a file\"", + "meta": { + "before": { + "idName": "create-file" + }, + "after": { + "idName": "create-or-update-file" + } + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/repos/create-release.json b/openapi/ghe-2.14/operations/repos/create-release.json new file mode 100644 index 0000000000..4400366171 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/create-release.json @@ -0,0 +1,221 @@ +{ + "summary": "Create a release", + "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/enterprise/2.14/v3/#abuse-rate-limits)\" for details.", + "operationId": "repos-create-release", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/releases/#create-a-release" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "tag_name": { + "description": "The name of the tag.", + "type": "string" + }, + "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`).", + "type": "string" + }, + "name": { + "description": "The name of the release.", + "type": "string" + }, + "body": { + "description": "Text describing the contents of the tag.", + "type": "string" + }, + "draft": { + "description": "`true` to create a draft (unpublished) release, `false` to create a published one.", + "type": "boolean", + "default": false + }, + "prerelease": { + "description": "`true` to identify the release as a prerelease. `false` to identify the release as a full release.", + "type": "boolean", + "default": false + } + }, + "required": [ + "tag_name" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "assets_url": { + "type": "string" + }, + "upload_url": { + "type": "string" + }, + "tarball_url": { + "type": "string" + }, + "zipball_url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "tag_name": { + "type": "string" + }, + "target_commitish": { + "type": "string" + }, + "name": { + "type": "string" + }, + "body": { + "type": "string" + }, + "draft": { + "type": "boolean" + }, + "prerelease": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "published_at": { + "type": "string" + }, + "author": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "assets": { + "type": "array", + "items": {} + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/releases \\\n -d '{\"tag_name\":\"tag_name\"}'" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n tag_name: 'tag_name'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/create-status.json b/openapi/ghe-2.14/operations/repos/create-status.json new file mode 100644 index 0000000000..46ff71b26b --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/create-status.json @@ -0,0 +1,205 @@ +{ + "summary": "Create a status", + "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.", + "operationId": "repos-create-status", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/statuses/#create-a-status" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "sha", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "sha parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "state": { + "description": "The state of the status. Can be one of `error`, `failure`, `pending`, or `success`.", + "type": "string", + "enum": [ + "error", + "failure", + "pending", + "success" + ] + }, + "target_url": { + "description": "The target URL to associate with this status. This URL will be linked from the GitHub Enterprise 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`", + "type": "string" + }, + "description": { + "description": "A short description of the status.", + "type": "string" + }, + "context": { + "description": "A string label to differentiate this status from the status of other systems.", + "type": "string", + "default": "default" + } + }, + "required": [ + "state" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "state": { + "type": "string" + }, + "description": { + "type": "string" + }, + "target_url": { + "type": "string" + }, + "context": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "creator": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/statuses/:sha \\\n -d '{\"state\":\"state\"}'" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n sha: 'sha',\n state: 'state'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/decline-invitation.json b/openapi/ghe-2.14/operations/repos/decline-invitation.json new file mode 100644 index 0000000000..adbc820f9f --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/decline-invitation.json @@ -0,0 +1,53 @@ +{ + "summary": "Decline a repository invitation", + "description": "", + "operationId": "repos-decline-invitation", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/invitations/#decline-a-repository-invitation" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "invitation_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "invitation_id parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/user/repository_invitations/" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n invitation_id: 'invitation_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/delete-commit-comment.json b/openapi/ghe-2.14/operations/repos/delete-commit-comment.json new file mode 100644 index 0000000000..18148aaa88 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/delete-commit-comment.json @@ -0,0 +1,71 @@ +{ + "summary": "Delete a commit comment", + "description": "", + "operationId": "repos-delete-commit-comment", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/comments/#delete-a-commit-comment" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "comment_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "comment_id parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/comments/:comment_id" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 'comment_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/delete-download.json b/openapi/ghe-2.14/operations/repos/delete-download.json new file mode 100644 index 0000000000..8b44bb5e9b --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/delete-download.json @@ -0,0 +1,71 @@ +{ + "summary": "Delete a download", + "description": "", + "operationId": "repos-delete-download", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/downloads/#delete-a-download" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "download_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "download_id parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/downloads/:download_id" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n download_id: 'download_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/delete-file.json b/openapi/ghe-2.14/operations/repos/delete-file.json new file mode 100644 index 0000000000..861968e2a4 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/delete-file.json @@ -0,0 +1,230 @@ +{ + "summary": "Delete a file", + "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.", + "operationId": "repos-delete-file", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/contents/#delete-a-file" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "path", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "path parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "description": "The commit message.", + "type": "string" + }, + "sha": { + "description": "The blob SHA of the file being replaced.", + "type": "string" + }, + "branch": { + "description": "The branch name. Default: the repository’s default branch (usually `master`)", + "type": "string" + }, + "committer": { + "description": "object containing information about the committer.", + "type": "object", + "properties": { + "name": { + "description": "The name of the author (or committer) of the commit", + "type": "string" + }, + "email": { + "description": "The email of the author (or committer) of the commit", + "type": "string" + } + } + }, + "author": { + "description": "object containing information about the author.", + "type": "object", + "properties": { + "name": { + "description": "The name of the author (or committer) of the commit", + "type": "string" + }, + "email": { + "description": "The email of the author (or committer) of the commit", + "type": "string" + } + } + } + }, + "required": [ + "message", + "sha" + ] + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "content": { + "type": "string" + }, + "commit": { + "type": "object", + "properties": { + "sha": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "author": { + "type": "object", + "properties": { + "date": { + "type": "string" + }, + "name": { + "type": "string" + }, + "email": { + "type": "string" + } + } + }, + "committer": { + "type": "object", + "properties": { + "date": { + "type": "string" + }, + "name": { + "type": "string" + }, + "email": { + "type": "string" + } + } + }, + "message": { + "type": "string" + }, + "tree": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "sha": { + "type": "string" + } + } + }, + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "sha": { + "type": "string" + } + } + } + }, + "verification": { + "type": "object", + "properties": { + "verified": { + "type": "boolean" + }, + "reason": { + "type": "string" + }, + "signature": { + "type": "string" + }, + "payload": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/contents/:path \\\n -d '{\"message\":\"message\",\"sha\":\"sha\"}'" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n path: 'path',\n message: 'message',\n sha: 'sha'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/delete-hook.json b/openapi/ghe-2.14/operations/repos/delete-hook.json new file mode 100644 index 0000000000..47efe51b0e --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/delete-hook.json @@ -0,0 +1,71 @@ +{ + "summary": "Delete a hook", + "description": "", + "operationId": "repos-delete-hook", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/hooks/#delete-a-hook" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "hook_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "hook_id parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/hooks/:hook_id" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n hook_id: 'hook_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/delete-invitation.json b/openapi/ghe-2.14/operations/repos/delete-invitation.json new file mode 100644 index 0000000000..9c364ee422 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/delete-invitation.json @@ -0,0 +1,71 @@ +{ + "summary": "Delete a repository invitation", + "description": "", + "operationId": "repos-delete-invitation", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/invitations/#delete-a-repository-invitation" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "invitation_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "invitation_id parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/invitations/:invitation_id" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n invitation_id: 'invitation_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/delete-release-asset.json b/openapi/ghe-2.14/operations/repos/delete-release-asset.json new file mode 100644 index 0000000000..81fe4e9d22 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/delete-release-asset.json @@ -0,0 +1,71 @@ +{ + "summary": "Delete a release asset", + "description": "", + "operationId": "repos-delete-release-asset", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/releases/#delete-a-release-asset" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "asset_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "asset_id parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/releases/assets/:asset_id" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n asset_id: 'asset_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/delete-release.json b/openapi/ghe-2.14/operations/repos/delete-release.json new file mode 100644 index 0000000000..67d27efa45 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/delete-release.json @@ -0,0 +1,71 @@ +{ + "summary": "Delete a release", + "description": "Users with push access to the repository can delete a release.", + "operationId": "repos-delete-release", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/releases/#delete-a-release" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "release_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "release_id parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/releases/:release_id" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n release_id: 'release_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/delete.json b/openapi/ghe-2.14/operations/repos/delete.json new file mode 100644 index 0000000000..227a849e61 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/delete.json @@ -0,0 +1,62 @@ +{ + "summary": "Delete a repository", + "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:\n\nIf a site admin has configured the enterprise appliance to prevent users from deleting organization-owned repositories, a user will get this response:", + "operationId": "repos-delete", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/#delete-a-repository" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/get-archive-link.json b/openapi/ghe-2.14/operations/repos/get-archive-link.json new file mode 100644 index 0000000000..37e95532c9 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/get-archive-link.json @@ -0,0 +1,85 @@ +{ + "summary": "Get archive link", + "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", + "operationId": "repos-get-archive-link", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/contents/#get-archive-link" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "archive_format", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "archive_format parameter" + }, + { + "name": "ref", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "ref parameter" + } + ], + "responses": { + "302": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/:archive_format/:ref" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n archive_format: 'archive_format',\n ref: 'ref'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/get-branch-protection.json b/openapi/ghe-2.14/operations/repos/get-branch-protection.json new file mode 100644 index 0000000000..b008a095de --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/get-branch-protection.json @@ -0,0 +1,364 @@ +{ + "summary": "Get branch protection", + "description": "", + "operationId": "repos-get-branch-protection", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/branches/#get-branch-protection" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "branch", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "branch parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "required_status_checks": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "strict": { + "type": "boolean" + }, + "contexts": { + "type": "array", + "items": { + "type": "string" + } + }, + "contexts_url": { + "type": "string" + } + } + }, + "enforce_admins": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "enabled": { + "type": "boolean" + } + } + }, + "required_pull_request_reviews": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "dismissal_restrictions": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "users_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + }, + "teams": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string" + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": "string" + } + } + } + } + } + }, + "dismiss_stale_reviews": { + "type": "boolean" + }, + "require_code_owner_reviews": { + "type": "boolean" + }, + "required_approving_review_count": { + "type": "number" + } + } + }, + "restrictions": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "users_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + }, + "teams": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string" + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/branches/:branch/protection" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/get-branch.json b/openapi/ghe-2.14/operations/repos/get-branch.json new file mode 100644 index 0000000000..f5f2343e20 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/get-branch.json @@ -0,0 +1,260 @@ +{ + "summary": "Get branch", + "description": "", + "operationId": "repos-get-branch", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/branches/#get-branch" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "branch", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "branch parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "type": "string" + }, + "commit": { + "type": "object", + "properties": { + "sha": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "commit": { + "type": "object", + "properties": { + "author": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "date": { + "type": "string" + }, + "email": { + "type": "string" + } + } + }, + "url": { + "type": "string" + }, + "message": { + "type": "string" + }, + "tree": { + "type": "object", + "properties": { + "sha": { + "type": "string" + }, + "url": { + "type": "string" + } + } + }, + "committer": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "date": { + "type": "string" + }, + "email": { + "type": "string" + } + } + }, + "verification": { + "type": "object", + "properties": { + "verified": { + "type": "boolean" + }, + "reason": { + "type": "string" + }, + "signature": { + "type": "string" + }, + "payload": { + "type": "string" + } + } + } + } + }, + "author": { + "type": "object", + "properties": { + "gravatar_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "login": { + "type": "string" + } + } + }, + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sha": { + "type": "string" + }, + "url": { + "type": "string" + } + }, + "required": [ + "sha", + "url" + ] + } + }, + "url": { + "type": "string" + }, + "committer": { + "type": "object", + "properties": { + "gravatar_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "login": { + "type": "string" + } + } + } + } + }, + "_links": { + "type": "object", + "properties": { + "html": { + "type": "string" + }, + "self": { + "type": "string" + } + } + }, + "protected": { + "type": "boolean" + }, + "protection": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean" + }, + "required_status_checks": { + "type": "object", + "properties": { + "enforcement_level": { + "type": "string" + }, + "contexts": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "protection_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/branches/:branch" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/get-code-frequency-stats.json b/openapi/ghe-2.14/operations/repos/get-code-frequency-stats.json new file mode 100644 index 0000000000..5e0773cbab --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/get-code-frequency-stats.json @@ -0,0 +1,67 @@ +{ + "summary": "Get the number of additions and deletions per week", + "description": "Returns a weekly aggregate of the number of additions and deletions pushed to a repository.\n\n", + "operationId": "repos-get-code-frequency-stats", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/statistics/#get-the-number-of-additions-and-deletions-per-week" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/stats/code_frequency" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/get-collaborator-permission-level.json b/openapi/ghe-2.14/operations/repos/get-collaborator-permission-level.json new file mode 100644 index 0000000000..94d002e128 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/get-collaborator-permission-level.json @@ -0,0 +1,71 @@ +{ + "summary": "Review a user's permission level", + "description": "Possible values for the `permission` key: `admin`, `write`, `read`, `none`.", + "operationId": "repos-get-collaborator-permission-level", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/collaborators/#review-a-users-permission-level" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/collaborators/:username/permission" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/get-combined-status-for-ref.json b/openapi/ghe-2.14/operations/repos/get-combined-status-for-ref.json new file mode 100644 index 0000000000..07fbcec825 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/get-combined-status-for-ref.json @@ -0,0 +1,346 @@ +{ + "summary": "Get the combined status for a specific ref", + "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/enterprise/2.14/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`", + "operationId": "repos-get-combined-status-for-ref", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "ref", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "ref parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "state": { + "type": "string" + }, + "statuses": { + "type": "array", + "items": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "state": { + "type": "string" + }, + "description": { + "type": "string" + }, + "target_url": { + "type": "string" + }, + "context": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + }, + "required": [ + "url", + "avatar_url", + "id", + "node_id", + "state", + "description", + "target_url", + "context", + "created_at", + "updated_at" + ] + } + }, + "sha": { + "type": "string" + }, + "total_count": { + "type": "number" + }, + "repository": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + } + } + }, + "commit_url": { + "type": "string" + }, + "url": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/commits/:ref/status" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/get-commit-activity-stats.json b/openapi/ghe-2.14/operations/repos/get-commit-activity-stats.json new file mode 100644 index 0000000000..7dcc8a93a9 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/get-commit-activity-stats.json @@ -0,0 +1,67 @@ +{ + "summary": "Get the last year of commit activity data", + "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", + "operationId": "repos-get-commit-activity-stats", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/statistics/#get-the-last-year-of-commit-activity-data" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/stats/commit_activity" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/get-commit-comment.json b/openapi/ghe-2.14/operations/repos/get-commit-comment.json new file mode 100644 index 0000000000..3b15e6a4c4 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/get-commit-comment.json @@ -0,0 +1,171 @@ +{ + "summary": "Get a single commit comment", + "description": "", + "operationId": "repos-get-commit-comment", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/comments/#get-a-single-commit-comment" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "comment_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "comment_id parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "html_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "body": { + "type": "string" + }, + "path": { + "type": "string" + }, + "position": { + "type": "number" + }, + "line": { + "type": "number" + }, + "commit_id": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/comments/:comment_id" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 'comment_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/get-commit.json b/openapi/ghe-2.14/operations/repos/get-commit.json new file mode 100644 index 0000000000..8c477188b3 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/get-commit.json @@ -0,0 +1,361 @@ +{ + "summary": "Get a single commit", + "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/enterprise/2.14/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/enterprise/2.14/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", + "operationId": "repos-get-commit", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/commits/#get-a-single-commit" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "ref", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "ref parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commit": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "author": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "email": { + "type": "string" + }, + "date": { + "type": "string" + } + } + }, + "committer": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "email": { + "type": "string" + }, + "date": { + "type": "string" + } + } + }, + "message": { + "type": "string" + }, + "tree": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "sha": { + "type": "string" + } + } + }, + "comment_count": { + "type": "number" + }, + "verification": { + "type": "object", + "properties": { + "verified": { + "type": "boolean" + }, + "reason": { + "type": "string" + }, + "signature": { + "type": "string" + }, + "payload": { + "type": "string" + } + } + } + } + }, + "author": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "committer": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "parents": { + "type": "array", + "items": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "sha": { + "type": "string" + } + } + } + }, + "stats": { + "type": "object", + "properties": { + "additions": { + "type": "number" + }, + "deletions": { + "type": "number" + }, + "total": { + "type": "number" + } + } + }, + "files": { + "type": "array", + "items": { + "type": "object", + "properties": { + "filename": { + "type": "string" + }, + "additions": { + "type": "number" + }, + "deletions": { + "type": "number" + }, + "changes": { + "type": "number" + }, + "status": { + "type": "string" + }, + "raw_url": { + "type": "string" + }, + "blob_url": { + "type": "string" + }, + "patch": { + "type": "string" + } + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/commits/:ref" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-04-10", + "note": "\"sha\" parameter renamed to \"ref\"", + "meta": { + "before": "sha", + "after": "commit_sha" + } + }, + { + "type": "parameter", + "date": "2019-06-21", + "note": "\"commit_sha\" parameter renamed to \"ref\"", + "meta": { + "before": "commit_sha", + "after": "ref" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/repos/get-contents.json b/openapi/ghe-2.14/operations/repos/get-contents.json new file mode 100644 index 0000000000..0e6b9e6650 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/get-contents.json @@ -0,0 +1,80 @@ +{ + "summary": "Get contents", + "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/enterprise/2.14/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/enterprise/2.14/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/enterprise/2.14/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/enterprise/2.14/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/enterprise/2.14/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.", + "operationId": "repos-get-contents", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/contents/#get-contents" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "path", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "path parameter" + }, + { + "name": "ref", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)" + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/contents/:path" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n path: 'path'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/get-contributors-stats.json b/openapi/ghe-2.14/operations/repos/get-contributors-stats.json new file mode 100644 index 0000000000..0d1a9a9e3f --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/get-contributors-stats.json @@ -0,0 +1,67 @@ +{ + "summary": "Get contributors list with additions, deletions, and commit counts", + "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", + "operationId": "repos-get-contributors-stats", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/statistics/#get-contributors-list-with-additions-deletions-and-commit-counts" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/stats/contributors" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/get-deploy-key.json b/openapi/ghe-2.14/operations/repos/get-deploy-key.json new file mode 100644 index 0000000000..973387b923 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/get-deploy-key.json @@ -0,0 +1,100 @@ +{ + "summary": "Get a deploy key", + "description": "", + "operationId": "repos-get-deploy-key", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/keys/#get-a-deploy-key" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "key_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "key_id parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "key": { + "type": "string" + }, + "url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "verified": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "read_only": { + "type": "boolean" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/keys/:key_id" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n key_id: 'key_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/get-deployment-status.json b/openapi/ghe-2.14/operations/repos/get-deployment-status.json new file mode 100644 index 0000000000..3be7e8a48f --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/get-deployment-status.json @@ -0,0 +1,183 @@ +{ + "summary": "Get a single deployment status", + "description": "Users with pull access can view a deployment status for a deployment:", + "operationId": "repos-get-deployment-status", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/deployments/#get-a-single-deployment-status" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "deployment_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "deployment_id parameter" + }, + { + "name": "status_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "status_id parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "state": { + "type": "string" + }, + "creator": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "description": { + "type": "string" + }, + "target_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "deployment_url": { + "type": "string" + }, + "repository_url": { + "type": "string" + }, + "environment_url": { + "type": "string" + }, + "log_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/deployments/:deployment_id/statuses/:status_id" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n deployment_id: 'deployment_id',\n status_id: 'status_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/get-deployment.json b/openapi/ghe-2.14/operations/repos/get-deployment.json new file mode 100644 index 0000000000..3adb60bab9 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/get-deployment.json @@ -0,0 +1,188 @@ +{ + "summary": "Get a single deployment", + "description": "", + "operationId": "repos-get-deployment", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/deployments/#get-a-single-deployment" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "deployment_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "deployment_id parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "ref": { + "type": "string" + }, + "task": { + "type": "string" + }, + "payload": { + "type": "object", + "properties": { + "deploy": { + "type": "string" + } + } + }, + "environment": { + "type": "string" + }, + "description": { + "type": "string" + }, + "creator": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "repository_url": { + "type": "string" + }, + "transient_environment": { + "type": "boolean" + }, + "production_environment": { + "type": "boolean" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/deployments/:deployment_id" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n deployment_id: 'deployment_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/get-download.json b/openapi/ghe-2.14/operations/repos/get-download.json new file mode 100644 index 0000000000..a8a0667161 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/get-download.json @@ -0,0 +1,103 @@ +{ + "summary": "Get a single download", + "description": "", + "operationId": "repos-get-download", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/downloads/#get-a-single-download" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "download_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "download_id parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "size": { + "type": "number" + }, + "download_count": { + "type": "number" + }, + "content_type": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/downloads/:download_id" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n download_id: 'download_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/get-hook.json b/openapi/ghe-2.14/operations/repos/get-hook.json new file mode 100644 index 0000000000..e7820e32a2 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/get-hook.json @@ -0,0 +1,140 @@ +{ + "summary": "Get single hook", + "description": "", + "operationId": "repos-get-hook", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/hooks/#get-single-hook" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "hook_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "hook_id parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "type": { + "type": "string" + }, + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "config": { + "type": "object", + "properties": { + "content_type": { + "type": "string" + }, + "insecure_ssl": { + "type": "string" + }, + "url": { + "type": "string" + } + } + }, + "updated_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "test_url": { + "type": "string" + }, + "ping_url": { + "type": "string" + }, + "last_response": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "status": { + "type": "string" + }, + "message": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/hooks/:hook_id" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n hook_id: 'hook_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/get-latest-pages-build.json b/openapi/ghe-2.14/operations/repos/get-latest-pages-build.json new file mode 100644 index 0000000000..32245e4e78 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/get-latest-pages-build.json @@ -0,0 +1,155 @@ +{ + "summary": "Get latest Pages build", + "description": "", + "operationId": "repos-get-latest-pages-build", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/pages/#get-latest-pages-build" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "status": { + "type": "string" + }, + "error": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + } + }, + "pusher": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "commit": { + "type": "string" + }, + "duration": { + "type": "number" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/pages/builds/latest" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/get-latest-release.json b/openapi/ghe-2.14/operations/repos/get-latest-release.json new file mode 100644 index 0000000000..3222772c94 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/get-latest-release.json @@ -0,0 +1,280 @@ +{ + "summary": "Get the latest release", + "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.", + "operationId": "repos-get-latest-release", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/releases/#get-the-latest-release" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "assets_url": { + "type": "string" + }, + "upload_url": { + "type": "string" + }, + "tarball_url": { + "type": "string" + }, + "zipball_url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "tag_name": { + "type": "string" + }, + "target_commitish": { + "type": "string" + }, + "name": { + "type": "string" + }, + "body": { + "type": "string" + }, + "draft": { + "type": "boolean" + }, + "prerelease": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "published_at": { + "type": "string" + }, + "author": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "assets": { + "type": "array", + "items": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "browser_download_url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "label": { + "type": "string" + }, + "state": { + "type": "string" + }, + "content_type": { + "type": "string" + }, + "size": { + "type": "number" + }, + "download_count": { + "type": "number" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "uploader": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/releases/latest" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/get-pages-build.json b/openapi/ghe-2.14/operations/repos/get-pages-build.json new file mode 100644 index 0000000000..4807699db7 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/get-pages-build.json @@ -0,0 +1,164 @@ +{ + "summary": "Get a specific Pages build", + "description": "", + "operationId": "repos-get-pages-build", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/pages/#get-a-specific-pages-build" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "build_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "build_id parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "status": { + "type": "string" + }, + "error": { + "type": "object", + "properties": { + "message": { + "type": "string" + } + } + }, + "pusher": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "commit": { + "type": "string" + }, + "duration": { + "type": "number" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/pages/builds/:build_id" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n build_id: 'build_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/get-pages.json b/openapi/ghe-2.14/operations/repos/get-pages.json new file mode 100644 index 0000000000..2b3f5ed089 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/get-pages.json @@ -0,0 +1,96 @@ +{ + "summary": "Get information about a Pages site", + "description": "", + "operationId": "repos-get-pages", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/pages/#get-information-about-a-pages-site" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "status": { + "type": "string" + }, + "cname": { + "type": "string" + }, + "custom_404": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "source": { + "type": "object", + "properties": { + "branch": { + "type": "string" + }, + "directory": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/pages" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/get-participation-stats.json b/openapi/ghe-2.14/operations/repos/get-participation-stats.json new file mode 100644 index 0000000000..9acce444e1 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/get-participation-stats.json @@ -0,0 +1,82 @@ +{ + "summary": "Get the weekly commit count for the repository owner and everyone else", + "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", + "operationId": "repos-get-participation-stats", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/statistics/#get-the-weekly-commit-count-for-the-repository-owner-and-everyone-else" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "all": { + "type": "array", + "items": { + "type": "number" + } + }, + "owner": { + "type": "array", + "items": { + "type": "number" + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/stats/participation" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/get-protected-branch-admin-enforcement.json b/openapi/ghe-2.14/operations/repos/get-protected-branch-admin-enforcement.json new file mode 100644 index 0000000000..c1e7eff78b --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/get-protected-branch-admin-enforcement.json @@ -0,0 +1,71 @@ +{ + "summary": "Get admin enforcement of protected branch", + "description": "", + "operationId": "repos-get-protected-branch-admin-enforcement", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/branches/#get-admin-enforcement-of-protected-branch" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "branch", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "branch parameter" + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/branches/:branch/protection/enforce_admins" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/get-protected-branch-pull-request-review-enforcement.json b/openapi/ghe-2.14/operations/repos/get-protected-branch-pull-request-review-enforcement.json new file mode 100644 index 0000000000..047caa4bc9 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/get-protected-branch-pull-request-review-enforcement.json @@ -0,0 +1,71 @@ +{ + "summary": "Get pull request review enforcement of protected branch", + "description": "", + "operationId": "repos-get-protected-branch-pull-request-review-enforcement", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/branches/#get-pull-request-review-enforcement-of-protected-branch" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "branch", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "branch parameter" + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/branches/:branch/protection/required_pull_request_reviews" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/get-protected-branch-required-signatures.json b/openapi/ghe-2.14/operations/repos/get-protected-branch-required-signatures.json new file mode 100644 index 0000000000..18197d5fb5 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/get-protected-branch-required-signatures.json @@ -0,0 +1,86 @@ +{ + "summary": "Get required signatures of protected branch", + "description": "When 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.", + "operationId": "repos-get-protected-branch-required-signatures", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/branches/#get-required-signatures-of-protected-branch" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.zzzax-preview+json" + }, + "required": true + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "branch", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "branch parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "enabled": { + "type": "boolean" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.zzzax-preview+json\" \\\n https://developer.github.com/repos/octocat/:repo/branches/:branch/protection/required_signatures" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/get-protected-branch-required-status-checks.json b/openapi/ghe-2.14/operations/repos/get-protected-branch-required-status-checks.json new file mode 100644 index 0000000000..53f6a4e838 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/get-protected-branch-required-status-checks.json @@ -0,0 +1,94 @@ +{ + "summary": "Get required status checks of protected branch", + "description": "", + "operationId": "repos-get-protected-branch-required-status-checks", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/branches/#get-required-status-checks-of-protected-branch" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "branch", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "branch parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "strict": { + "type": "boolean" + }, + "contexts": { + "type": "array", + "items": { + "type": "string" + } + }, + "contexts_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/branches/:branch/protection/required_status_checks" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/get-protected-branch-restrictions.json b/openapi/ghe-2.14/operations/repos/get-protected-branch-restrictions.json new file mode 100644 index 0000000000..64d544ab8c --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/get-protected-branch-restrictions.json @@ -0,0 +1,71 @@ +{ + "summary": "Get restrictions of protected branch", + "description": "**Note**: Teams and users `restrictions` are only available for organization-owned repositories.", + "operationId": "repos-get-protected-branch-restrictions", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/branches/#get-restrictions-of-protected-branch" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "branch", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "branch parameter" + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/branches/:branch/protection/restrictions" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/get-punch-card-stats.json b/openapi/ghe-2.14/operations/repos/get-punch-card-stats.json new file mode 100644 index 0000000000..f5e057a077 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/get-punch-card-stats.json @@ -0,0 +1,67 @@ +{ + "summary": "Get the number of commits per hour in each day", + "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.", + "operationId": "repos-get-punch-card-stats", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/statistics/#get-the-number-of-commits-per-hour-in-each-day" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/stats/punch_card" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/get-readme.json b/openapi/ghe-2.14/operations/repos/get-readme.json new file mode 100644 index 0000000000..7113a579a2 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/get-readme.json @@ -0,0 +1,126 @@ +{ + "summary": "Get the README", + "description": "Gets the preferred README for a repository.\n\nREADMEs support [custom media types](https://developer.github.com/enterprise/2.14/v3/repos/contents/#custom-media-types) for retrieving the raw content or rendered HTML.", + "operationId": "repos-get-readme", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/contents/#get-the-readme" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "ref", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "type": { + "type": "string" + }, + "encoding": { + "type": "string" + }, + "size": { + "type": "number" + }, + "name": { + "type": "string" + }, + "path": { + "type": "string" + }, + "content": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "download_url": { + "type": "string" + }, + "_links": { + "type": "object", + "properties": { + "git": { + "type": "string" + }, + "self": { + "type": "string" + }, + "html": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/readme" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/get-release-asset.json b/openapi/ghe-2.14/operations/repos/get-release-asset.json new file mode 100644 index 0000000000..27c71dae56 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/get-release-asset.json @@ -0,0 +1,174 @@ +{ + "summary": "Get a single release asset", + "description": "To download the asset's binary content, set the `Accept` header of the request to [`application/octet-stream`](https://developer.github.com/enterprise/2.14/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.", + "operationId": "repos-get-release-asset", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/releases/#get-a-single-release-asset" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "asset_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "asset_id parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "browser_download_url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "label": { + "type": "string" + }, + "state": { + "type": "string" + }, + "content_type": { + "type": "string" + }, + "size": { + "type": "number" + }, + "download_count": { + "type": "number" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "uploader": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/releases/assets/:asset_id" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n asset_id: 'asset_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/get-release-by-tag.json b/openapi/ghe-2.14/operations/repos/get-release-by-tag.json new file mode 100644 index 0000000000..a39fe03520 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/get-release-by-tag.json @@ -0,0 +1,289 @@ +{ + "summary": "Get a release by tag name", + "description": "Get a published release with the specified tag.", + "operationId": "repos-get-release-by-tag", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/releases/#get-a-release-by-tag-name" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "tag", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "tag parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "assets_url": { + "type": "string" + }, + "upload_url": { + "type": "string" + }, + "tarball_url": { + "type": "string" + }, + "zipball_url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "tag_name": { + "type": "string" + }, + "target_commitish": { + "type": "string" + }, + "name": { + "type": "string" + }, + "body": { + "type": "string" + }, + "draft": { + "type": "boolean" + }, + "prerelease": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "published_at": { + "type": "string" + }, + "author": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "assets": { + "type": "array", + "items": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "browser_download_url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "label": { + "type": "string" + }, + "state": { + "type": "string" + }, + "content_type": { + "type": "string" + }, + "size": { + "type": "number" + }, + "download_count": { + "type": "number" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "uploader": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/releases/tags/:tag" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n tag: 'tag'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/get-release.json b/openapi/ghe-2.14/operations/repos/get-release.json new file mode 100644 index 0000000000..42d14fc18d --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/get-release.json @@ -0,0 +1,289 @@ +{ + "summary": "Get a single release", + "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/enterprise/2.14/v3/#hypermedia).", + "operationId": "repos-get-release", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/releases/#get-a-single-release" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "release_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "release_id parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "assets_url": { + "type": "string" + }, + "upload_url": { + "type": "string" + }, + "tarball_url": { + "type": "string" + }, + "zipball_url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "tag_name": { + "type": "string" + }, + "target_commitish": { + "type": "string" + }, + "name": { + "type": "string" + }, + "body": { + "type": "string" + }, + "draft": { + "type": "boolean" + }, + "prerelease": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "published_at": { + "type": "string" + }, + "author": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "assets": { + "type": "array", + "items": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "browser_download_url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "label": { + "type": "string" + }, + "state": { + "type": "string" + }, + "content_type": { + "type": "string" + }, + "size": { + "type": "number" + }, + "download_count": { + "type": "number" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "uploader": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/releases/:release_id" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n release_id: 'release_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/get.json b/openapi/ghe-2.14/operations/repos/get.json new file mode 100644 index 0000000000..a21243f0e9 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/get.json @@ -0,0 +1,1050 @@ +{ + "summary": "Get", + "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.", + "operationId": "repos-get", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/#get" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "number" + }, + "stargazers_count": { + "type": "number" + }, + "watchers_count": { + "type": "number" + }, + "size": { + "type": "number" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "number" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "number" + }, + "network_count": { + "type": "number" + }, + "anonymous_access_enabled": { + "type": "boolean" + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + } + }, + "organization": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "parent": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "number" + }, + "stargazers_count": { + "type": "number" + }, + "watchers_count": { + "type": "number" + }, + "size": { + "type": "number" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "number" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "number" + }, + "network_count": { + "type": "number" + } + } + }, + "source": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "number" + }, + "stargazers_count": { + "type": "number" + }, + "watchers_count": { + "type": "number" + }, + "size": { + "type": "number" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "number" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "number" + }, + "network_count": { + "type": "number" + }, + "anonymous_access_enabled": { + "type": "boolean" + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/list-assets-for-release.json b/openapi/ghe-2.14/operations/repos/list-assets-for-release.json new file mode 100644 index 0000000000..e28189b039 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/list-assets-for-release.json @@ -0,0 +1,96 @@ +{ + "summary": "List assets for a release", + "description": "", + "operationId": "repos-list-assets-for-release", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/releases/#list-assets-for-a-release" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "release_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "release_id parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/releases/:release_id/assets" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n release_id: 'release_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/list-branches.json b/openapi/ghe-2.14/operations/repos/list-branches.json new file mode 100644 index 0000000000..7660178d2c --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/list-branches.json @@ -0,0 +1,96 @@ +{ + "summary": "List branches", + "description": "", + "operationId": "repos-list-branches", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/branches/#list-branches" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "protected", + "in": "query", + "schema": { + "type": "boolean" + }, + "required": false, + "description": "Setting to `true` returns only protected branches, and each branch in the response includes the `protected` and `protection` keys. Omitting this parameter returns all branches, and protected branches do not contain the `protected` and `protection` keys." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/branches" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/list-collaborators.json b/openapi/ghe-2.14/operations/repos/list-collaborators.json new file mode 100644 index 0000000000..3a74b337a4 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/list-collaborators.json @@ -0,0 +1,102 @@ +{ + "summary": "List collaborators", + "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\nIf you pass the `hellcat-preview` media type, team members will include the members of child teams.", + "operationId": "repos-list-collaborators", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/collaborators/#list-collaborators" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "affiliation", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "outside", + "direct", + "all" + ], + "default": "all" + }, + "required": false, + "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." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/collaborators" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/list-comments-for-commit.json b/openapi/ghe-2.14/operations/repos/list-comments-for-commit.json new file mode 100644 index 0000000000..62947d0621 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/list-comments-for-commit.json @@ -0,0 +1,106 @@ +{ + "summary": "List comments for a single commit", + "description": "Use the `:commit_sha` to specify the commit that will have its comments listed.", + "operationId": "repos-list-comments-for-commit", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/comments/#list-comments-for-a-single-commit" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "commit_sha", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "commit_sha parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/commits/:commit_sha/comments" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n commit_sha: 'commit_sha'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "parameter", + "date": "2019-06-07", + "note": "\"ref\" parameter renamed to \"commit_sha\"", + "meta": { + "before": "ref", + "after": "commit_sha" + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/repos/list-commit-comments.json b/openapi/ghe-2.14/operations/repos/list-commit-comments.json new file mode 100644 index 0000000000..db7e278da5 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/list-commit-comments.json @@ -0,0 +1,87 @@ +{ + "summary": "List commit comments for a repository", + "description": "Commit Comments use [these custom media types](https://developer.github.com/enterprise/2.14/v3/repos/comments/#custom-media-types). You can read more about the use of media types in the API [here](https://developer.github.com/enterprise/2.14/v3/media/).\n\nComments are ordered by ascending ID.", + "operationId": "repos-list-commit-comments", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/comments/#list-commit-comments-for-a-repository" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/comments" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/list-commits.json b/openapi/ghe-2.14/operations/repos/list-commits.json new file mode 100644 index 0000000000..9ace5a2006 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/list-commits.json @@ -0,0 +1,132 @@ +{ + "summary": "List commits on a repository", + "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. |", + "operationId": "repos-list-commits", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/commits/#list-commits-on-a-repository" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "sha", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "description": "SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`)." + }, + { + "name": "path", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "description": "Only commits containing this file path will be returned." + }, + { + "name": "author", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "description": "GitHub login or email address by which to filter by commit author." + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "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`." + }, + { + "name": "until", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "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`." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/commits" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/list-contributors.json b/openapi/ghe-2.14/operations/repos/list-contributors.json new file mode 100644 index 0000000000..44c5775f9b --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/list-contributors.json @@ -0,0 +1,91 @@ +{ + "summary": "List contributors", + "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.", + "operationId": "repos-list-contributors", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/#list-contributors" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "anon", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "description": "Set to `1` or `true` to include anonymous contributors in results." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/contributors" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/list-deploy-keys.json b/openapi/ghe-2.14/operations/repos/list-deploy-keys.json new file mode 100644 index 0000000000..3b353706a8 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/list-deploy-keys.json @@ -0,0 +1,87 @@ +{ + "summary": "List deploy keys", + "description": "", + "operationId": "repos-list-deploy-keys", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/keys/#list-deploy-keys" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/keys" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/list-deployment-statuses.json b/openapi/ghe-2.14/operations/repos/list-deployment-statuses.json new file mode 100644 index 0000000000..6c125b5968 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/list-deployment-statuses.json @@ -0,0 +1,96 @@ +{ + "summary": "List deployment statuses", + "description": "Users with pull access can view deployment statuses for a deployment:", + "operationId": "repos-list-deployment-statuses", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/deployments/#list-deployment-statuses" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "deployment_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "deployment_id parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/deployments/:deployment_id/statuses" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n deployment_id: 'deployment_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/list-deployments.json b/openapi/ghe-2.14/operations/repos/list-deployments.json new file mode 100644 index 0000000000..668877f74e --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/list-deployments.json @@ -0,0 +1,127 @@ +{ + "summary": "List deployments", + "description": "Simple filtering of deployments is available via query parameters:", + "operationId": "repos-list-deployments", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/deployments/#list-deployments" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "sha", + "in": "query", + "schema": { + "type": "string", + "default": "none" + }, + "required": false, + "description": "The SHA recorded at creation time." + }, + { + "name": "ref", + "in": "query", + "schema": { + "type": "string", + "default": "none" + }, + "required": false, + "description": "The name of the ref. This can be a branch, tag, or SHA." + }, + { + "name": "task", + "in": "query", + "schema": { + "type": "string", + "default": "none" + }, + "required": false, + "description": "The name of the task for the deployment (e.g., `deploy` or `deploy:migrations`)." + }, + { + "name": "environment", + "in": "query", + "schema": { + "type": "string", + "default": "none" + }, + "required": false, + "description": "The name of the environment that was deployed to (e.g., `staging` or `production`)." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/deployments" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/list-downloads.json b/openapi/ghe-2.14/operations/repos/list-downloads.json new file mode 100644 index 0000000000..dac3ed34b7 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/list-downloads.json @@ -0,0 +1,87 @@ +{ + "summary": "List downloads for a repository", + "description": "", + "operationId": "repos-list-downloads", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/downloads/#list-downloads-for-a-repository" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/downloads" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/list-for-org.json b/openapi/ghe-2.14/operations/repos/list-for-org.json new file mode 100644 index 0000000000..62eda9d787 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/list-for-org.json @@ -0,0 +1,96 @@ +{ + "summary": "List organization repositories", + "description": "List repositories for the specified org.", + "operationId": "repos-list-for-org", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/#list-organization-repositories" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "org", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "org parameter" + }, + { + "name": "type", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "all", + "public", + "private", + "forks", + "sources", + "member" + ], + "default": "all" + }, + "required": false, + "description": "Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/orgs//repos" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n org: 'org'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/list-for-user.json b/openapi/ghe-2.14/operations/repos/list-for-user.json new file mode 100644 index 0000000000..6c305180f9 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/list-for-user.json @@ -0,0 +1,117 @@ +{ + "summary": "List user repositories", + "description": "List public repositories for the specified user.", + "operationId": "repos-list-for-user", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/#list-user-repositories" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + }, + { + "name": "type", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "all", + "owner", + "member" + ], + "default": "owner" + }, + "required": false, + "description": "Can be one of `all`, `owner`, `member`." + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "pushed", + "full_name" + ], + "default": "full_name" + }, + "required": false, + "description": "Can be one of `created`, `updated`, `pushed`, `full_name`." + }, + { + "name": "direction", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ] + }, + "required": false, + "description": "Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc`" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/users//repos" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/list-forks.json b/openapi/ghe-2.14/operations/repos/list-forks.json new file mode 100644 index 0000000000..178d8f0fc4 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/list-forks.json @@ -0,0 +1,102 @@ +{ + "summary": "List forks", + "description": "", + "operationId": "repos-list-forks", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/forks/#list-forks" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "newest", + "oldest", + "stargazers" + ], + "default": "newest" + }, + "required": false, + "description": "The sort order. Can be either `newest`, `oldest`, or `stargazers`." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/forks" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/list-hooks.json b/openapi/ghe-2.14/operations/repos/list-hooks.json new file mode 100644 index 0000000000..b143ca5fd4 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/list-hooks.json @@ -0,0 +1,87 @@ +{ + "summary": "List hooks", + "description": "", + "operationId": "repos-list-hooks", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/hooks/#list-hooks" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/hooks" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/list-invitations-for-authenticated-user.json b/openapi/ghe-2.14/operations/repos/list-invitations-for-authenticated-user.json new file mode 100644 index 0000000000..b6da304036 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/list-invitations-for-authenticated-user.json @@ -0,0 +1,69 @@ +{ + "summary": "List a user's repository invitations", + "description": "When authenticating as a user, this endpoint will list all currently open repository invitations for that user.\n\n", + "operationId": "repos-list-invitations-for-authenticated-user", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/invitations/#list-a-users-repository-invitations" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/user/repository_invitations" + }, + { + "lang": "JS", + "source": "octokit.repos.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/list-invitations.json b/openapi/ghe-2.14/operations/repos/list-invitations.json new file mode 100644 index 0000000000..5cdbe0ef4e --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/list-invitations.json @@ -0,0 +1,87 @@ +{ + "summary": "List invitations for a repository", + "description": "When authenticating as a user with admin rights to a repository, this endpoint will list all currently open repository invitations.\n\n", + "operationId": "repos-list-invitations", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/invitations/#list-invitations-for-a-repository" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/invitations" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/list-languages.json b/openapi/ghe-2.14/operations/repos/list-languages.json new file mode 100644 index 0000000000..333366121c --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/list-languages.json @@ -0,0 +1,76 @@ +{ + "summary": "List languages", + "description": "Lists languages for the specified repository. The value shown for each language is the number of bytes of code written in that language.", + "operationId": "repos-list-languages", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/#list-languages" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "C": { + "type": "number" + }, + "Python": { + "type": "number" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/languages" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/list-pages-builds.json b/openapi/ghe-2.14/operations/repos/list-pages-builds.json new file mode 100644 index 0000000000..3cf3d1aa19 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/list-pages-builds.json @@ -0,0 +1,87 @@ +{ + "summary": "List Pages builds", + "description": "", + "operationId": "repos-list-pages-builds", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/pages/#list-pages-builds" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/pages/builds" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/list-protected-branch-required-status-checks-contexts.json b/openapi/ghe-2.14/operations/repos/list-protected-branch-required-status-checks-contexts.json new file mode 100644 index 0000000000..25bcdf7fe3 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/list-protected-branch-required-status-checks-contexts.json @@ -0,0 +1,71 @@ +{ + "summary": "List required status checks contexts of protected branch", + "description": "", + "operationId": "repos-list-protected-branch-required-status-checks-contexts", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/branches/#list-required-status-checks-contexts-of-protected-branch" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "branch", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "branch parameter" + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/branches/:branch/protection/required_status_checks/contexts" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/list-protected-branch-team-restrictions.json b/openapi/ghe-2.14/operations/repos/list-protected-branch-team-restrictions.json new file mode 100644 index 0000000000..f944b73bef --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/list-protected-branch-team-restrictions.json @@ -0,0 +1,91 @@ +{ + "summary": "List team restrictions of protected branch", + "description": "Lists the teams who have push access to this branch. If you pass the `hellcat-preview` media type, the list includes child teams.", + "operationId": "repos-list-protected-branch-team-restrictions", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/branches/#list-team-restrictions-of-protected-branch" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "branch", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "branch parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/branches/:branch/protection/restrictions/teams" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/list-protected-branch-user-restrictions.json b/openapi/ghe-2.14/operations/repos/list-protected-branch-user-restrictions.json new file mode 100644 index 0000000000..7b88c62c6b --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/list-protected-branch-user-restrictions.json @@ -0,0 +1,71 @@ +{ + "summary": "List user restrictions of protected branch", + "description": "Lists the people who have push access to this branch.", + "operationId": "repos-list-protected-branch-user-restrictions", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/branches/#list-user-restrictions-of-protected-branch" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "branch", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "branch parameter" + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/branches/:branch/protection/restrictions/users" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/list-public.json b/openapi/ghe-2.14/operations/repos/list-public.json new file mode 100644 index 0000000000..2d602b80f5 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/list-public.json @@ -0,0 +1,88 @@ +{ + "summary": "List all public repositories", + "description": "This provides a dump of every public repository, 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/enterprise/2.14/v3/#link-header) to get the URL for the next page of repositories.\n\nIf you are an [authenticated](https://developer.github.com/enterprise/2.14/v3/#authentication) site administrator for your Enterprise appliance, you will be able to list all repositories including private repositories.", + "operationId": "repos-list-public", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/#list-all-public-repositories" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "description": "The integer ID of the last Repository that you've seen." + }, + { + "name": "visibility", + "in": "query", + "schema": { + "type": "string", + "default": "public" + }, + "required": false, + "description": "To include private repositories as well set to `all`." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repositories" + }, + { + "lang": "JS", + "source": "octokit.repos.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/list-releases.json b/openapi/ghe-2.14/operations/repos/list-releases.json new file mode 100644 index 0000000000..6246e92aa4 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/list-releases.json @@ -0,0 +1,87 @@ +{ + "summary": "List releases for a repository", + "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/enterprise/2.14/v3/repos/#list-tags).\n\nInformation about published releases are available to everyone. Only users with push access will receive listings for draft releases.", + "operationId": "repos-list-releases", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/releases/#list-releases-for-a-repository" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/releases" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/list-statuses-for-ref.json b/openapi/ghe-2.14/operations/repos/list-statuses-for-ref.json new file mode 100644 index 0000000000..0f5f6c142a --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/list-statuses-for-ref.json @@ -0,0 +1,96 @@ +{ + "summary": "List statuses for a specific ref", + "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`.", + "operationId": "repos-list-statuses-for-ref", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/statuses/#list-statuses-for-a-specific-ref" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "ref", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "ref parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/commits/:ref/statuses" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n ref: 'ref'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/list-tags.json b/openapi/ghe-2.14/operations/repos/list-tags.json new file mode 100644 index 0000000000..d95abedd81 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/list-tags.json @@ -0,0 +1,87 @@ +{ + "summary": "List tags", + "description": "", + "operationId": "repos-list-tags", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/#list-tags" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/tags" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/list-teams.json b/openapi/ghe-2.14/operations/repos/list-teams.json new file mode 100644 index 0000000000..3b74e35afa --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/list-teams.json @@ -0,0 +1,87 @@ +{ + "summary": "List teams", + "description": "", + "operationId": "repos-list-teams", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/#list-teams" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/teams" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/list-topics.json b/openapi/ghe-2.14/operations/repos/list-topics.json new file mode 100644 index 0000000000..ea5dc3c843 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/list-topics.json @@ -0,0 +1,76 @@ +{ + "summary": "List all topics for a repository", + "description": "", + "operationId": "repos-list-topics", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/#list-all-topics-for-a-repository" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "names": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/topics" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/list.json b/openapi/ghe-2.14/operations/repos/list.json new file mode 100644 index 0000000000..64a0a973e6 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/list.json @@ -0,0 +1,135 @@ +{ + "summary": "List your repositories", + "description": "List repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access.\n\nThe authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.", + "operationId": "repos-list", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/#list-your-repositories" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "visibility", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "all", + "public", + "private" + ], + "default": "all" + }, + "required": false, + "description": "Can be one of `all`, `public`, or `private`." + }, + { + "name": "affiliation", + "in": "query", + "schema": { + "type": "string", + "default": "owner,collaborator,organization_member" + }, + "required": false, + "description": "Comma-separated list of values. Can include: \n\\* `owner`: Repositories that are owned by the authenticated user. \n\\* `collaborator`: Repositories that the user has been added to as a collaborator. \n\\* `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on." + }, + { + "name": "type", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "all", + "owner", + "public", + "private", + "member" + ], + "default": "all" + }, + "required": false, + "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**." + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "pushed", + "full_name" + ], + "default": "full_name" + }, + "required": false, + "description": "Can be one of `created`, `updated`, `pushed`, `full_name`." + }, + { + "name": "direction", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ] + }, + "required": false, + "description": "Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc`" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/user/repos" + }, + { + "lang": "JS", + "source": "octokit.repos.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/merge.json b/openapi/ghe-2.14/operations/repos/merge.json new file mode 100644 index 0000000000..503d78613f --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/merge.json @@ -0,0 +1,89 @@ +{ + "summary": "Perform a merge", + "description": "", + "operationId": "repos-merge", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/merging/#perform-a-merge" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "base": { + "description": "The name of the base branch that the head will be merged into.", + "type": "string" + }, + "head": { + "description": "The head to merge. This can be a branch name or a commit SHA1.", + "type": "string" + }, + "commit_message": { + "description": "Commit message to use for the merge commit. If omitted, a default message will be used.", + "type": "string" + } + }, + "required": [ + "base", + "head" + ] + } + } + } + }, + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/merges \\\n -d '{\"base\":\"base\",\"head\":\"head\"}'" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n base: 'base',\n head: 'head'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/ping-hook.json b/openapi/ghe-2.14/operations/repos/ping-hook.json new file mode 100644 index 0000000000..b53f6dbff1 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/ping-hook.json @@ -0,0 +1,71 @@ +{ + "summary": "Ping a hook", + "description": "**Note:** GitHub Enterprise release 2.17 and higher will discontinue allowing admins to install new GitHub Services, and existing services will stop working in GitHub Enterprise release 2.20 and higher. You can use the [Replacing GitHub Services guide](https://developer.github.com/enterprise/2.14/v3/guides/replacing-github-services) to help you update your services to webhooks.\n\nThis will trigger a [ping event](https://developer.github.com/enterprise/2.14/webhooks/#ping-event) to be sent to the hook.", + "operationId": "repos-ping-hook", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/hooks/#ping-a-hook" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "hook_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "hook_id parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/hooks/:hook_id/pings" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n hook_id: 'hook_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/remove-branch-protection.json b/openapi/ghe-2.14/operations/repos/remove-branch-protection.json new file mode 100644 index 0000000000..aaa047fb34 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/remove-branch-protection.json @@ -0,0 +1,71 @@ +{ + "summary": "Remove branch protection", + "description": "", + "operationId": "repos-remove-branch-protection", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/branches/#remove-branch-protection" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "branch", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "branch parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/branches/:branch/protection" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/remove-collaborator.json b/openapi/ghe-2.14/operations/repos/remove-collaborator.json new file mode 100644 index 0000000000..8abdb67aaa --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/remove-collaborator.json @@ -0,0 +1,71 @@ +{ + "summary": "Remove user as a collaborator", + "description": "", + "operationId": "repos-remove-collaborator", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/collaborators/#remove-user-as-a-collaborator" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/collaborators/:username" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/remove-deploy-key.json b/openapi/ghe-2.14/operations/repos/remove-deploy-key.json new file mode 100644 index 0000000000..f655f87fc6 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/remove-deploy-key.json @@ -0,0 +1,71 @@ +{ + "summary": "Remove a deploy key", + "description": "", + "operationId": "repos-remove-deploy-key", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/keys/#remove-a-deploy-key" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "key_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "key_id parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/keys/:key_id" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n key_id: 'key_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/remove-protected-branch-admin-enforcement.json b/openapi/ghe-2.14/operations/repos/remove-protected-branch-admin-enforcement.json new file mode 100644 index 0000000000..573e4e87f0 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/remove-protected-branch-admin-enforcement.json @@ -0,0 +1,71 @@ +{ + "summary": "Remove admin enforcement of protected branch", + "description": "Removing admin enforcement requires admin or owner permissions to the repository and branch protection to be enabled.", + "operationId": "repos-remove-protected-branch-admin-enforcement", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/branches/#remove-admin-enforcement-of-protected-branch" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "branch", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "branch parameter" + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/branches/:branch/protection/enforce_admins" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/remove-protected-branch-pull-request-review-enforcement.json b/openapi/ghe-2.14/operations/repos/remove-protected-branch-pull-request-review-enforcement.json new file mode 100644 index 0000000000..77a7efaaa5 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/remove-protected-branch-pull-request-review-enforcement.json @@ -0,0 +1,71 @@ +{ + "summary": "Remove pull request review enforcement of protected branch", + "description": "", + "operationId": "repos-remove-protected-branch-pull-request-review-enforcement", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/branches/#remove-pull-request-review-enforcement-of-protected-branch" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "branch", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "branch parameter" + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/branches/:branch/protection/required_pull_request_reviews" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/remove-protected-branch-required-signatures.json b/openapi/ghe-2.14/operations/repos/remove-protected-branch-required-signatures.json new file mode 100644 index 0000000000..3709d1dbf6 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/remove-protected-branch-required-signatures.json @@ -0,0 +1,72 @@ +{ + "summary": "Remove required signatures of protected branch", + "description": "When 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.", + "operationId": "repos-remove-protected-branch-required-signatures", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/branches/#remove-required-signatures-of-protected-branch" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.zzzax-preview+json" + }, + "required": true + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "branch", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "branch parameter" + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.zzzax-preview+json\" \\\n https://developer.github.com/repos/octocat/:repo/branches/:branch/protection/required_signatures" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/remove-protected-branch-required-status-checks-contexts.json b/openapi/ghe-2.14/operations/repos/remove-protected-branch-required-status-checks-contexts.json new file mode 100644 index 0000000000..ba090a90f9 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/remove-protected-branch-required-status-checks-contexts.json @@ -0,0 +1,90 @@ +{ + "summary": "Remove required status checks contexts of protected branch", + "description": "", + "operationId": "repos-remove-protected-branch-required-status-checks-contexts", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/branches/#remove-required-status-checks-contexts-of-protected-branch" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "branch", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "branch parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "contexts parameter" + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/branches/:branch/protection/required_status_checks/contexts \\\n -d '{\"contexts\":\"contexts\"}'" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n contexts: 'contexts'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false, + "requestBodyParameterName": "contexts" + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/remove-protected-branch-required-status-checks.json b/openapi/ghe-2.14/operations/repos/remove-protected-branch-required-status-checks.json new file mode 100644 index 0000000000..640bbff0d6 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/remove-protected-branch-required-status-checks.json @@ -0,0 +1,71 @@ +{ + "summary": "Remove required status checks of protected branch", + "description": "", + "operationId": "repos-remove-protected-branch-required-status-checks", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/branches/#remove-required-status-checks-of-protected-branch" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "branch", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "branch parameter" + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/branches/:branch/protection/required_status_checks" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/remove-protected-branch-restrictions.json b/openapi/ghe-2.14/operations/repos/remove-protected-branch-restrictions.json new file mode 100644 index 0000000000..db28b767d0 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/remove-protected-branch-restrictions.json @@ -0,0 +1,71 @@ +{ + "summary": "Remove restrictions of protected branch", + "description": "Disables the ability to restrict who can push to this branch.", + "operationId": "repos-remove-protected-branch-restrictions", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/branches/#remove-restrictions-of-protected-branch" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "branch", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "branch parameter" + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/branches/:branch/protection/restrictions" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/remove-protected-branch-team-restrictions.json b/openapi/ghe-2.14/operations/repos/remove-protected-branch-team-restrictions.json new file mode 100644 index 0000000000..23726cf58d --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/remove-protected-branch-team-restrictions.json @@ -0,0 +1,90 @@ +{ + "summary": "Remove team restrictions of protected branch", + "description": "Removes the ability of a team to push to this branch. If you pass the `hellcat-preview` media type, you can include 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 and teams in total is limited to 100 items. |", + "operationId": "repos-remove-protected-branch-team-restrictions", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/branches/#remove-team-restrictions-of-protected-branch" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "branch", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "branch parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "teams parameter" + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/branches/:branch/protection/restrictions/teams \\\n -d '{\"teams\":\"teams\"}'" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n teams: 'teams'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false, + "requestBodyParameterName": "teams" + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/remove-protected-branch-user-restrictions.json b/openapi/ghe-2.14/operations/repos/remove-protected-branch-user-restrictions.json new file mode 100644 index 0000000000..7299b0a1db --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/remove-protected-branch-user-restrictions.json @@ -0,0 +1,90 @@ +{ + "summary": "Remove user restrictions of protected branch", + "description": "Removes the ability of a team 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 and teams in total is limited to 100 items. |", + "operationId": "repos-remove-protected-branch-user-restrictions", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/branches/#remove-user-restrictions-of-protected-branch" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "branch", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "branch parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "users parameter" + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/branches/:branch/protection/restrictions/users \\\n -d '{\"users\":\"users\"}'" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n users: 'users'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false, + "requestBodyParameterName": "users" + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/replace-protected-branch-required-status-checks-contexts.json b/openapi/ghe-2.14/operations/repos/replace-protected-branch-required-status-checks-contexts.json new file mode 100644 index 0000000000..931532d520 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/replace-protected-branch-required-status-checks-contexts.json @@ -0,0 +1,90 @@ +{ + "summary": "Replace required status checks contexts of protected branch", + "description": "", + "operationId": "repos-replace-protected-branch-required-status-checks-contexts", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/branches/#replace-required-status-checks-contexts-of-protected-branch" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "branch", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "branch parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "contexts parameter" + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPUT \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/branches/:branch/protection/required_status_checks/contexts \\\n -d '{\"contexts\":\"contexts\"}'" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n contexts: 'contexts'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false, + "requestBodyParameterName": "contexts" + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/replace-protected-branch-team-restrictions.json b/openapi/ghe-2.14/operations/repos/replace-protected-branch-team-restrictions.json new file mode 100644 index 0000000000..499131b464 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/replace-protected-branch-team-restrictions.json @@ -0,0 +1,90 @@ +{ + "summary": "Replace team restrictions of protected branch", + "description": "Replaces 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. If you pass the `hellcat-preview` media type, you can 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 and teams in total is limited to 100 items. |", + "operationId": "repos-replace-protected-branch-team-restrictions", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/branches/#replace-team-restrictions-of-protected-branch" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "branch", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "branch parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "teams parameter" + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPUT \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/branches/:branch/protection/restrictions/teams \\\n -d '{\"teams\":\"teams\"}'" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n teams: 'teams'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false, + "requestBodyParameterName": "teams" + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/replace-protected-branch-user-restrictions.json b/openapi/ghe-2.14/operations/repos/replace-protected-branch-user-restrictions.json new file mode 100644 index 0000000000..1ab72e677f --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/replace-protected-branch-user-restrictions.json @@ -0,0 +1,90 @@ +{ + "summary": "Replace user restrictions of protected branch", + "description": "Replaces 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 and teams in total is limited to 100 items. |", + "operationId": "repos-replace-protected-branch-user-restrictions", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/branches/#replace-user-restrictions-of-protected-branch" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "branch", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "branch parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "description": "users parameter" + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPUT \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/branches/:branch/protection/restrictions/users \\\n -d '{\"users\":\"users\"}'" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n users: 'users'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false, + "requestBodyParameterName": "users" + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/replace-topics.json b/openapi/ghe-2.14/operations/repos/replace-topics.json new file mode 100644 index 0000000000..9b9d8eb2ed --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/replace-topics.json @@ -0,0 +1,97 @@ +{ + "summary": "Replace all topics for a repository", + "description": "", + "operationId": "repos-replace-topics", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/#replace-all-topics-for-a-repository" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "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.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "names" + ] + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "names": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPUT \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/topics \\\n -d '{\"names\":\"names\"}'" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n names: 'names'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/request-page-build.json b/openapi/ghe-2.14/operations/repos/request-page-build.json new file mode 100644 index 0000000000..d28e7f638c --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/request-page-build.json @@ -0,0 +1,77 @@ +{ + "summary": "Request a page build", + "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.", + "operationId": "repos-request-page-build", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/pages/#request-a-page-build" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.mister-fantastic-preview+json" + }, + "required": true + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.mister-fantastic-preview+json\" \\\n https://developer.github.com/repos/octocat/:repo/pages/builds" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/test-push-hook.json b/openapi/ghe-2.14/operations/repos/test-push-hook.json new file mode 100644 index 0000000000..20173d22dd --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/test-push-hook.json @@ -0,0 +1,71 @@ +{ + "summary": "Test a push hook", + "description": "**Note:** GitHub Enterprise release 2.17 and higher will discontinue allowing admins to install new GitHub Services, and existing services will stop working in GitHub Enterprise release 2.20 and higher. You can use the [Replacing GitHub Services guide](https://developer.github.com/enterprise/2.14/v3/guides/replacing-github-services) to help you update your services to webhooks.\n\nThis 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`", + "operationId": "repos-test-push-hook", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/hooks/#test-a-push-hook" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "hook_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "hook_id parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/hooks/:hook_id/tests" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n hook_id: 'hook_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/transfer.json b/openapi/ghe-2.14/operations/repos/transfer.json new file mode 100644 index 0000000000..e8ee0dc6f5 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/transfer.json @@ -0,0 +1,391 @@ +{ + "summary": "Transfer a repository", + "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/).", + "operationId": "repos-transfer", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/#transfer-a-repository" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.nightshade-preview+json" + }, + "required": true + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "new_owner": { + "description": "**Required:** The username or organization name the repository will be transferred to.", + "type": "string" + }, + "team_ids": { + "description": "ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.", + "type": "array", + "items": { + "type": "integer" + } + } + } + } + } + } + }, + "responses": { + "202": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "number" + }, + "stargazers_count": { + "type": "number" + }, + "watchers_count": { + "type": "number" + }, + "size": { + "type": "number" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "number" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "number" + }, + "network_count": { + "type": "number" + }, + "anonymous_access_enabled": { + "type": "boolean" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.nightshade-preview+json\" \\\n https://developer.github.com/repos/octocat/:repo/transfer" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/update-branch-protection.json b/openapi/ghe-2.14/operations/repos/update-branch-protection.json new file mode 100644 index 0000000000..4672686a38 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/update-branch-protection.json @@ -0,0 +1,468 @@ +{ + "summary": "Update branch protection", + "description": "Protecting 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 and teams in total is limited to 100 items.", + "operationId": "repos-update-branch-protection", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/branches/#update-branch-protection" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "branch", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "branch parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "required_status_checks": { + "description": "Require status checks to pass before merging. Set to `null` to disable.", + "type": "object", + "nullable": true, + "properties": { + "strict": { + "description": "Require branches to be up to date before merging.", + "type": "boolean" + }, + "contexts": { + "description": "The list of status checks to require in order to merge into this branch", + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "strict", + "contexts" + ] + }, + "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.", + "type": "boolean", + "nullable": true + }, + "required_pull_request_reviews": { + "description": "Require at least one approving review on a pull request, before merging. Set to `null` to disable.", + "type": "object", + "nullable": true, + "properties": { + "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.", + "type": "object", + "properties": { + "users": { + "description": "The list of user `login`s with dismissal access", + "type": "array", + "items": { + "type": "string" + } + }, + "teams": { + "description": "The list of team `slug`s with dismissal access", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "dismiss_stale_reviews": { + "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", + "type": "boolean" + }, + "require_code_owner_reviews": { + "description": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) review them.", + "type": "boolean" + }, + "required_approving_review_count": { + "description": "Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6.", + "type": "integer" + } + } + }, + "restrictions": { + "description": "Restrict who can push to this branch. Team and user `restrictions` are only available for organization-owned repositories. Set to `null` to disable.", + "type": "object", + "nullable": true, + "properties": { + "users": { + "description": "The list of user `login`s with push access", + "type": "array", + "items": { + "type": "string" + } + }, + "teams": { + "description": "The list of team `slug`s with push access", + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "required": [ + "required_status_checks", + "enforce_admins", + "required_pull_request_reviews", + "restrictions" + ] + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "required_status_checks": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "strict": { + "type": "boolean" + }, + "contexts": { + "type": "array", + "items": { + "type": "string" + } + }, + "contexts_url": { + "type": "string" + } + } + }, + "enforce_admins": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "enabled": { + "type": "boolean" + } + } + }, + "required_pull_request_reviews": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "dismissal_restrictions": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "users_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + }, + "teams": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string" + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": "string" + } + } + } + } + } + }, + "dismiss_stale_reviews": { + "type": "boolean" + }, + "require_code_owner_reviews": { + "type": "boolean" + }, + "required_approving_review_count": { + "type": "number" + } + } + }, + "restrictions": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "users_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + }, + "teams": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string" + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": "string" + } + } + } + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPUT \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/branches/:branch/protection \\\n -d '{\"required_status_checks\":\"required_status_checks\",\"required_status_checks.strict\":\"required_status_checks.strict\",\"required_status_checks.contexts\":\"required_status_checks.contexts\",\"enforce_admins\":\"enforce_admins\",\"required_pull_request_reviews\":\"required_pull_request_reviews\",\"restrictions\":\"restrictions\"}'" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n required_status_checks: 'required_status_checks',\n 'required_status_checks.strict': 'required_status_checks.strict',\n 'required_status_checks.contexts': 'required_status_checks.contexts',\n enforce_admins: 'enforce_admins',\n required_pull_request_reviews: 'required_pull_request_reviews',\n restrictions: 'restrictions'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/update-commit-comment.json b/openapi/ghe-2.14/operations/repos/update-commit-comment.json new file mode 100644 index 0000000000..10fceada81 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/update-commit-comment.json @@ -0,0 +1,189 @@ +{ + "summary": "Update a commit comment", + "description": "", + "operationId": "repos-update-commit-comment", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/comments/#update-a-commit-comment" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "comment_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "comment_id parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "description": "The contents of the comment", + "type": "string" + } + }, + "required": [ + "body" + ] + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "html_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "body": { + "type": "string" + }, + "path": { + "type": "string" + }, + "position": { + "type": "number" + }, + "line": { + "type": "number" + }, + "commit_id": { + "type": "string" + }, + "user": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPATCH \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/comments/:comment_id \\\n -d '{\"body\":\"body\"}'" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n comment_id: 'comment_id',\n body: 'body'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/update-hook.json b/openapi/ghe-2.14/operations/repos/update-hook.json new file mode 100644 index 0000000000..35288b4611 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/update-hook.json @@ -0,0 +1,205 @@ +{ + "summary": "Edit a hook", + "description": "**Note:** GitHub Enterprise release 2.17 and higher will discontinue allowing admins to install new GitHub Services, and existing services will stop working in GitHub Enterprise release 2.20 and higher. You can use the [Replacing GitHub Services guide](https://developer.github.com/enterprise/2.14/v3/guides/replacing-github-services) to help you update your services to webhooks.", + "operationId": "repos-update-hook", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/hooks/#edit-a-hook" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "hook_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "hook_id parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "config": { + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://developer.github.com/enterprise/2.14/v3/repos/hooks/#create-hook-config-params).", + "type": "object", + "properties": { + "url": { + "description": "The URL to which the payloads will be delivered.", + "type": "string" + }, + "content_type": { + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "type": "string" + }, + "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/enterprise/2.14/webhooks/#delivery-headers) header.", + "type": "string" + }, + "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.**", + "type": "string" + } + }, + "required": [ + "url" + ] + }, + "events": { + "description": "Determines what [events](https://developer.github.com/enterprise/2.14/v3/activity/events/types/) the hook is triggered for. This replaces the entire array of events.", + "type": "array", + "default": [ + "push" + ], + "items": { + "type": "string" + } + }, + "add_events": { + "description": "Determines a list of events to be added to the list of events that the Hook triggers for.", + "type": "array", + "items": { + "type": "string" + } + }, + "remove_events": { + "description": "Determines a list of events to be removed from the list of events that the Hook triggers for.", + "type": "array", + "items": { + "type": "string" + } + }, + "active": { + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "type": "boolean", + "default": true + } + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "type": { + "type": "string" + }, + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "active": { + "type": "boolean" + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "config": { + "type": "object", + "properties": { + "content_type": { + "type": "string" + }, + "insecure_ssl": { + "type": "string" + }, + "url": { + "type": "string" + } + } + }, + "updated_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "test_url": { + "type": "string" + }, + "ping_url": { + "type": "string" + }, + "last_response": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "status": { + "type": "string" + }, + "message": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPATCH \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/hooks/:hook_id \\\n -d '{\"config.url\":\"config.url\"}'" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n hook_id: 'hook_id',\n 'config.url': 'config.url'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/update-invitation.json b/openapi/ghe-2.14/operations/repos/update-invitation.json new file mode 100644 index 0000000000..35e0aacdfd --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/update-invitation.json @@ -0,0 +1,434 @@ +{ + "summary": "Update a repository invitation", + "description": "", + "operationId": "repos-update-invitation", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/invitations/#update-a-repository-invitation" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "invitation_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "invitation_id parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "permissions": { + "description": "The permissions that the associated user will have on the repository. Valid values are `read`, `write`, and `admin`.", + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "repository": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + } + } + }, + "invitee": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "inviter": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "permissions": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPATCH \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/invitations/:invitation_id" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n invitation_id: 'invitation_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/update-protected-branch-pull-request-review-enforcement.json b/openapi/ghe-2.14/operations/repos/update-protected-branch-pull-request-review-enforcement.json new file mode 100644 index 0000000000..af462b372f --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/update-protected-branch-pull-request-review-enforcement.json @@ -0,0 +1,251 @@ +{ + "summary": "Update pull request review enforcement of protected branch", + "description": "Updating 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.", + "operationId": "repos-update-protected-branch-pull-request-review-enforcement", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/branches/#update-pull-request-review-enforcement-of-protected-branch" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "branch", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "branch parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "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.", + "type": "object", + "properties": { + "users": { + "description": "The list of user `login`s with dismissal access", + "type": "array", + "items": { + "type": "string" + } + }, + "teams": { + "description": "The list of team `slug`s with dismissal access", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "dismiss_stale_reviews": { + "description": "Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.", + "type": "boolean" + }, + "require_code_owner_reviews": { + "description": "Blocks merging pull requests until [code owners](https://help.github.com/articles/about-code-owners/) have reviewed.", + "type": "boolean" + }, + "required_approving_review_count": { + "description": "Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6.", + "type": "integer" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "dismissal_restrictions": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "users_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "users": { + "type": "array", + "items": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + }, + "teams": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string" + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": "string" + } + } + } + } + } + }, + "dismiss_stale_reviews": { + "type": "boolean" + }, + "require_code_owner_reviews": { + "type": "boolean" + }, + "required_approving_review_count": { + "type": "number" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPATCH \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/branches/:branch/protection/required_pull_request_reviews" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/update-protected-branch-required-status-checks.json b/openapi/ghe-2.14/operations/repos/update-protected-branch-required-status-checks.json new file mode 100644 index 0000000000..13e82c0afa --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/update-protected-branch-required-status-checks.json @@ -0,0 +1,116 @@ +{ + "summary": "Update required status checks of protected branch", + "description": "Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.", + "operationId": "repos-update-protected-branch-required-status-checks", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/branches/#update-required-status-checks-of-protected-branch" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "branch", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "branch parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "strict": { + "description": "Require branches to be up to date before merging.", + "type": "boolean" + }, + "contexts": { + "description": "The list of status checks to require in order to merge into this branch", + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "strict": { + "type": "boolean" + }, + "contexts": { + "type": "array", + "items": { + "type": "string" + } + }, + "contexts_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPATCH \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/branches/:branch/protection/required_status_checks" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/update-release-asset.json b/openapi/ghe-2.14/operations/repos/update-release-asset.json new file mode 100644 index 0000000000..cdce196490 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/update-release-asset.json @@ -0,0 +1,193 @@ +{ + "summary": "Edit a release asset", + "description": "Users with push access to the repository can edit a release asset.", + "operationId": "repos-update-release-asset", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/releases/#edit-a-release-asset" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "asset_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "asset_id parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "The file name of the asset.", + "type": "string" + }, + "label": { + "description": "An alternate short description of the asset. Used in place of the filename.", + "type": "string" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "browser_download_url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "label": { + "type": "string" + }, + "state": { + "type": "string" + }, + "content_type": { + "type": "string" + }, + "size": { + "type": "number" + }, + "download_count": { + "type": "number" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "uploader": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPATCH \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/releases/assets/:asset_id" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n asset_id: 'asset_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/update-release.json b/openapi/ghe-2.14/operations/repos/update-release.json new file mode 100644 index 0000000000..faeb69e52d --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/update-release.json @@ -0,0 +1,324 @@ +{ + "summary": "Edit a release", + "description": "Users with push access to the repository can edit a release.", + "operationId": "repos-update-release", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/releases/#edit-a-release" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + }, + { + "name": "release_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "release_id parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "tag_name": { + "description": "The name of the tag.", + "type": "string" + }, + "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`).", + "type": "string" + }, + "name": { + "description": "The name of the release.", + "type": "string" + }, + "body": { + "description": "Text describing the contents of the tag.", + "type": "string" + }, + "draft": { + "description": "`true` makes the release a draft, and `false` publishes the release.", + "type": "boolean" + }, + "prerelease": { + "description": "`true` to identify the release as a prerelease, `false` to identify the release as a full release.", + "type": "boolean" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "assets_url": { + "type": "string" + }, + "upload_url": { + "type": "string" + }, + "tarball_url": { + "type": "string" + }, + "zipball_url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "tag_name": { + "type": "string" + }, + "target_commitish": { + "type": "string" + }, + "name": { + "type": "string" + }, + "body": { + "type": "string" + }, + "draft": { + "type": "boolean" + }, + "prerelease": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "published_at": { + "type": "string" + }, + "author": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "assets": { + "type": "array", + "items": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "browser_download_url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "label": { + "type": "string" + }, + "state": { + "type": "string" + }, + "content_type": { + "type": "string" + }, + "size": { + "type": "number" + }, + "download_count": { + "type": "number" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "uploader": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + } + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPATCH \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/repos/octocat/:repo/releases/:release_id" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n release_id: 'release_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/repos/update.json b/openapi/ghe-2.14/operations/repos/update.json new file mode 100644 index 0000000000..25c413c993 --- /dev/null +++ b/openapi/ghe-2.14/operations/repos/update.json @@ -0,0 +1,1106 @@ +{ + "summary": "Edit", + "description": "**Note**: To edit a repository's topics, use the [`topics` endpoint](https://developer.github.com/enterprise/2.14/v3/repos/#replace-all-topics-for-a-repository).", + "operationId": "repos-update", + "tags": [ + "repos" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/repos/#edit" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.x-ray-preview+json" + }, + "required": true + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "The name of the repository.", + "type": "string" + }, + "description": { + "description": "A short description of the repository.", + "type": "string" + }, + "homepage": { + "description": "A URL with more information about the repository.", + "type": "string" + }, + "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, or if the \"Users Can Change Repo Visibility\" appliance setting is disabled and you are not a hosted site admin. **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, or if the \"Users Can Change Repo Visibility\" appliance setting is disabled and you are not a hosted site admin.", + "type": "boolean", + "default": false + }, + "has_issues": { + "description": "Either `true` to enable issues for this repository or `false` to disable them.", + "type": "boolean", + "default": true + }, + "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.", + "type": "boolean", + "default": true + }, + "has_wiki": { + "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", + "type": "boolean", + "default": true + }, + "default_branch": { + "description": "Updates the default branch for this repository.", + "type": "string" + }, + "allow_squash_merge": { + "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", + "type": "boolean", + "default": true + }, + "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.", + "type": "boolean", + "default": true + }, + "allow_rebase_merge": { + "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", + "type": "boolean", + "default": true + }, + "archived": { + "description": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.", + "type": "boolean", + "default": false + }, + "anonymous_access_enabled": { + "description": "Either `true` to allow anonymous Git access to a public repository, or `false` to disable it. This feature is only available to site and repository administrators in GitHub Enterprise instances that have private mode enabled.", + "type": "boolean", + "default": false + } + }, + "required": [ + "name" + ] + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "number" + }, + "stargazers_count": { + "type": "number" + }, + "watchers_count": { + "type": "number" + }, + "size": { + "type": "number" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "number" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "number" + }, + "network_count": { + "type": "number" + }, + "anonymous_access_enabled": { + "type": "boolean" + }, + "organization": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "parent": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "number" + }, + "stargazers_count": { + "type": "number" + }, + "watchers_count": { + "type": "number" + }, + "size": { + "type": "number" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "number" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "number" + }, + "network_count": { + "type": "number" + } + } + }, + "source": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "number" + }, + "stargazers_count": { + "type": "number" + }, + "watchers_count": { + "type": "number" + }, + "size": { + "type": "number" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "number" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "number" + }, + "network_count": { + "type": "number" + }, + "anonymous_access_enabled": { + "type": "boolean" + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPATCH \\\n -H\"Accept: application/vnd.github.x-ray-preview+json\" \\\n https://developer.github.com/repos/octocat/:repo \\\n -d '{\"name\":\"name\"}'" + }, + { + "lang": "JS", + "source": "octokit.repos.get({\n owner: 'octocat',\n repo: 'hello-world',\n name: 'name'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/search/code.json b/openapi/ghe-2.14/operations/search/code.json new file mode 100644 index 0000000000..26b794f87d --- /dev/null +++ b/openapi/ghe-2.14/operations/search/code.json @@ -0,0 +1,99 @@ +{ + "summary": "Search code", + "description": "Find file contents via various criteria. This method returns up to 100 results [per page](https://developer.github.com/enterprise/2.14/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/enterprise/2.14/v3/search/#text-match-metadata).\n\n**Note:** You must [authenticate](https://developer.github.com/enterprise/2.14/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 10 MB are searchable.\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.", + "operationId": "search-code", + "tags": [ + "search" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/search/#search-code" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "q", + "in": "query", + "schema": { + "type": "string" + }, + "required": true, + "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/enterprise/2.14/v3/search/#constructing-a-search-query). See \"[Searching code](https://help.github.com/articles/searching-code/)\" for a detailed list of qualifiers." + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "indexed" + ] + }, + "required": false, + "description": "Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub Enterprise search infrastructure. Default: [best match](https://developer.github.com/enterprise/2.14/v3/search/#ranking-search-results)" + }, + { + "name": "order", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "desc", + "asc" + ], + "default": "desc" + }, + "required": false, + "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": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/search/code" + }, + { + "lang": "JS", + "source": "octokit.search.get({\n q: 'q'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/search/commits.json b/openapi/ghe-2.14/operations/search/commits.json new file mode 100644 index 0000000000..64c3230761 --- /dev/null +++ b/openapi/ghe-2.14/operations/search/commits.json @@ -0,0 +1,101 @@ +{ + "summary": "Search commits", + "description": "Find commits via various criteria. This method returns up to 100 results [per page](https://developer.github.com/enterprise/2.14/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/enterprise/2.14/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:", + "operationId": "search-commits", + "tags": [ + "search" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/search/#search-commits" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.cloak-preview+json" + }, + "required": true + }, + { + "name": "q", + "in": "query", + "schema": { + "type": "string" + }, + "required": true, + "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/enterprise/2.14/v3/search/#constructing-a-search-query). See \"[Searching commits](https://help.github.com/articles/searching-commits/)\" for a detailed list of qualifiers." + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "author-date", + "committer-date" + ] + }, + "required": false, + "description": "Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://developer.github.com/enterprise/2.14/v3/search/#ranking-search-results)" + }, + { + "name": "order", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "desc", + "asc" + ], + "default": "desc" + }, + "required": false, + "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": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.cloak-preview+json\" \\\n https://developer.github.com/search/commits" + }, + { + "lang": "JS", + "source": "octokit.search.get({\n q: 'q'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/search/email-legacy.json b/openapi/ghe-2.14/operations/search/email-legacy.json new file mode 100644 index 0000000000..776e8d0af8 --- /dev/null +++ b/openapi/ghe-2.14/operations/search/email-legacy.json @@ -0,0 +1,53 @@ +{ + "summary": "Email search", + "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 Enterprise profile).", + "operationId": "search-email-legacy", + "tags": [ + "search" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/search/legacy/#email-search" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "email", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "The email address." + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/legacy/user/email/" + }, + { + "lang": "JS", + "source": "octokit.search.get({\n email: 'email'\n})" + } + ], + "x-github": { + "legacy": true, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/search/issues-and-pull-requests.json b/openapi/ghe-2.14/operations/search/issues-and-pull-requests.json new file mode 100644 index 0000000000..dd08281614 --- /dev/null +++ b/openapi/ghe-2.14/operations/search/issues-and-pull-requests.json @@ -0,0 +1,123 @@ +{ + "summary": "Search issues and pull requests", + "description": "Find issues by state and keyword. This method returns up to 100 results [per page](https://developer.github.com/enterprise/2.14/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/enterprise/2.14/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.", + "operationId": "search-issues-and-pull-requests", + "tags": [ + "search" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/search/#search-issues-and-pull-requests" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "q", + "in": "query", + "schema": { + "type": "string" + }, + "required": true, + "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/enterprise/2.14/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." + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "comments", + "reactions", + "reactions-+1", + "reactions--1", + "reactions-smile", + "reactions-thinking_face", + "reactions-heart", + "reactions-tada", + "interactions", + "created", + "updated" + ] + }, + "required": false, + "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/enterprise/2.14/v3/search/#ranking-search-results)" + }, + { + "name": "order", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "desc", + "asc" + ], + "default": "desc" + }, + "required": false, + "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": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/search/issues" + }, + { + "lang": "JS", + "source": "octokit.search.get({\n q: 'q'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [ + { + "type": "idName", + "date": "2018-12-27", + "note": "\"Search issues\" has been renamed to \"Search issues and pull requests\"", + "meta": { + "before": { + "idName": "issues" + }, + "after": { + "idName": "issues-and-pull-requests" + } + } + } + ] +} diff --git a/openapi/ghe-2.14/operations/search/issues-legacy.json b/openapi/ghe-2.14/operations/search/issues-legacy.json new file mode 100644 index 0000000000..e6e9cc660f --- /dev/null +++ b/openapi/ghe-2.14/operations/search/issues-legacy.json @@ -0,0 +1,84 @@ +{ + "summary": "Search issues", + "description": "Find issues by state and keyword.", + "operationId": "search-issues-legacy", + "tags": [ + "search" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/search/legacy/#search-issues" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repository", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repository parameter" + }, + { + "name": "state", + "in": "path", + "schema": { + "type": "string", + "enum": [ + "open", + "closed" + ] + }, + "required": true, + "description": "Indicates the state of the issues to return. Can be either `open` or `closed`." + }, + { + "name": "keyword", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "The search term." + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/legacy/issues/search/octocat/:repository/:state/:keyword" + }, + { + "lang": "JS", + "source": "octokit.search.get({\n owner: 'octocat',\n repository: 'repository',\n state: 'state',\n keyword: 'keyword'\n})" + } + ], + "x-github": { + "legacy": true, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/search/labels.json b/openapi/ghe-2.14/operations/search/labels.json new file mode 100644 index 0000000000..4a6b2aba24 --- /dev/null +++ b/openapi/ghe-2.14/operations/search/labels.json @@ -0,0 +1,89 @@ +{ + "summary": "Search labels", + "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/enterprise/2.14/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/enterprise/2.14/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.", + "operationId": "search-labels", + "tags": [ + "search" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/search/#search-labels" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "repository_id", + "in": "query", + "schema": { + "type": "integer" + }, + "required": true, + "description": "The id of the repository." + }, + { + "name": "q", + "in": "query", + "schema": { + "type": "string" + }, + "required": true, + "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/enterprise/2.14/v3/search/#constructing-a-search-query)." + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "created", + "updated" + ] + }, + "required": false, + "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://developer.github.com/enterprise/2.14/v3/search/#ranking-search-results)" + }, + { + "name": "order", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "desc", + "asc" + ], + "default": "desc" + }, + "required": false, + "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`." + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/search/labels" + }, + { + "lang": "JS", + "source": "octokit.search.get({\n repository_id: 'repository_id',\n q: 'q'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/search/repos-legacy.json b/openapi/ghe-2.14/operations/search/repos-legacy.json new file mode 100644 index 0000000000..caf72ea91e --- /dev/null +++ b/openapi/ghe-2.14/operations/search/repos-legacy.json @@ -0,0 +1,98 @@ +{ + "summary": "Search repositories", + "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.", + "operationId": "search-repos-legacy", + "tags": [ + "search" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/search/legacy/#search-repositories" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "keyword", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "The search term." + }, + { + "name": "language", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "description": "Filter results by language." + }, + { + "name": "start_page", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "description": "The page number to fetch." + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "stars", + "forks", + "updated" + ] + }, + "required": false, + "description": "The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match." + }, + { + "name": "order", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ] + }, + "required": false, + "description": "The sort field. if `sort` param is provided. Can be either `asc` or `desc`." + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/legacy/repos/search/" + }, + { + "lang": "JS", + "source": "octokit.search.get({\n keyword: 'keyword'\n})" + } + ], + "x-github": { + "legacy": true, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/search/repos.json b/openapi/ghe-2.14/operations/search/repos.json new file mode 100644 index 0000000000..cdea513bf7 --- /dev/null +++ b/openapi/ghe-2.14/operations/search/repos.json @@ -0,0 +1,102 @@ +{ + "summary": "Search repositories", + "description": "Find repositories via various criteria. This method returns up to 100 results [per page](https://developer.github.com/enterprise/2.14/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/enterprise/2.14/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.", + "operationId": "search-repos", + "tags": [ + "search" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/search/#search-repositories" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "q", + "in": "query", + "schema": { + "type": "string" + }, + "required": true, + "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/enterprise/2.14/v3/search/#constructing-a-search-query). See \"[Searching for repositories](https://help.github.com/articles/searching-for-repositories/)\" for a detailed list of qualifiers." + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "stars", + "forks", + "help-wanted-issues", + "updated" + ] + }, + "required": false, + "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/enterprise/2.14/v3/search/#ranking-search-results)" + }, + { + "name": "order", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "desc", + "asc" + ], + "default": "desc" + }, + "required": false, + "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": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/search/repositories" + }, + { + "lang": "JS", + "source": "octokit.search.get({\n q: 'q'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/search/topics.json b/openapi/ghe-2.14/operations/search/topics.json new file mode 100644 index 0000000000..2a85b735d1 --- /dev/null +++ b/openapi/ghe-2.14/operations/search/topics.json @@ -0,0 +1,53 @@ +{ + "summary": "Search topics", + "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/enterprise/2.14/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/enterprise/2.14/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/enterprise/2.14/v3/#link-header) indicating pagination is not included in the response.", + "operationId": "search-topics", + "tags": [ + "search" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/search/#search-topics" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "q", + "in": "query", + "schema": { + "type": "string" + }, + "required": true, + "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/enterprise/2.14/v3/search/#constructing-a-search-query)." + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/search/topics" + }, + { + "lang": "JS", + "source": "octokit.search.get({\n q: 'q'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/search/users-legacy.json b/openapi/ghe-2.14/operations/search/users-legacy.json new file mode 100644 index 0000000000..7c4cc305df --- /dev/null +++ b/openapi/ghe-2.14/operations/search/users-legacy.json @@ -0,0 +1,89 @@ +{ + "summary": "Search users", + "description": "Find users by keyword.", + "operationId": "search-users-legacy", + "tags": [ + "search" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/search/legacy/#search-users" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "keyword", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "The search term." + }, + { + "name": "start_page", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "description": "The page number to fetch." + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "stars", + "forks", + "updated" + ] + }, + "required": false, + "description": "The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match." + }, + { + "name": "order", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ] + }, + "required": false, + "description": "The sort field. if `sort` param is provided. Can be either `asc` or `desc`." + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/legacy/user/search/" + }, + { + "lang": "JS", + "source": "octokit.search.get({\n keyword: 'keyword'\n})" + } + ], + "x-github": { + "legacy": true, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/search/users.json b/openapi/ghe-2.14/operations/search/users.json new file mode 100644 index 0000000000..4069661038 --- /dev/null +++ b/openapi/ghe-2.14/operations/search/users.json @@ -0,0 +1,101 @@ +{ + "summary": "Search users", + "description": "Find users via various criteria. This method returns up to 100 results [per page](https://developer.github.com/enterprise/2.14/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/enterprise/2.14/v3/search/#text-match-metadata). For more details about how to receive highlighted search results, see [Text match metadata](https://developer.github.com/enterprise/2.14/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.", + "operationId": "search-users", + "tags": [ + "search" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/search/#search-users" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "q", + "in": "query", + "schema": { + "type": "string" + }, + "required": true, + "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/enterprise/2.14/v3/search/#constructing-a-search-query). See \"[Searching users](https://help.github.com/articles/searching-users/)\" for a detailed list of qualifiers." + }, + { + "name": "sort", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "followers", + "repositories", + "joined" + ] + }, + "required": false, + "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise. Default: [best match](https://developer.github.com/enterprise/2.14/v3/search/#ranking-search-results)" + }, + { + "name": "order", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "desc", + "asc" + ], + "default": "desc" + }, + "required": false, + "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": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/search/users" + }, + { + "lang": "JS", + "source": "octokit.search.get({\n q: 'q'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/teams/add-member.json b/openapi/ghe-2.14/operations/teams/add-member.json new file mode 100644 index 0000000000..56f91e0285 --- /dev/null +++ b/openapi/ghe-2.14/operations/teams/add-member.json @@ -0,0 +1,62 @@ +{ + "summary": "Add team member", + "description": "The \"Add team member\" API (described below) is deprecated.\n\nWe recommend using the [Add team membership API](https://developer.github.com/enterprise/2.14/v3/teams/members/#add-or-update-team-membership) instead. It allows you to invite new organization members to your teams.\n\nTo add someone to a team, the authenticated user must be a team maintainer in the team they're changing or be an owner of the organization that the team is associated with. The person being added to the team must be a member of the team's organization.\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/enterprise/2.14/v3/#http-verbs).\"", + "operationId": "teams-add-member", + "tags": [ + "teams" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/teams/members/#add-team-member" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "team_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "team_id parameter" + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPUT \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/teams//members/:username" + }, + { + "lang": "JS", + "source": "octokit.teams.get({\n team_id: 'team_id',\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/teams/add-or-update-membership.json b/openapi/ghe-2.14/operations/teams/add-or-update-membership.json new file mode 100644 index 0000000000..7ffc1cc714 --- /dev/null +++ b/openapi/ghe-2.14/operations/teams/add-or-update-membership.json @@ -0,0 +1,82 @@ +{ + "summary": "Add or update team membership", + "description": "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 maintainer of the team.\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 maintainer of the team.", + "operationId": "teams-add-or-update-membership", + "tags": [ + "teams" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/teams/members/#add-or-update-team-membership" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "team_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "team_id parameter" + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "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.", + "type": "string", + "enum": [ + "member", + "maintainer" + ], + "default": "member" + } + } + } + } + } + }, + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPUT \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/teams//memberships/:username" + }, + { + "lang": "JS", + "source": "octokit.teams.get({\n team_id: 'team_id',\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/teams/add-or-update-project.json b/openapi/ghe-2.14/operations/teams/add-or-update-project.json new file mode 100644 index 0000000000..b79e05dc5f --- /dev/null +++ b/openapi/ghe-2.14/operations/teams/add-or-update-project.json @@ -0,0 +1,83 @@ +{ + "summary": "Add or update team project", + "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.", + "operationId": "teams-add-or-update-project", + "tags": [ + "teams" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/teams/#add-or-update-team-project" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.inertia-preview+json" + }, + "required": true + }, + { + "name": "team_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "team_id parameter" + }, + { + "name": "project_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "project_id parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "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/enterprise/2.14/v3/#http-verbs).\" \n**Note**: If you pass the `hellcat-preview` media type, you can promote—but not demote—a `permission` attribute inherited from a parent team.", + "type": "string", + "enum": [ + "read", + "write", + "admin" + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPUT \\\n -H\"Accept: application/vnd.github.inertia-preview+json\" \\\n https://developer.github.com/teams//projects/:project_id" + }, + { + "lang": "JS", + "source": "octokit.teams.get({\n team_id: 'team_id',\n project_id: 'project_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/teams/add-or-update-repo.json b/openapi/ghe-2.14/operations/teams/add-or-update-repo.json new file mode 100644 index 0000000000..f72b9ff708 --- /dev/null +++ b/openapi/ghe-2.14/operations/teams/add-or-update-repo.json @@ -0,0 +1,91 @@ +{ + "summary": "Add or update team repository", + "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.\n\nIf you pass the `hellcat-preview` media type, you can modify repository permissions of child teams.\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/enterprise/2.14/v3/#http-verbs).\"", + "operationId": "teams-add-or-update-repo", + "tags": [ + "teams" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/teams/#add-or-update-team-repository" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "team_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "team_id parameter" + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "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. \n**Note**: If you pass the `hellcat-preview` media type, you can promote—but not demote—a `permission` attribute inherited through a parent team.", + "type": "string", + "enum": [ + "pull", + "push", + "admin" + ] + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPUT \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/teams//repos/:owner/:repo" + }, + { + "lang": "JS", + "source": "octokit.teams.get({\n team_id: 'team_id',\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/teams/check-manages-repo.json b/openapi/ghe-2.14/operations/teams/check-manages-repo.json new file mode 100644 index 0000000000..c422eb773a --- /dev/null +++ b/openapi/ghe-2.14/operations/teams/check-manages-repo.json @@ -0,0 +1,71 @@ +{ + "summary": "Check if a team manages a repository", + "description": "**Note**: If you pass the `hellcat-preview` media type, repositories inherited through a parent team will be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://developer.github.com/enterprise/2.14/v3/media/) via the `Accept` header:", + "operationId": "teams-check-manages-repo", + "tags": [ + "teams" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/teams/#check-if-a-team-manages-a-repository" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "team_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "team_id parameter" + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/teams//repos/:owner/:repo" + }, + { + "lang": "JS", + "source": "octokit.teams.get({\n team_id: 'team_id',\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/teams/create-discussion-comment.json b/openapi/ghe-2.14/operations/teams/create-discussion-comment.json new file mode 100644 index 0000000000..6b7710abea --- /dev/null +++ b/openapi/ghe-2.14/operations/teams/create-discussion-comment.json @@ -0,0 +1,210 @@ +{ + "summary": "Create a comment", + "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/enterprise/2.14/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/enterprise/2.14/v3/#abuse-rate-limits)\" for details.", + "operationId": "teams-create-discussion-comment", + "tags": [ + "teams" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/teams/discussion_comments/#create-a-comment" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.echo-preview+json" + }, + "required": true + }, + { + "name": "team_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "team_id parameter" + }, + { + "name": "discussion_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "discussion_number parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "description": "The discussion comment's body text.", + "type": "string" + } + }, + "required": [ + "body" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "author": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "body": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "body_version": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "last_edited_at": { + "type": "string" + }, + "discussion_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "number" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "reactions": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "total_count": { + "type": "number" + }, + "+1": { + "type": "number" + }, + "-1": { + "type": "number" + }, + "laugh": { + "type": "number" + }, + "confused": { + "type": "number" + }, + "heart": { + "type": "number" + }, + "hooray": { + "type": "number" + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.echo-preview+json\" \\\n https://developer.github.com/teams//discussions/:discussion_number/comments \\\n -d '{\"body\":\"body\"}'" + }, + { + "lang": "JS", + "source": "octokit.teams.get({\n team_id: 'team_id',\n discussion_number: 'discussion_number',\n body: 'body'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/teams/create-discussion.json b/openapi/ghe-2.14/operations/teams/create-discussion.json new file mode 100644 index 0000000000..b1b0628cdb --- /dev/null +++ b/openapi/ghe-2.14/operations/teams/create-discussion.json @@ -0,0 +1,226 @@ +{ + "summary": "Create a discussion", + "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/enterprise/2.14/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/enterprise/2.14/v3/#abuse-rate-limits)\" for details.", + "operationId": "teams-create-discussion", + "tags": [ + "teams" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/teams/discussions/#create-a-discussion" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.echo-preview+json" + }, + "required": true + }, + { + "name": "team_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "team_id parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "description": "The discussion post's title.", + "type": "string" + }, + "body": { + "description": "The discussion post's body text.", + "type": "string" + }, + "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.", + "type": "boolean", + "default": false + } + }, + "required": [ + "title", + "body" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "author": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "body": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "body_version": { + "type": "string" + }, + "comments_count": { + "type": "number" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "last_edited_at": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "number" + }, + "pinned": { + "type": "boolean" + }, + "private": { + "type": "boolean" + }, + "team_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "reactions": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "total_count": { + "type": "number" + }, + "+1": { + "type": "number" + }, + "-1": { + "type": "number" + }, + "laugh": { + "type": "number" + }, + "confused": { + "type": "number" + }, + "heart": { + "type": "number" + }, + "hooray": { + "type": "number" + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.echo-preview+json\" \\\n https://developer.github.com/teams//discussions \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'" + }, + { + "lang": "JS", + "source": "octokit.teams.get({\n team_id: 'team_id',\n title: 'title',\n body: 'body'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/teams/create.json b/openapi/ghe-2.14/operations/teams/create.json new file mode 100644 index 0000000000..687841d3c5 --- /dev/null +++ b/openapi/ghe-2.14/operations/teams/create.json @@ -0,0 +1,254 @@ +{ + "summary": "Create team", + "description": "To create a team, the authenticated user must be a member or owner of `:org`.", + "operationId": "teams-create", + "tags": [ + "teams" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/teams/#create-team" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "org", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "org parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "The name of the team.", + "type": "string" + }, + "description": { + "description": "The description of the team.", + "type": "string" + }, + "maintainers": { + "description": "The logins of organization members to add as maintainers of the team.", + "type": "array", + "items": { + "type": "string" + } + }, + "repo_names": { + "description": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.", + "type": "array", + "items": { + "type": "string" + } + }, + "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` \n**Note**: You must pass the `hellcat-preview` media type to set privacy default to `closed` for child teams.", + "type": "string", + "enum": [ + "secret", + "closed" + ] + }, + "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.", + "type": "string", + "enum": [ + "pull", + "push", + "admin" + ], + "default": "pull" + }, + "parent_team_id": { + "description": "The ID of a team to set as the parent team. **Note**: You must pass the `hellcat-preview` media type to use this parameter.", + "type": "integer" + }, + "ldap_dn": { + "description": "The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://help.github.com/enterprise/admin/guides/user-management/using-ldap/#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Update LDAP mapping for a team](https://developer.github.com/enterprise/2.14/v3/enterprise-admin/ldap/#update-ldap-mapping-for-a-team) endpoint to change the LDAP DN.", + "type": "string" + } + }, + "required": [ + "name" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string" + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": "string" + }, + "members_count": { + "type": "number" + }, + "repos_count": { + "type": "number" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "organization": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "name": { + "type": "string" + }, + "company": { + "type": "string" + }, + "blog": { + "type": "string" + }, + "location": { + "type": "string" + }, + "email": { + "type": "string" + }, + "has_organization_projects": { + "type": "boolean" + }, + "has_repository_projects": { + "type": "boolean" + }, + "public_repos": { + "type": "number" + }, + "public_gists": { + "type": "number" + }, + "followers": { + "type": "number" + }, + "following": { + "type": "number" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "type": { + "type": "string" + } + } + }, + "ldap_dn": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/orgs//teams \\\n -d '{\"name\":\"name\"}'" + }, + { + "lang": "JS", + "source": "octokit.teams.get({\n org: 'org',\n name: 'name'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/teams/delete-discussion-comment.json b/openapi/ghe-2.14/operations/teams/delete-discussion-comment.json new file mode 100644 index 0000000000..ca33fe7faf --- /dev/null +++ b/openapi/ghe-2.14/operations/teams/delete-discussion-comment.json @@ -0,0 +1,72 @@ +{ + "summary": "Delete a comment", + "description": "Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/enterprise/2.14/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "operationId": "teams-delete-discussion-comment", + "tags": [ + "teams" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/teams/discussion_comments/#delete-a-comment" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.echo-preview+json" + }, + "required": true + }, + { + "name": "team_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "team_id parameter" + }, + { + "name": "discussion_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "discussion_number parameter" + }, + { + "name": "comment_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "comment_number parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.echo-preview+json\" \\\n https://developer.github.com/teams//discussions/:discussion_number/comments/:comment_number" + }, + { + "lang": "JS", + "source": "octokit.teams.get({\n team_id: 'team_id',\n discussion_number: 'discussion_number',\n comment_number: 'comment_number'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/teams/delete-discussion.json b/openapi/ghe-2.14/operations/teams/delete-discussion.json new file mode 100644 index 0000000000..3c91bcb438 --- /dev/null +++ b/openapi/ghe-2.14/operations/teams/delete-discussion.json @@ -0,0 +1,63 @@ +{ + "summary": "Delete a discussion", + "description": "Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/enterprise/2.14/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "operationId": "teams-delete-discussion", + "tags": [ + "teams" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/teams/discussions/#delete-a-discussion" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.echo-preview+json" + }, + "required": true + }, + { + "name": "team_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "team_id parameter" + }, + { + "name": "discussion_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "discussion_number parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.echo-preview+json\" \\\n https://developer.github.com/teams//discussions/:discussion_number" + }, + { + "lang": "JS", + "source": "octokit.teams.get({\n team_id: 'team_id',\n discussion_number: 'discussion_number'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/teams/delete.json b/openapi/ghe-2.14/operations/teams/delete.json new file mode 100644 index 0000000000..676ea1371f --- /dev/null +++ b/openapi/ghe-2.14/operations/teams/delete.json @@ -0,0 +1,53 @@ +{ + "summary": "Delete team", + "description": "To delete a team, the authenticated user must be a team maintainer or an owner of the org associated with the team.\n\nIf you are an organization owner and you pass the `hellcat-preview` media type, deleting a parent team will delete all of its child teams as well.", + "operationId": "teams-delete", + "tags": [ + "teams" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/teams/#delete-team" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "team_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "team_id parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/teams/" + }, + { + "lang": "JS", + "source": "octokit.teams.get({\n team_id: 'team_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/teams/get-discussion-comment.json b/openapi/ghe-2.14/operations/teams/get-discussion-comment.json new file mode 100644 index 0000000000..f711da18da --- /dev/null +++ b/openapi/ghe-2.14/operations/teams/get-discussion-comment.json @@ -0,0 +1,201 @@ +{ + "summary": "Get a single comment", + "description": "Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/enterprise/2.14/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "operationId": "teams-get-discussion-comment", + "tags": [ + "teams" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/teams/discussion_comments/#get-a-single-comment" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.echo-preview+json" + }, + "required": true + }, + { + "name": "team_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "team_id parameter" + }, + { + "name": "discussion_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "discussion_number parameter" + }, + { + "name": "comment_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "comment_number parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "author": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "body": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "body_version": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "last_edited_at": { + "type": "string" + }, + "discussion_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "number" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "reactions": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "total_count": { + "type": "number" + }, + "+1": { + "type": "number" + }, + "-1": { + "type": "number" + }, + "laugh": { + "type": "number" + }, + "confused": { + "type": "number" + }, + "heart": { + "type": "number" + }, + "hooray": { + "type": "number" + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.echo-preview+json\" \\\n https://developer.github.com/teams//discussions/:discussion_number/comments/:comment_number" + }, + { + "lang": "JS", + "source": "octokit.teams.get({\n team_id: 'team_id',\n discussion_number: 'discussion_number',\n comment_number: 'comment_number'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/teams/get-discussion.json b/openapi/ghe-2.14/operations/teams/get-discussion.json new file mode 100644 index 0000000000..ac0c1e80ec --- /dev/null +++ b/openapi/ghe-2.14/operations/teams/get-discussion.json @@ -0,0 +1,207 @@ +{ + "summary": "Get a single discussion", + "description": "Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/enterprise/2.14/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "operationId": "teams-get-discussion", + "tags": [ + "teams" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/teams/discussions/#get-a-single-discussion" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.echo-preview+json" + }, + "required": true + }, + { + "name": "team_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "team_id parameter" + }, + { + "name": "discussion_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "discussion_number parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "author": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "body": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "body_version": { + "type": "string" + }, + "comments_count": { + "type": "number" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "last_edited_at": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "number" + }, + "pinned": { + "type": "boolean" + }, + "private": { + "type": "boolean" + }, + "team_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "reactions": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "total_count": { + "type": "number" + }, + "+1": { + "type": "number" + }, + "-1": { + "type": "number" + }, + "laugh": { + "type": "number" + }, + "confused": { + "type": "number" + }, + "heart": { + "type": "number" + }, + "hooray": { + "type": "number" + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.echo-preview+json\" \\\n https://developer.github.com/teams//discussions/:discussion_number" + }, + { + "lang": "JS", + "source": "octokit.teams.get({\n team_id: 'team_id',\n discussion_number: 'discussion_number'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/teams/get-member.json b/openapi/ghe-2.14/operations/teams/get-member.json new file mode 100644 index 0000000000..e2c63fccc6 --- /dev/null +++ b/openapi/ghe-2.14/operations/teams/get-member.json @@ -0,0 +1,62 @@ +{ + "summary": "Get team member", + "description": "The \"Get team member\" API (described below) is deprecated.\n\nWe recommend using the [Get team membership API](https://developer.github.com/enterprise/2.14/v3/teams/members/#get-team-membership) 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.", + "operationId": "teams-get-member", + "tags": [ + "teams" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/teams/members/#get-team-member" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "team_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "team_id parameter" + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/teams//members/:username" + }, + { + "lang": "JS", + "source": "octokit.teams.get({\n team_id: 'team_id',\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/teams/get-membership.json b/openapi/ghe-2.14/operations/teams/get-membership.json new file mode 100644 index 0000000000..c2d1c33330 --- /dev/null +++ b/openapi/ghe-2.14/operations/teams/get-membership.json @@ -0,0 +1,62 @@ +{ + "summary": "Get team membership", + "description": "If you pass the `hellcat-preview` media type, 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:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create team](https://developer.github.com/enterprise/2.14/v3/teams#create-team).", + "operationId": "teams-get-membership", + "tags": [ + "teams" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/teams/members/#get-team-membership" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "team_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "team_id parameter" + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/teams//memberships/:username" + }, + { + "lang": "JS", + "source": "octokit.teams.get({\n team_id: 'team_id',\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/teams/get.json b/openapi/ghe-2.14/operations/teams/get.json new file mode 100644 index 0000000000..e7f01cc869 --- /dev/null +++ b/openapi/ghe-2.14/operations/teams/get.json @@ -0,0 +1,192 @@ +{ + "summary": "Get team", + "description": "", + "operationId": "teams-get", + "tags": [ + "teams" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/teams/#get-team" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "team_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "team_id parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string" + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": "string" + }, + "members_count": { + "type": "number" + }, + "repos_count": { + "type": "number" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "organization": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "name": { + "type": "string" + }, + "company": { + "type": "string" + }, + "blog": { + "type": "string" + }, + "location": { + "type": "string" + }, + "email": { + "type": "string" + }, + "has_organization_projects": { + "type": "boolean" + }, + "has_repository_projects": { + "type": "boolean" + }, + "public_repos": { + "type": "number" + }, + "public_gists": { + "type": "number" + }, + "followers": { + "type": "number" + }, + "following": { + "type": "number" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "type": { + "type": "string" + } + } + }, + "ldap_dn": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/teams/" + }, + { + "lang": "JS", + "source": "octokit.teams.get({\n team_id: 'team_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/teams/list-child.json b/openapi/ghe-2.14/operations/teams/list-child.json new file mode 100644 index 0000000000..abe2427478 --- /dev/null +++ b/openapi/ghe-2.14/operations/teams/list-child.json @@ -0,0 +1,74 @@ +{ + "summary": "List child teams", + "description": "At this time, the `hellcat-preview` media type is required to use this endpoint.\n\n", + "operationId": "teams-list-child", + "tags": [ + "teams" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/teams/#list-child-teams" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.hellcat-preview+json" + }, + "required": true + }, + { + "name": "team_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "team_id parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.hellcat-preview+json\" \\\n https://developer.github.com/teams//teams" + }, + { + "lang": "JS", + "source": "octokit.teams.get({\n team_id: 'team_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/teams/list-discussion-comments.json b/openapi/ghe-2.14/operations/teams/list-discussion-comments.json new file mode 100644 index 0000000000..dc17a4a26f --- /dev/null +++ b/openapi/ghe-2.14/operations/teams/list-discussion-comments.json @@ -0,0 +1,102 @@ +{ + "summary": "List comments", + "description": "List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/enterprise/2.14/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "operationId": "teams-list-discussion-comments", + "tags": [ + "teams" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/teams/discussion_comments/#list-comments" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.echo-preview+json" + }, + "required": true + }, + { + "name": "team_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "team_id parameter" + }, + { + "name": "discussion_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "discussion_number parameter" + }, + { + "name": "direction", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "required": false, + "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`." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.echo-preview+json\" \\\n https://developer.github.com/teams//discussions/:discussion_number/comments" + }, + { + "lang": "JS", + "source": "octokit.teams.get({\n team_id: 'team_id',\n discussion_number: 'discussion_number'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/teams/list-discussions.json b/openapi/ghe-2.14/operations/teams/list-discussions.json new file mode 100644 index 0000000000..d6afbd486f --- /dev/null +++ b/openapi/ghe-2.14/operations/teams/list-discussions.json @@ -0,0 +1,93 @@ +{ + "summary": "List discussions", + "description": "List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://developer.github.com/enterprise/2.14/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "operationId": "teams-list-discussions", + "tags": [ + "teams" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/teams/discussions/#list-discussions" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.echo-preview+json" + }, + "required": true + }, + { + "name": "team_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "team_id parameter" + }, + { + "name": "direction", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "required": false, + "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`." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.echo-preview+json\" \\\n https://developer.github.com/teams//discussions" + }, + { + "lang": "JS", + "source": "octokit.teams.get({\n team_id: 'team_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/teams/list-for-authenticated-user.json b/openapi/ghe-2.14/operations/teams/list-for-authenticated-user.json new file mode 100644 index 0000000000..7c3ee6cb2d --- /dev/null +++ b/openapi/ghe-2.14/operations/teams/list-for-authenticated-user.json @@ -0,0 +1,69 @@ +{ + "summary": "List user teams", + "description": "List all of the teams across all of the organizations to which the authenticated user belongs. This method requires `user`, `repo`, or `read:org` [scope](https://developer.github.com/enterprise/2.14/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/) when authenticating via [OAuth](https://developer.github.com/enterprise/2.14/apps/building-oauth-apps/).", + "operationId": "teams-list-for-authenticated-user", + "tags": [ + "teams" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/teams/#list-user-teams" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/user/teams" + }, + { + "lang": "JS", + "source": "octokit.teams.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/teams/list-members.json b/openapi/ghe-2.14/operations/teams/list-members.json new file mode 100644 index 0000000000..9ebebcedaf --- /dev/null +++ b/openapi/ghe-2.14/operations/teams/list-members.json @@ -0,0 +1,93 @@ +{ + "summary": "List team members", + "description": "If you pass the `hellcat-preview` media type, 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.", + "operationId": "teams-list-members", + "tags": [ + "teams" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/teams/members/#list-team-members" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "team_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "team_id parameter" + }, + { + "name": "role", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "member", + "maintainer", + "all" + ], + "default": "all" + }, + "required": false, + "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." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/teams//members" + }, + { + "lang": "JS", + "source": "octokit.teams.get({\n team_id: 'team_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/teams/list-projects.json b/openapi/ghe-2.14/operations/teams/list-projects.json new file mode 100644 index 0000000000..f9bd90d9b6 --- /dev/null +++ b/openapi/ghe-2.14/operations/teams/list-projects.json @@ -0,0 +1,79 @@ +{ + "summary": "List team projects", + "description": "Lists the organization projects for a team. If you are an [authenticated](https://developer.github.com/enterprise/2.14/v3/#authentication) site administrator for your Enterprise instance, you will be able to list all projects for the team. If you pass the `hellcat-preview` media type, the response will include projects inherited from a parent team.", + "operationId": "teams-list-projects", + "tags": [ + "teams" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/teams/#list-team-projects" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.inertia-preview+json" + }, + "required": true + }, + { + "name": "team_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "team_id parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.inertia-preview+json\" \\\n https://developer.github.com/teams//projects" + }, + { + "lang": "JS", + "source": "octokit.teams.get({\n team_id: 'team_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/teams/list-repos.json b/openapi/ghe-2.14/operations/teams/list-repos.json new file mode 100644 index 0000000000..e989b79886 --- /dev/null +++ b/openapi/ghe-2.14/operations/teams/list-repos.json @@ -0,0 +1,78 @@ +{ + "summary": "List team repos", + "description": "**Note**: If you pass the `hellcat-preview` media type, the response will include any repositories inherited through a parent team.\n\nIf you are an [authenticated](https://developer.github.com/enterprise/2.14/v3/#authentication) site administrator for your Enterprise instance, you will be able to list all repositories for the team.", + "operationId": "teams-list-repos", + "tags": [ + "teams" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/teams/#list-team-repos" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "team_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "team_id parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/teams//repos" + }, + { + "lang": "JS", + "source": "octokit.teams.get({\n team_id: 'team_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/teams/list.json b/openapi/ghe-2.14/operations/teams/list.json new file mode 100644 index 0000000000..274aaf2369 --- /dev/null +++ b/openapi/ghe-2.14/operations/teams/list.json @@ -0,0 +1,78 @@ +{ + "summary": "List teams", + "description": "", + "operationId": "teams-list", + "tags": [ + "teams" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/teams/#list-teams" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "org", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "org parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/orgs//teams" + }, + { + "lang": "JS", + "source": "octokit.teams.get({\n org: 'org'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/teams/remove-member.json b/openapi/ghe-2.14/operations/teams/remove-member.json new file mode 100644 index 0000000000..c7c9e416b6 --- /dev/null +++ b/openapi/ghe-2.14/operations/teams/remove-member.json @@ -0,0 +1,62 @@ +{ + "summary": "Remove team member", + "description": "The \"Remove team member\" API (described below) is deprecated.\n\nWe recommend using the [Remove team membership endpoint](https://developer.github.com/enterprise/2.14/v3/teams/members/#remove-team-membership) instead. It allows you to remove both active and pending memberships.\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.", + "operationId": "teams-remove-member", + "tags": [ + "teams" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/teams/members/#remove-team-member" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "team_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "team_id parameter" + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/teams//members/:username" + }, + { + "lang": "JS", + "source": "octokit.teams.get({\n team_id: 'team_id',\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/teams/remove-membership.json b/openapi/ghe-2.14/operations/teams/remove-membership.json new file mode 100644 index 0000000000..0547d86dbf --- /dev/null +++ b/openapi/ghe-2.14/operations/teams/remove-membership.json @@ -0,0 +1,62 @@ +{ + "summary": "Remove team membership", + "description": "To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.", + "operationId": "teams-remove-membership", + "tags": [ + "teams" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/teams/members/#remove-team-membership" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "team_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "team_id parameter" + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/teams//memberships/:username" + }, + { + "lang": "JS", + "source": "octokit.teams.get({\n team_id: 'team_id',\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/teams/remove-project.json b/openapi/ghe-2.14/operations/teams/remove-project.json new file mode 100644 index 0000000000..079b954781 --- /dev/null +++ b/openapi/ghe-2.14/operations/teams/remove-project.json @@ -0,0 +1,62 @@ +{ + "summary": "Remove team project", + "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. **Note:** This endpoint removes the project from the team, but does not delete it.", + "operationId": "teams-remove-project", + "tags": [ + "teams" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/teams/#remove-team-project" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "team_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "team_id parameter" + }, + { + "name": "project_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "project_id parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/teams//projects/:project_id" + }, + { + "lang": "JS", + "source": "octokit.teams.get({\n team_id: 'team_id',\n project_id: 'project_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/teams/remove-repo.json b/openapi/ghe-2.14/operations/teams/remove-repo.json new file mode 100644 index 0000000000..8c04159c92 --- /dev/null +++ b/openapi/ghe-2.14/operations/teams/remove-repo.json @@ -0,0 +1,71 @@ +{ + "summary": "Remove team repository", + "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. NOTE: This does not delete the repository, it just removes it from the team.", + "operationId": "teams-remove-repo", + "tags": [ + "teams" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/teams/#remove-team-repository" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "team_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "team_id parameter" + }, + { + "name": "owner", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "owner parameter" + }, + { + "name": "repo", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "repo parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/teams//repos/:owner/:repo" + }, + { + "lang": "JS", + "source": "octokit.teams.get({\n team_id: 'team_id',\n owner: 'octocat',\n repo: 'hello-world'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/teams/review-project.json b/openapi/ghe-2.14/operations/teams/review-project.json new file mode 100644 index 0000000000..edfa2d1007 --- /dev/null +++ b/openapi/ghe-2.14/operations/teams/review-project.json @@ -0,0 +1,186 @@ +{ + "summary": "Review a team project", + "description": "Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. If you pass the `hellcat-preview` media type, the response will include projects inherited from a parent team.", + "operationId": "teams-review-project", + "tags": [ + "teams" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/teams/#review-a-team-project" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.inertia-preview+json" + }, + "required": true + }, + { + "name": "team_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "team_id parameter" + }, + { + "name": "project_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "project_id parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "owner_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "columns_url": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "body": { + "type": "string" + }, + "number": { + "type": "number" + }, + "state": { + "type": "string" + }, + "creator": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "organization_permission": { + "type": "string" + }, + "private": { + "type": "boolean" + }, + "permissions": { + "type": "object", + "properties": { + "read": { + "type": "boolean" + }, + "write": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.inertia-preview+json\" \\\n https://developer.github.com/teams//projects/:project_id" + }, + { + "lang": "JS", + "source": "octokit.teams.get({\n team_id: 'team_id',\n project_id: 'project_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/teams/update-discussion-comment.json b/openapi/ghe-2.14/operations/teams/update-discussion-comment.json new file mode 100644 index 0000000000..d503f180f2 --- /dev/null +++ b/openapi/ghe-2.14/operations/teams/update-discussion-comment.json @@ -0,0 +1,219 @@ +{ + "summary": "Edit a comment", + "description": "Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://developer.github.com/enterprise/2.14/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "operationId": "teams-update-discussion-comment", + "tags": [ + "teams" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/teams/discussion_comments/#edit-a-comment" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.echo-preview+json" + }, + "required": true + }, + { + "name": "team_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "team_id parameter" + }, + { + "name": "discussion_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "discussion_number parameter" + }, + { + "name": "comment_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "comment_number parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "description": "The discussion comment's body text.", + "type": "string" + } + }, + "required": [ + "body" + ] + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "author": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "body": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "body_version": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "last_edited_at": { + "type": "string" + }, + "discussion_url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "number" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "reactions": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "total_count": { + "type": "number" + }, + "+1": { + "type": "number" + }, + "-1": { + "type": "number" + }, + "laugh": { + "type": "number" + }, + "confused": { + "type": "number" + }, + "heart": { + "type": "number" + }, + "hooray": { + "type": "number" + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPATCH \\\n -H\"Accept: application/vnd.github.echo-preview+json\" \\\n https://developer.github.com/teams//discussions/:discussion_number/comments/:comment_number \\\n -d '{\"body\":\"body\"}'" + }, + { + "lang": "JS", + "source": "octokit.teams.get({\n team_id: 'team_id',\n discussion_number: 'discussion_number',\n comment_number: 'comment_number',\n body: 'body'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/teams/update-discussion.json b/openapi/ghe-2.14/operations/teams/update-discussion.json new file mode 100644 index 0000000000..e216e3a391 --- /dev/null +++ b/openapi/ghe-2.14/operations/teams/update-discussion.json @@ -0,0 +1,226 @@ +{ + "summary": "Edit a discussion", + "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/enterprise/2.14/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "operationId": "teams-update-discussion", + "tags": [ + "teams" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/teams/discussions/#edit-a-discussion" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.echo-preview+json" + }, + "required": true + }, + { + "name": "team_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "team_id parameter" + }, + { + "name": "discussion_number", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "discussion_number parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "description": "The discussion post's title.", + "type": "string" + }, + "body": { + "description": "The discussion post's body text.", + "type": "string" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "author": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "body": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "body_version": { + "type": "string" + }, + "comments_count": { + "type": "number" + }, + "comments_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "last_edited_at": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "node_id": { + "type": "string" + }, + "number": { + "type": "number" + }, + "pinned": { + "type": "boolean" + }, + "private": { + "type": "boolean" + }, + "team_url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "url": { + "type": "string" + }, + "reactions": { + "type": "object", + "properties": { + "url": { + "type": "string" + }, + "total_count": { + "type": "number" + }, + "+1": { + "type": "number" + }, + "-1": { + "type": "number" + }, + "laugh": { + "type": "number" + }, + "confused": { + "type": "number" + }, + "heart": { + "type": "number" + }, + "hooray": { + "type": "number" + } + } + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPATCH \\\n -H\"Accept: application/vnd.github.echo-preview+json\" \\\n https://developer.github.com/teams//discussions/:discussion_number" + }, + { + "lang": "JS", + "source": "octokit.teams.get({\n team_id: 'team_id',\n discussion_number: 'discussion_number'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/teams/update.json b/openapi/ghe-2.14/operations/teams/update.json new file mode 100644 index 0000000000..35006efa67 --- /dev/null +++ b/openapi/ghe-2.14/operations/teams/update.json @@ -0,0 +1,236 @@ +{ + "summary": "Edit team", + "description": "To edit a team, the authenticated user must either be an owner of the org that the team is associated with, or a maintainer of the team.\n\n**Note:** With nested teams, the `privacy` for parent teams cannot be `secret`.", + "operationId": "teams-update", + "tags": [ + "teams" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/teams/#edit-team" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "team_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "team_id parameter" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "The name of the team.", + "type": "string" + }, + "description": { + "description": "The description of the team.", + "type": "string" + }, + "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.", + "type": "string", + "enum": [ + "secret", + "closed" + ] + }, + "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.", + "type": "string", + "enum": [ + "pull", + "push", + "admin" + ], + "default": "pull" + }, + "parent_team_id": { + "description": "The ID of a team to set as the parent team. **Note**: You must pass the `hellcat-preview` media type to use this parameter.", + "type": "integer" + } + }, + "required": [ + "name" + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string" + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string" + }, + "parent": { + "type": "string" + }, + "members_count": { + "type": "number" + }, + "repos_count": { + "type": "number" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "organization": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "members_url": { + "type": "string" + }, + "public_members_url": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "name": { + "type": "string" + }, + "company": { + "type": "string" + }, + "blog": { + "type": "string" + }, + "location": { + "type": "string" + }, + "email": { + "type": "string" + }, + "has_organization_projects": { + "type": "boolean" + }, + "has_repository_projects": { + "type": "boolean" + }, + "public_repos": { + "type": "number" + }, + "public_gists": { + "type": "number" + }, + "followers": { + "type": "number" + }, + "following": { + "type": "number" + }, + "html_url": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "type": { + "type": "string" + } + } + }, + "ldap_dn": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPATCH \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/teams/ \\\n -d '{\"name\":\"name\"}'" + }, + { + "lang": "JS", + "source": "octokit.teams.get({\n team_id: 'team_id',\n name: 'name'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/users/add-emails.json b/openapi/ghe-2.14/operations/users/add-emails.json new file mode 100644 index 0000000000..278c25c1e4 --- /dev/null +++ b/openapi/ghe-2.14/operations/users/add-emails.json @@ -0,0 +1,49 @@ +{ + "summary": "Add email address(es)", + "description": "If your GitHub Enterprise instance has [LDAP Sync enabled and the option to synchronize emails enabled](https://help.github.com/enterprise/admin/guides/user-management/using-ldap/#enabling-ldap-sync), this API is disabled and will return a `403` response. Users managed in LDAP won't be able to add or delete an email address via the API with these options enabled.\n\nThis endpoint is accessible with the `user` scope.\n\nYou can add a single email address or an array of addresses to your GitHub Enterprise account:", + "operationId": "users-add-emails", + "tags": [ + "users" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/users/emails/#add-email-addresses" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + } + ], + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/user/emails" + }, + { + "lang": "JS", + "source": "octokit.users.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/users/check-following-for-user.json b/openapi/ghe-2.14/operations/users/check-following-for-user.json new file mode 100644 index 0000000000..46e0ba3457 --- /dev/null +++ b/openapi/ghe-2.14/operations/users/check-following-for-user.json @@ -0,0 +1,62 @@ +{ + "summary": "Check if one user follows another", + "description": "", + "operationId": "users-check-following-for-user", + "tags": [ + "users" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/users/followers/#check-if-one-user-follows-another" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + }, + { + "name": "target_user", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "target_user parameter" + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/users//following/:target_user" + }, + { + "lang": "JS", + "source": "octokit.users.get({\n username: 'username',\n target_user: 'target_user'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/users/check-following.json b/openapi/ghe-2.14/operations/users/check-following.json new file mode 100644 index 0000000000..e1155d3333 --- /dev/null +++ b/openapi/ghe-2.14/operations/users/check-following.json @@ -0,0 +1,53 @@ +{ + "summary": "Check if you are following a user", + "description": "", + "operationId": "users-check-following", + "tags": [ + "users" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/users/followers/#check-if-you-are-following-a-user" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/user/following/" + }, + { + "lang": "JS", + "source": "octokit.users.get({\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/users/create-gpg-key.json b/openapi/ghe-2.14/operations/users/create-gpg-key.json new file mode 100644 index 0000000000..4aeb55701b --- /dev/null +++ b/openapi/ghe-2.14/operations/users/create-gpg-key.json @@ -0,0 +1,157 @@ +{ + "summary": "Create a GPG key", + "description": "Adds a GPG key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:gpg_key` [scope](https://developer.github.com/enterprise/2.14/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "operationId": "users-create-gpg-key", + "tags": [ + "users" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/users/gpg_keys/#create-a-gpg-key" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "armored_public_key": { + "description": "Your GPG key, generated in ASCII-armored format. See \"[Generating a new GPG key](https://help.github.com/articles/generating-a-new-gpg-key/)\" for help creating a GPG key.", + "type": "string" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "primary_key_id": { + "type": "string" + }, + "key_id": { + "type": "string" + }, + "public_key": { + "type": "string" + }, + "emails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "email": { + "type": "string" + }, + "verified": { + "type": "boolean" + } + } + } + }, + "subkeys": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "primary_key_id": { + "type": "number" + }, + "key_id": { + "type": "string" + }, + "public_key": { + "type": "string" + }, + "emails": { + "type": "array", + "items": {} + }, + "subkeys": { + "type": "array", + "items": {} + }, + "can_sign": { + "type": "boolean" + }, + "can_encrypt_comms": { + "type": "boolean" + }, + "can_encrypt_storage": { + "type": "boolean" + }, + "can_certify": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "expires_at": { + "type": "string" + } + } + } + }, + "can_sign": { + "type": "boolean" + }, + "can_encrypt_comms": { + "type": "boolean" + }, + "can_encrypt_storage": { + "type": "boolean" + }, + "can_certify": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "expires_at": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/user/gpg_keys" + }, + { + "lang": "JS", + "source": "octokit.users.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/users/create-public-key.json b/openapi/ghe-2.14/operations/users/create-public-key.json new file mode 100644 index 0000000000..60e494ec2d --- /dev/null +++ b/openapi/ghe-2.14/operations/users/create-public-key.json @@ -0,0 +1,92 @@ +{ + "summary": "Create a public key", + "description": "Adds a public SSH key to the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth, or OAuth with at least `write:public_key` [scope](https://developer.github.com/enterprise/2.14/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nIf your GitHub Enterprise appliance has [LDAP Sync enabled](https://help.github.com/enterprise/admin/guides/user-management/using-ldap) and the option to synchronize SSH keys enabled, this API is disabled and will return a `403` response. Users managed in LDAP won't be able to add an SSH key address via the API with these options enabled.", + "operationId": "users-create-public-key", + "tags": [ + "users" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/users/keys/#create-a-public-key" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "description": "A descriptive name for the new key. Use a name that will help you recognize this key in your GitHub account. For example, if you're using a personal Mac, you might call this key \"Personal MacBook Air\".", + "type": "string" + }, + "key": { + "description": "The public SSH key to add to your GitHub account. See \"[Generating a new SSH key](https://help.github.com/articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/)\" for guidance on how to create a public SSH key.", + "type": "string" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "key": { + "type": "string" + }, + "url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "verified": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "read_only": { + "type": "boolean" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPOST \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/user/keys" + }, + { + "lang": "JS", + "source": "octokit.users.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/users/delete-emails.json b/openapi/ghe-2.14/operations/users/delete-emails.json new file mode 100644 index 0000000000..34f7e05b05 --- /dev/null +++ b/openapi/ghe-2.14/operations/users/delete-emails.json @@ -0,0 +1,44 @@ +{ + "summary": "Delete email address(es)", + "description": "If your GitHub Enterprise instance has [LDAP Sync enabled and the option to synchronize emails enabled](https://help.github.com/enterprise/admin/guides/user-management/using-ldap/#enabling-ldap-sync), this API is disabled and will return a `403` response. Users managed in LDAP won't be able to add or delete an email address via the API with these options enabled.\n\nThis endpoint is accessible with the `user` scope.\n\nYou can delete a single email address or an array of addresses from your GitHub Enterprise account:", + "operationId": "users-delete-emails", + "tags": [ + "users" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/users/emails/#delete-email-addresses" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/user/emails" + }, + { + "lang": "JS", + "source": "octokit.users.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/users/delete-gpg-key.json b/openapi/ghe-2.14/operations/users/delete-gpg-key.json new file mode 100644 index 0000000000..86a980f0da --- /dev/null +++ b/openapi/ghe-2.14/operations/users/delete-gpg-key.json @@ -0,0 +1,53 @@ +{ + "summary": "Delete a GPG key", + "description": "Removes a GPG key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:gpg_key` [scope](https://developer.github.com/enterprise/2.14/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "operationId": "users-delete-gpg-key", + "tags": [ + "users" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/users/gpg_keys/#delete-a-gpg-key" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "gpg_key_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "gpg_key_id parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/user/gpg_keys/" + }, + { + "lang": "JS", + "source": "octokit.users.get({\n gpg_key_id: 'gpg_key_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/users/delete-public-key.json b/openapi/ghe-2.14/operations/users/delete-public-key.json new file mode 100644 index 0000000000..b27a2474b4 --- /dev/null +++ b/openapi/ghe-2.14/operations/users/delete-public-key.json @@ -0,0 +1,53 @@ +{ + "summary": "Delete a public key", + "description": "Removes a public SSH key from the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `admin:public_key` [scope](https://developer.github.com/enterprise/2.14/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\nIf your GitHub Enterprise appliance has [LDAP Sync enabled](https://help.github.com/enterprise/admin/guides/user-management/using-ldap) and the option to synchronize SSH keys enabled, this API is disabled and will return a `403` response. Users managed in LDAP won't be able to remove an SSH key address via the API with these options enabled.", + "operationId": "users-delete-public-key", + "tags": [ + "users" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/users/keys/#delete-a-public-key" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "key_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "key_id parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/user/keys/" + }, + { + "lang": "JS", + "source": "octokit.users.get({\n key_id: 'key_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/users/follow.json b/openapi/ghe-2.14/operations/users/follow.json new file mode 100644 index 0000000000..ba703a81b6 --- /dev/null +++ b/openapi/ghe-2.14/operations/users/follow.json @@ -0,0 +1,53 @@ +{ + "summary": "Follow a user", + "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/enterprise/2.14/v3/#http-verbs).\"\n\nFollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope.", + "operationId": "users-follow", + "tags": [ + "users" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/users/followers/#follow-a-user" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPUT \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/user/following/" + }, + { + "lang": "JS", + "source": "octokit.users.get({\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/users/get-authenticated.json b/openapi/ghe-2.14/operations/users/get-authenticated.json new file mode 100644 index 0000000000..f9642e3b8e --- /dev/null +++ b/openapi/ghe-2.14/operations/users/get-authenticated.json @@ -0,0 +1,44 @@ +{ + "summary": "Get the authenticated user", + "description": "Lists public and private profile information when authenticated through basic auth or OAuth with the `user` scope.\n\nLists public profile information when authenticated through OAuth without the `user` scope.", + "operationId": "users-get-authenticated", + "tags": [ + "users" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/users/#get-the-authenticated-user" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/user" + }, + { + "lang": "JS", + "source": "octokit.users.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/users/get-by-username.json b/openapi/ghe-2.14/operations/users/get-by-username.json new file mode 100644 index 0000000000..eef89bccd4 --- /dev/null +++ b/openapi/ghe-2.14/operations/users/get-by-username.json @@ -0,0 +1,154 @@ +{ + "summary": "Get a single user", + "description": "Provides publicly available information about someone with a GitHub Enterprise account.\n\nThe `email` key in the following response is the publicly visible email address from your GitHub Enterprise [profile page](https://github.com/settings/profile). When setting up your profile, you can select a primary email address to be “public” which provides an email entry for this endpoint. If you do not set a public email address for `email`, then it will have a value of `null`. You only see publicly visible email addresses when authenticated with GitHub Enterprise. For more information, see [Authentication](https://developer.github.com/enterprise/2.14/v3/#authentication).\n\nThe Emails API enables you to list all of your email addresses, and toggle a primary email to be visible publicly. For more information, see \"[Emails API](https://developer.github.com/enterprise/2.14/v3/users/emails/)\".", + "operationId": "users-get-by-username", + "tags": [ + "users" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/users/#get-a-single-user" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "company": { + "type": "string" + }, + "blog": { + "type": "string" + }, + "location": { + "type": "string" + }, + "email": { + "type": "string" + }, + "hireable": { + "type": "boolean" + }, + "bio": { + "type": "string" + }, + "public_repos": { + "type": "number" + }, + "public_gists": { + "type": "number" + }, + "followers": { + "type": "number" + }, + "following": { + "type": "number" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/users/" + }, + { + "lang": "JS", + "source": "octokit.users.get({\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/users/get-context-for-user.json b/openapi/ghe-2.14/operations/users/get-context-for-user.json new file mode 100644 index 0000000000..308431f11a --- /dev/null +++ b/openapi/ghe-2.14/operations/users/get-context-for-user.json @@ -0,0 +1,78 @@ +{ + "summary": "Get contextual information about a user", + "description": "Provides hovercard information when authenticated through basic auth or OAuth with the `repo` scope. You can find out more about someone in relation to their pull requests, issues, repositories, and organizations.\n\nThe `subject_type` and `subject_id` parameters provide context for the person's hovercard, which returns more information than without the parameters. For example, if you wanted to find out more about `octocat` who owns the `Spoon-Knife` repository via cURL, it would look like this:", + "operationId": "users-get-context-for-user", + "tags": [ + "users" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/users/#get-contextual-information-about-a-user" + }, + "parameters": [ + { + "name": "accept", + "description": "This API is under preview and subject to change.", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.hagar-preview+json" + }, + "required": true + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + }, + { + "name": "subject_type", + "in": "query", + "schema": { + "type": "string", + "enum": [ + "organization", + "repository", + "issue", + "pull_request" + ] + }, + "required": false, + "description": "Identifies which additional information you'd like to receive about the person's hovercard. Can be `organization`, `repository`, `issue`, `pull_request`. **Required** when using `subject_id`." + }, + { + "name": "subject_id", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "description": "Uses the ID for the `subject_type` you specified. **Required** when using `subject_type`." + } + ], + "responses": { + "418": { + "description": "Response definition missing" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.hagar-preview+json\" \\\n https://developer.github.com/users//hovercard" + }, + { + "lang": "JS", + "source": "octokit.users.get({\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/users/get-gpg-key.json b/openapi/ghe-2.14/operations/users/get-gpg-key.json new file mode 100644 index 0000000000..cdfe1c89f3 --- /dev/null +++ b/openapi/ghe-2.14/operations/users/get-gpg-key.json @@ -0,0 +1,151 @@ +{ + "summary": "Get a single GPG key", + "description": "View extended details for a single GPG key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://developer.github.com/enterprise/2.14/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "operationId": "users-get-gpg-key", + "tags": [ + "users" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/users/gpg_keys/#get-a-single-gpg-key" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "gpg_key_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "gpg_key_id parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "primary_key_id": { + "type": "string" + }, + "key_id": { + "type": "string" + }, + "public_key": { + "type": "string" + }, + "emails": { + "type": "array", + "items": { + "type": "object", + "properties": { + "email": { + "type": "string" + }, + "verified": { + "type": "boolean" + } + } + } + }, + "subkeys": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "primary_key_id": { + "type": "number" + }, + "key_id": { + "type": "string" + }, + "public_key": { + "type": "string" + }, + "emails": { + "type": "array", + "items": {} + }, + "subkeys": { + "type": "array", + "items": {} + }, + "can_sign": { + "type": "boolean" + }, + "can_encrypt_comms": { + "type": "boolean" + }, + "can_encrypt_storage": { + "type": "boolean" + }, + "can_certify": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "expires_at": { + "type": "string" + } + } + } + }, + "can_sign": { + "type": "boolean" + }, + "can_encrypt_comms": { + "type": "boolean" + }, + "can_encrypt_storage": { + "type": "boolean" + }, + "can_certify": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "expires_at": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/user/gpg_keys/" + }, + { + "lang": "JS", + "source": "octokit.users.get({\n gpg_key_id: 'gpg_key_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/users/get-public-key.json b/openapi/ghe-2.14/operations/users/get-public-key.json new file mode 100644 index 0000000000..843eeb406d --- /dev/null +++ b/openapi/ghe-2.14/operations/users/get-public-key.json @@ -0,0 +1,82 @@ +{ + "summary": "Get a single public key", + "description": "View extended details for a single public SSH key. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://developer.github.com/enterprise/2.14/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "operationId": "users-get-public-key", + "tags": [ + "users" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/users/keys/#get-a-single-public-key" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "key_id", + "in": "path", + "schema": { + "type": "integer" + }, + "required": true, + "description": "key_id parameter" + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "id": { + "type": "number" + }, + "key": { + "type": "string" + }, + "url": { + "type": "string" + }, + "title": { + "type": "string" + }, + "verified": { + "type": "boolean" + }, + "created_at": { + "type": "string" + }, + "read_only": { + "type": "boolean" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/user/keys/" + }, + { + "lang": "JS", + "source": "octokit.users.get({\n key_id: 'key_id'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/users/list-emails.json b/openapi/ghe-2.14/operations/users/list-emails.json new file mode 100644 index 0000000000..27d466e246 --- /dev/null +++ b/openapi/ghe-2.14/operations/users/list-emails.json @@ -0,0 +1,69 @@ +{ + "summary": "List email addresses for a user", + "description": "Lists all of your email addresses, and specifies which one is visible to the public. This endpoint is accessible with the `user:email` scope.", + "operationId": "users-list-emails", + "tags": [ + "users" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/users/emails/#list-email-addresses-for-a-user" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/user/emails" + }, + { + "lang": "JS", + "source": "octokit.users.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/users/list-followers-for-authenticated-user.json b/openapi/ghe-2.14/operations/users/list-followers-for-authenticated-user.json new file mode 100644 index 0000000000..0240466d54 --- /dev/null +++ b/openapi/ghe-2.14/operations/users/list-followers-for-authenticated-user.json @@ -0,0 +1,69 @@ +{ + "summary": "List the authenticated user's followers", + "description": "", + "operationId": "users-list-followers-for-authenticated-user", + "tags": [ + "users" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/users/followers/#list-followers-of-a-user" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/user/followers" + }, + { + "lang": "JS", + "source": "octokit.users.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/users/list-followers-for-user.json b/openapi/ghe-2.14/operations/users/list-followers-for-user.json new file mode 100644 index 0000000000..294680bfd8 --- /dev/null +++ b/openapi/ghe-2.14/operations/users/list-followers-for-user.json @@ -0,0 +1,78 @@ +{ + "summary": "List a user's followers", + "description": "", + "operationId": "users-list-followers-for-user", + "tags": [ + "users" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/users/followers/#list-followers-of-a-user" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/users//followers" + }, + { + "lang": "JS", + "source": "octokit.users.get({\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/users/list-following-for-authenticated-user.json b/openapi/ghe-2.14/operations/users/list-following-for-authenticated-user.json new file mode 100644 index 0000000000..3dabf188dd --- /dev/null +++ b/openapi/ghe-2.14/operations/users/list-following-for-authenticated-user.json @@ -0,0 +1,69 @@ +{ + "summary": "List who the authenticated user is following", + "description": "", + "operationId": "users-list-following-for-authenticated-user", + "tags": [ + "users" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/users/followers/#list-users-followed-by-another-user" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/user/following" + }, + { + "lang": "JS", + "source": "octokit.users.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/users/list-following-for-user.json b/openapi/ghe-2.14/operations/users/list-following-for-user.json new file mode 100644 index 0000000000..72a1072eed --- /dev/null +++ b/openapi/ghe-2.14/operations/users/list-following-for-user.json @@ -0,0 +1,78 @@ +{ + "summary": "List who a user is following", + "description": "", + "operationId": "users-list-following-for-user", + "tags": [ + "users" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/users/followers/#list-users-followed-by-another-user" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/users//following" + }, + { + "lang": "JS", + "source": "octokit.users.get({\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/users/list-gpg-keys-for-user.json b/openapi/ghe-2.14/operations/users/list-gpg-keys-for-user.json new file mode 100644 index 0000000000..aa0026ab9f --- /dev/null +++ b/openapi/ghe-2.14/operations/users/list-gpg-keys-for-user.json @@ -0,0 +1,78 @@ +{ + "summary": "List GPG keys for a user", + "description": "Lists the GPG keys for a user. This information is accessible by anyone.", + "operationId": "users-list-gpg-keys-for-user", + "tags": [ + "users" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/users/gpg_keys/#list-gpg-keys-for-a-user" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/users//gpg_keys" + }, + { + "lang": "JS", + "source": "octokit.users.get({\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/users/list-gpg-keys.json b/openapi/ghe-2.14/operations/users/list-gpg-keys.json new file mode 100644 index 0000000000..4293bed980 --- /dev/null +++ b/openapi/ghe-2.14/operations/users/list-gpg-keys.json @@ -0,0 +1,69 @@ +{ + "summary": "List your GPG keys", + "description": "Lists the current user's GPG keys. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:gpg_key` [scope](https://developer.github.com/enterprise/2.14/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "operationId": "users-list-gpg-keys", + "tags": [ + "users" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/users/gpg_keys/#list-your-gpg-keys" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/user/gpg_keys" + }, + { + "lang": "JS", + "source": "octokit.users.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/users/list-public-emails.json b/openapi/ghe-2.14/operations/users/list-public-emails.json new file mode 100644 index 0000000000..da126b6852 --- /dev/null +++ b/openapi/ghe-2.14/operations/users/list-public-emails.json @@ -0,0 +1,69 @@ +{ + "summary": "List public email addresses for a user", + "description": "Lists your publicly visible email address. This endpoint is accessible with the `user:email` scope.", + "operationId": "users-list-public-emails", + "tags": [ + "users" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/users/emails/#list-public-email-addresses-for-a-user" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/user/public_emails" + }, + { + "lang": "JS", + "source": "octokit.users.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/users/list-public-keys-for-user.json b/openapi/ghe-2.14/operations/users/list-public-keys-for-user.json new file mode 100644 index 0000000000..373bab0765 --- /dev/null +++ b/openapi/ghe-2.14/operations/users/list-public-keys-for-user.json @@ -0,0 +1,78 @@ +{ + "summary": "List public keys for a user", + "description": "Lists the _verified_ public SSH keys for a user. This is accessible by anyone.", + "operationId": "users-list-public-keys-for-user", + "tags": [ + "users" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/users/keys/#list-public-keys-for-a-user" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/users//keys" + }, + { + "lang": "JS", + "source": "octokit.users.get({\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/users/list-public-keys.json b/openapi/ghe-2.14/operations/users/list-public-keys.json new file mode 100644 index 0000000000..14d3b7e5c6 --- /dev/null +++ b/openapi/ghe-2.14/operations/users/list-public-keys.json @@ -0,0 +1,69 @@ +{ + "summary": "List your public keys", + "description": "Lists the public SSH keys for the authenticated user's GitHub account. Requires that you are authenticated via Basic Auth or via OAuth with at least `read:public_key` [scope](https://developer.github.com/enterprise/2.14/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "operationId": "users-list-public-keys", + "tags": [ + "users" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/users/keys/#list-your-public-keys" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/user/keys" + }, + { + "lang": "JS", + "source": "octokit.users.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/users/list.json b/openapi/ghe-2.14/operations/users/list.json new file mode 100644 index 0000000000..0f4253eaa9 --- /dev/null +++ b/openapi/ghe-2.14/operations/users/list.json @@ -0,0 +1,78 @@ +{ + "summary": "Get all users", + "description": "Lists all users, in the order that they signed up on GitHub Enterprise. This list includes personal user accounts and organization accounts.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://developer.github.com/enterprise/2.14/v3/#link-header) to get the URL for the next page of users.", + "operationId": "users-list", + "tags": [ + "users" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/users/#get-all-users" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "since", + "in": "query", + "schema": { + "type": "string" + }, + "required": false, + "description": "The integer ID of the last User that you've seen." + }, + { + "name": "per_page", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "required": false, + "description": "Results per page (max 100)" + }, + { + "name": "page", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "required": false, + "description": "Page number of the results to fetch." + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": {} + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/users" + }, + { + "lang": "JS", + "source": "octokit.users.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": true, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/users/unfollow.json b/openapi/ghe-2.14/operations/users/unfollow.json new file mode 100644 index 0000000000..44ec3b85c1 --- /dev/null +++ b/openapi/ghe-2.14/operations/users/unfollow.json @@ -0,0 +1,53 @@ +{ + "summary": "Unfollow a user", + "description": "Unfollowing a user requires the user to be logged in and authenticated with basic auth or OAuth with the `user:follow` scope.", + "operationId": "users-unfollow", + "tags": [ + "users" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/users/followers/#unfollow-a-user" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + }, + { + "name": "username", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "description": "username parameter" + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XDELETE \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/user/following/" + }, + { + "lang": "JS", + "source": "octokit.users.get({\n username: 'username'\n})" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/openapi/ghe-2.14/operations/users/update-authenticated.json b/openapi/ghe-2.14/operations/users/update-authenticated.json new file mode 100644 index 0000000000..746e9fa1ef --- /dev/null +++ b/openapi/ghe-2.14/operations/users/update-authenticated.json @@ -0,0 +1,222 @@ +{ + "summary": "Update the authenticated user", + "description": "**Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API.", + "operationId": "users-update-authenticated", + "tags": [ + "users" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://developer.github.com/enterprise/2.14/v3/users/#update-the-authenticated-user" + }, + "parameters": [ + { + "name": "accept", + "description": "Setting to `application/vnd.github.v3+json` is recommended", + "in": "header", + "schema": { + "type": "string", + "default": "application/vnd.github.v3+json" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "The new name of the user.", + "type": "string" + }, + "email": { + "description": "The publicly visible email address of the user.", + "type": "string" + }, + "blog": { + "description": "The new blog URL of the user.", + "type": "string" + }, + "company": { + "description": "The new company of the user.", + "type": "string" + }, + "location": { + "description": "The new location of the user.", + "type": "string" + }, + "hireable": { + "description": "The new hiring availability of the user.", + "type": "boolean" + }, + "bio": { + "description": "The new short biography of the user.", + "type": "string" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "number" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + }, + "name": { + "type": "string" + }, + "company": { + "type": "string" + }, + "blog": { + "type": "string" + }, + "location": { + "type": "string" + }, + "email": { + "type": "string" + }, + "hireable": { + "type": "boolean" + }, + "bio": { + "type": "string" + }, + "public_repos": { + "type": "number" + }, + "public_gists": { + "type": "number" + }, + "followers": { + "type": "number" + }, + "following": { + "type": "number" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "private_gists": { + "type": "number" + }, + "total_private_repos": { + "type": "number" + }, + "owned_private_repos": { + "type": "number" + }, + "disk_usage": { + "type": "number" + }, + "collaborators": { + "type": "number" + }, + "two_factor_authentication": { + "type": "boolean" + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "number" + }, + "private_repos": { + "type": "number" + }, + "collaborators": { + "type": "number" + } + } + }, + "suspended_at": { + "type": "string" + } + } + } + } + } + } + }, + "x-code-samples": [ + { + "lang": "Shell", + "source": "curl \\\n -XPATCH \\\n -H\"Accept: application/vnd.github.v3+json\" \\\n https://developer.github.com/user" + }, + { + "lang": "JS", + "source": "octokit.users.get()" + } + ], + "x-github": { + "legacy": false, + "enabledForApps": false, + "githubCloudOnly": false + }, + "x-changes": [] +} diff --git a/routes/ghe-2.14/activity.json b/routes/ghe-2.14/activity.json index ddfb5beda7..bffc9f754d 100644 --- a/routes/ghe-2.14/activity.json +++ b/routes/ghe-2.14/activity.json @@ -714,8 +714,7 @@ { "name": "last_read_at", "type": "string", - "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": "", + "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: current date/time", "required": false, "location": "body" } @@ -756,8 +755,7 @@ { "name": "last_read_at", "type": "string", - "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": "", + "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: current date/time", "required": false, "location": "body" } diff --git a/routes/ghe-2.14/activity/mark-as-read.json b/routes/ghe-2.14/activity/mark-as-read.json index a596a4b239..0f615aba4c 100644 --- a/routes/ghe-2.14/activity/mark-as-read.json +++ b/routes/ghe-2.14/activity/mark-as-read.json @@ -8,8 +8,7 @@ { "name": "last_read_at", "type": "string", - "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": "", + "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: current date/time", "required": false, "location": "body" } diff --git a/routes/ghe-2.14/activity/mark-notifications-as-read-for-repo.json b/routes/ghe-2.14/activity/mark-notifications-as-read-for-repo.json index 4cec8daaa3..4ca884ab8d 100644 --- a/routes/ghe-2.14/activity/mark-notifications-as-read-for-repo.json +++ b/routes/ghe-2.14/activity/mark-notifications-as-read-for-repo.json @@ -22,8 +22,7 @@ { "name": "last_read_at", "type": "string", - "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": "", + "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: current date/time", "required": false, "location": "body" } diff --git a/routes/ghe-2.14/checks.json b/routes/ghe-2.14/checks.json index 48e1ae4528..e8ff0bd459 100644 --- a/routes/ghe-2.14/checks.json +++ b/routes/ghe-2.14/checks.json @@ -223,7 +223,7 @@ { "name": "actions", "type": "object[]", - "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/enterprise/2.14/v3/checks/runs/#actions-object) description.", + "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/enterprise/2.14/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/enterprise/2.14/v3/checks/runs/#actions-object) description.", "required": false, "location": "body" }, diff --git a/routes/ghe-2.14/checks/create.json b/routes/ghe-2.14/checks/create.json index aa9909a225..6f455fca92 100644 --- a/routes/ghe-2.14/checks/create.json +++ b/routes/ghe-2.14/checks/create.json @@ -222,7 +222,7 @@ { "name": "actions", "type": "object[]", - "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/enterprise/2.14/v3/checks/runs/#actions-object) description.", + "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/enterprise/2.14/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/enterprise/2.14/v3/checks/runs/#actions-object) description.", "required": false, "location": "body" }, diff --git a/routes/ghe-2.14/enterprise-admin.json b/routes/ghe-2.14/enterprise-admin.json index 29a88dfb93..9e79c6f6e1 100644 --- a/routes/ghe-2.14/enterprise-admin.json +++ b/routes/ghe-2.14/enterprise-admin.json @@ -257,8 +257,7 @@ { "name": "events", "type": "string[]", - "description": "The [events](https://developer.github.com/enterprise/2.14/v3/activity/events/types/) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events.", - "default": "`user` and `organization`", + "description": "The [events](https://developer.github.com/enterprise/2.14/v3/activity/events/types/) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", "required": false, "location": "body" }, @@ -375,8 +374,7 @@ { "name": "events", "type": "string[]", - "description": "The [events](https://developer.github.com/enterprise/2.14/v3/activity/events/types/) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events.", - "default": "`user` and `organization`", + "description": "The [events](https://developer.github.com/enterprise/2.14/v3/activity/events/types/) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", "required": false, "location": "body" }, diff --git a/routes/ghe-2.14/enterprise-admin/create-global-hook.json b/routes/ghe-2.14/enterprise-admin/create-global-hook.json index fa72a9c129..72f30503e7 100644 --- a/routes/ghe-2.14/enterprise-admin/create-global-hook.json +++ b/routes/ghe-2.14/enterprise-admin/create-global-hook.json @@ -56,8 +56,7 @@ { "name": "events", "type": "string[]", - "description": "The [events](https://developer.github.com/enterprise/2.14/v3/activity/events/types/) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events.", - "default": "`user` and `organization`", + "description": "The [events](https://developer.github.com/enterprise/2.14/v3/activity/events/types/) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", "required": false, "location": "body" }, diff --git a/routes/ghe-2.14/enterprise-admin/update-global-hook.json b/routes/ghe-2.14/enterprise-admin/update-global-hook.json index 8588159d7c..ccac448419 100644 --- a/routes/ghe-2.14/enterprise-admin/update-global-hook.json +++ b/routes/ghe-2.14/enterprise-admin/update-global-hook.json @@ -56,8 +56,7 @@ { "name": "events", "type": "string[]", - "description": "The [events](https://developer.github.com/enterprise/2.14/v3/activity/events/types/) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events.", - "default": "`user` and `organization`", + "description": "The [events](https://developer.github.com/enterprise/2.14/v3/activity/events/types/) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", "required": false, "location": "body" }, diff --git a/routes/ghe-2.14/git.json b/routes/ghe-2.14/git.json index 9fa8e9ad21..f08fcf3ea2 100644 --- a/routes/ghe-2.14/git.json +++ b/routes/ghe-2.14/git.json @@ -79,7 +79,7 @@ "name": "encoding", "type": "string", "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", - "default": "\"utf-8\"", + "default": "utf-8", "required": false, "location": "body" } diff --git a/routes/ghe-2.14/git/create-blob.json b/routes/ghe-2.14/git/create-blob.json index e9087f36da..947ff194d8 100644 --- a/routes/ghe-2.14/git/create-blob.json +++ b/routes/ghe-2.14/git/create-blob.json @@ -30,7 +30,7 @@ "name": "encoding", "type": "string", "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", - "default": "\"utf-8\"", + "default": "utf-8", "required": false, "location": "body" } diff --git a/routes/ghe-2.14/index.json b/routes/ghe-2.14/index.json index f6035c97df..81e49f6ed4 100644 --- a/routes/ghe-2.14/index.json +++ b/routes/ghe-2.14/index.json @@ -715,8 +715,7 @@ { "name": "last_read_at", "type": "string", - "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": "", + "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: current date/time", "required": false, "location": "body" } @@ -757,8 +756,7 @@ { "name": "last_read_at", "type": "string", - "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": "", + "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: current date/time", "required": false, "location": "body" } @@ -3639,7 +3637,7 @@ { "name": "actions", "type": "object[]", - "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/enterprise/2.14/v3/checks/runs/#actions-object) description.", + "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/enterprise/2.14/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/enterprise/2.14/v3/checks/runs/#actions-object) description.", "required": false, "location": "body" }, @@ -5927,8 +5925,7 @@ { "name": "events", "type": "string[]", - "description": "The [events](https://developer.github.com/enterprise/2.14/v3/activity/events/types/) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events.", - "default": "`user` and `organization`", + "description": "The [events](https://developer.github.com/enterprise/2.14/v3/activity/events/types/) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", "required": false, "location": "body" }, @@ -6045,8 +6042,7 @@ { "name": "events", "type": "string[]", - "description": "The [events](https://developer.github.com/enterprise/2.14/v3/activity/events/types/) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events.", - "default": "`user` and `organization`", + "description": "The [events](https://developer.github.com/enterprise/2.14/v3/activity/events/types/) that trigger this webhook. A global webhook can be triggered by `user` and `organization` events. Default: `user` and `organization`.", "required": false, "location": "body" }, @@ -10021,7 +10017,7 @@ "name": "encoding", "type": "string", "description": "The encoding used for `content`. Currently, `\"utf-8\"` and `\"base64\"` are supported.", - "default": "\"utf-8\"", + "default": "utf-8", "required": false, "location": "body" } @@ -18181,7 +18177,9 @@ "name": "events", "type": "string[]", "description": "Determines what [events](https://developer.github.com/enterprise/2.14/v3/activity/events/types/) the hook is triggered for.", - "default": "[\"push\"]", + "default": [ + "push" + ], "required": false, "location": "body" }, @@ -18297,7 +18295,9 @@ "name": "events", "type": "string[]", "description": "Determines what [events](https://developer.github.com/enterprise/2.14/v3/activity/events/types/) the hook is triggered for.", - "default": "[\"push\"]", + "default": [ + "push" + ], "required": false, "location": "body" }, @@ -20802,8 +20802,7 @@ { "name": "direction", "type": "string", - "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`", + "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`.", "required": false, "enum": [ "asc", @@ -27952,8 +27951,7 @@ { "name": "direction", "type": "string", - "description": "Can be one of `asc` or `desc`.", - "default": "`asc` when using `full_name`, otherwise `desc`", + "description": "Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc`", "required": false, "enum": [ "asc", @@ -28026,8 +28024,7 @@ { "name": "direction", "type": "string", - "description": "Can be one of `asc` or `desc`.", - "default": "`asc` when using `full_name`, otherwise `desc`", + "description": "Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc`", "required": false, "enum": [ "asc", @@ -33200,8 +33197,7 @@ { "name": "sha", "type": "string", - "description": "SHA or branch to start listing commits from.", - "default": "the repository’s default branch (usually `master`).", + "description": "SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`).", "required": false, "location": "query" }, @@ -33512,50 +33508,6 @@ "idName": "get-commit", "documentationUrl": "https://developer.github.com/enterprise/2.14/v3/repos/commits/#get-a-single-commit" }, - { - "name": "Get the SHA-1 of a commit reference", - "enabledForApps": true, - "method": "GET", - "path": "/repos/:owner/:repo/commits/:ref", - "previews": [], - "params": [ - { - "name": "owner", - "type": "string", - "required": true, - "description": "", - "location": "url" - }, - { - "name": "repo", - "type": "string", - "required": true, - "description": "", - "location": "url" - }, - { - "name": "ref", - "type": "string", - "required": true, - "description": "", - "location": "url" - } - ], - "description": "**Note:** To access this endpoint, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header:\n\n```\napplication/vnd.github.VERSION.sha\n\n```\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.\n\n", - "responses": [ - { - "headers": { - "status": "200 OK" - } - } - ], - "idName": "get-commit-ref-sha", - "documentationUrl": "https://developer.github.com/enterprise/2.14/v3/repos/commits/#get-a-single-commit", - "deprecated": { - "date": "2019-05-22", - "message": "\"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." - } - }, { "name": "Compare two commits", "enabledForApps": true, @@ -33884,8 +33836,7 @@ { "name": "ref", "type": "string", - "description": "The name of the commit/branch/tag.", - "default": "the repository’s default branch (usually `master`)", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", "required": false, "location": "query" } @@ -33951,8 +33902,7 @@ { "name": "ref", "type": "string", - "description": "The name of the commit/branch/tag.", - "default": "the repository’s default branch (usually `master`)", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", "required": false, "location": "query" } @@ -34013,16 +33963,14 @@ { "name": "branch", "type": "string", - "description": "The branch name.", - "default": "the repository’s default branch (usually `master`)", + "description": "The branch name. Default: the repository’s default branch (usually `master`)", "required": false, "location": "body" }, { "name": "committer", "type": "object", - "description": "The person that committed the file.", - "default": "the authenticated user.", + "description": "The person that committed the file. Default: the authenticated user.", "required": false, "location": "body" }, @@ -34043,8 +33991,7 @@ { "name": "author", "type": "object", - "description": "The author of the file.", - "default": "The `committer` or the authenticated user if you omit `committer`.", + "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", "required": false, "location": "body" }, @@ -34189,16 +34136,14 @@ { "name": "branch", "type": "string", - "description": "The branch name.", - "default": "the repository’s default branch (usually `master`)", + "description": "The branch name. Default: the repository’s default branch (usually `master`)", "required": false, "location": "body" }, { "name": "committer", "type": "object", - "description": "The person that committed the file.", - "default": "the authenticated user.", + "description": "The person that committed the file. Default: the authenticated user.", "required": false, "location": "body" }, @@ -34219,8 +34164,7 @@ { "name": "author", "type": "object", - "description": "The author of the file.", - "default": "The `committer` or the authenticated user if you omit `committer`.", + "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", "required": false, "location": "body" }, @@ -34375,16 +34319,14 @@ { "name": "branch", "type": "string", - "description": "The branch name.", - "default": "the repository’s default branch (usually `master`)", + "description": "The branch name. Default: the repository’s default branch (usually `master`)", "required": false, "location": "body" }, { "name": "committer", "type": "object", - "description": "The person that committed the file.", - "default": "the authenticated user.", + "description": "The person that committed the file. Default: the authenticated user.", "required": false, "location": "body" }, @@ -34405,8 +34347,7 @@ { "name": "author", "type": "object", - "description": "The author of the file.", - "default": "The `committer` or the authenticated user if you omit `committer`.", + "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", "required": false, "location": "body" }, @@ -34554,8 +34495,7 @@ { "name": "branch", "type": "string", - "description": "The branch name.", - "default": "the repository’s default branch (usually `master`)", + "description": "The branch name. Default: the repository’s default branch (usually `master`)", "required": false, "location": "body" }, @@ -34983,7 +34923,7 @@ "name": "payload", "type": "string", "description": "JSON payload with extra information about the deployment.", - "default": "\"\"", + "default": "", "required": false, "location": "body" }, @@ -34999,7 +34939,7 @@ "name": "description", "type": "string", "description": "Short description of the deployment.", - "default": "\"\"", + "default": "", "required": false, "location": "body" }, @@ -35014,8 +34954,7 @@ { "name": "production_environment", "type": "boolean", - "description": "Specifies if the given environment is one that end-users directly interact with.", - "default": "`true` when `environment` is `production` and `false` otherwise", + "description": "Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise.", "required": false, "location": "body" } @@ -35272,7 +35211,7 @@ "name": "target_url", "type": "string", "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`.", - "default": "\"\"", + "default": "", "required": false, "location": "body" }, @@ -35280,7 +35219,7 @@ "name": "log_url", "type": "string", "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": "\"\"", + "default": "", "required": false, "location": "body" }, @@ -35288,7 +35227,7 @@ "name": "description", "type": "string", "description": "A short description of the status. The maximum description length is 140 characters.", - "default": "\"\"", + "default": "", "required": false, "location": "body" }, @@ -35296,7 +35235,7 @@ "name": "environment_url", "type": "string", "description": "Sets the URL for accessing your environment.", - "default": "\"\"", + "default": "", "required": false, "location": "body" }, @@ -36049,7 +35988,9 @@ "name": "events", "type": "string[]", "description": "Determines what [events](https://developer.github.com/enterprise/2.14/v3/activity/events/types/) the hook is triggered for.", - "default": "[\"push\"]", + "default": [ + "push" + ], "required": false, "location": "body" }, @@ -36181,7 +36122,9 @@ "name": "events", "type": "string[]", "description": "Determines what [events](https://developer.github.com/enterprise/2.14/v3/activity/events/types/) the hook is triggered for. This replaces the entire array of events.", - "default": "[\"push\"]", + "default": [ + "push" + ], "required": false, "location": "body" }, @@ -38047,8 +37990,7 @@ { "name": "target_commitish", "type": "string", - "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`).", + "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`).", "required": false, "location": "body" }, @@ -38183,8 +38125,7 @@ { "name": "target_commitish", "type": "string", - "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`).", + "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`).", "required": false, "location": "body" }, @@ -39470,8 +39411,7 @@ { "name": "sort", "type": "string", - "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/enterprise/2.14/v3/search/#ranking-search-results)", + "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/enterprise/2.14/v3/search/#ranking-search-results)", "required": false, "enum": [ "stars", @@ -39537,8 +39477,7 @@ { "name": "sort", "type": "string", - "description": "Sorts the results of your query by `author-date` or `committer-date`.", - "default": "[best match](https://developer.github.com/enterprise/2.14/v3/search/#ranking-search-results)", + "description": "Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://developer.github.com/enterprise/2.14/v3/search/#ranking-search-results)", "required": false, "enum": [ "author-date", @@ -39596,8 +39535,7 @@ { "name": "sort", "type": "string", - "description": "Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub Enterprise search infrastructure.", - "default": "[best match](https://developer.github.com/enterprise/2.14/v3/search/#ranking-search-results)", + "description": "Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub Enterprise search infrastructure. Default: [best match](https://developer.github.com/enterprise/2.14/v3/search/#ranking-search-results)", "required": false, "enum": [ "indexed" @@ -39660,8 +39598,7 @@ { "name": "sort", "type": "string", - "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/enterprise/2.14/v3/search/#ranking-search-results)", + "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/enterprise/2.14/v3/search/#ranking-search-results)", "required": false, "enum": [ "comments", @@ -39734,8 +39671,7 @@ { "name": "sort", "type": "string", - "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/enterprise/2.14/v3/search/#ranking-search-results)", + "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/enterprise/2.14/v3/search/#ranking-search-results)", "required": false, "enum": [ "comments", @@ -39812,8 +39748,7 @@ { "name": "sort", "type": "string", - "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise.", - "default": "[best match](https://developer.github.com/enterprise/2.14/v3/search/#ranking-search-results)", + "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise. Default: [best match](https://developer.github.com/enterprise/2.14/v3/search/#ranking-search-results)", "required": false, "enum": [ "followers", @@ -39910,8 +39845,7 @@ { "name": "sort", "type": "string", - "description": "Sorts the results of your query by when the label was `created` or `updated`.", - "default": "[best match](https://developer.github.com/enterprise/2.14/v3/search/#ranking-search-results)", + "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://developer.github.com/enterprise/2.14/v3/search/#ranking-search-results)", "required": false, "enum": [ "created", @@ -40011,8 +39945,7 @@ { "name": "sort", "type": "string", - "description": "The sort field. One of `stars`, `forks`, or `updated`.", - "default": "results are sorted by best match.", + "description": "The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match.", "required": false, "enum": [ "stars", @@ -40061,8 +39994,7 @@ { "name": "sort", "type": "string", - "description": "The sort field. One of `stars`, `forks`, or `updated`.", - "default": "results are sorted by best match.", + "description": "The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match.", "required": false, "enum": [ "stars", @@ -40302,8 +40234,7 @@ { "name": "privacy", "type": "string", - "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` \n**Note**: You must pass the `hellcat-preview` media type to set privacy default to `closed` for child teams. **For a parent or child team:** ", - "default": "secret", + "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` \n**Note**: You must pass the `hellcat-preview` media type to set privacy default to `closed` for child teams.", "required": false, "enum": [ "secret", @@ -40445,6 +40376,10 @@ "type": "string", "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.", "required": false, + "enum": [ + "secret", + "closed" + ], "location": "body" }, { diff --git a/routes/ghe-2.14/orgs.json b/routes/ghe-2.14/orgs.json index dcfe7452a2..765a39414e 100644 --- a/routes/ghe-2.14/orgs.json +++ b/routes/ghe-2.14/orgs.json @@ -571,7 +571,9 @@ "name": "events", "type": "string[]", "description": "Determines what [events](https://developer.github.com/enterprise/2.14/v3/activity/events/types/) the hook is triggered for.", - "default": "[\"push\"]", + "default": [ + "push" + ], "required": false, "location": "body" }, @@ -687,7 +689,9 @@ "name": "events", "type": "string[]", "description": "Determines what [events](https://developer.github.com/enterprise/2.14/v3/activity/events/types/) the hook is triggered for.", - "default": "[\"push\"]", + "default": [ + "push" + ], "required": false, "location": "body" }, diff --git a/routes/ghe-2.14/orgs/create-hook.json b/routes/ghe-2.14/orgs/create-hook.json index d909c435a2..cffbf3b6d0 100644 --- a/routes/ghe-2.14/orgs/create-hook.json +++ b/routes/ghe-2.14/orgs/create-hook.json @@ -58,7 +58,9 @@ "name": "events", "type": "string[]", "description": "Determines what [events](https://developer.github.com/enterprise/2.14/v3/activity/events/types/) the hook is triggered for.", - "default": "[\"push\"]", + "default": [ + "push" + ], "required": false, "location": "body" }, diff --git a/routes/ghe-2.14/orgs/update-hook.json b/routes/ghe-2.14/orgs/update-hook.json index ed72cca696..a75cb21647 100644 --- a/routes/ghe-2.14/orgs/update-hook.json +++ b/routes/ghe-2.14/orgs/update-hook.json @@ -58,7 +58,9 @@ "name": "events", "type": "string[]", "description": "Determines what [events](https://developer.github.com/enterprise/2.14/v3/activity/events/types/) the hook is triggered for.", - "default": "[\"push\"]", + "default": [ + "push" + ], "required": false, "location": "body" }, diff --git a/routes/ghe-2.14/pulls.json b/routes/ghe-2.14/pulls.json index 23776fd913..1813718299 100644 --- a/routes/ghe-2.14/pulls.json +++ b/routes/ghe-2.14/pulls.json @@ -75,8 +75,7 @@ { "name": "direction", "type": "string", - "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`", + "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`.", "required": false, "enum": [ "asc", diff --git a/routes/ghe-2.14/pulls/list.json b/routes/ghe-2.14/pulls/list.json index f1ce783bc8..e61c6387b3 100644 --- a/routes/ghe-2.14/pulls/list.json +++ b/routes/ghe-2.14/pulls/list.json @@ -74,8 +74,7 @@ { "name": "direction", "type": "string", - "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`", + "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`.", "required": false, "enum": [ "asc", diff --git a/routes/ghe-2.14/repos.json b/routes/ghe-2.14/repos.json index 71da425e03..ee647bf1bf 100644 --- a/routes/ghe-2.14/repos.json +++ b/routes/ghe-2.14/repos.json @@ -59,8 +59,7 @@ { "name": "direction", "type": "string", - "description": "Can be one of `asc` or `desc`.", - "default": "`asc` when using `full_name`, otherwise `desc`", + "description": "Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc`", "required": false, "enum": [ "asc", @@ -133,8 +132,7 @@ { "name": "direction", "type": "string", - "description": "Can be one of `asc` or `desc`.", - "default": "`asc` when using `full_name`, otherwise `desc`", + "description": "Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc`", "required": false, "enum": [ "asc", @@ -5307,8 +5305,7 @@ { "name": "sha", "type": "string", - "description": "SHA or branch to start listing commits from.", - "default": "the repository’s default branch (usually `master`).", + "description": "SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`).", "required": false, "location": "query" }, @@ -5619,50 +5616,6 @@ "idName": "get-commit", "documentationUrl": "https://developer.github.com/enterprise/2.14/v3/repos/commits/#get-a-single-commit" }, - { - "name": "Get the SHA-1 of a commit reference", - "enabledForApps": true, - "method": "GET", - "path": "/repos/:owner/:repo/commits/:ref", - "previews": [], - "params": [ - { - "name": "owner", - "type": "string", - "required": true, - "description": "", - "location": "url" - }, - { - "name": "repo", - "type": "string", - "required": true, - "description": "", - "location": "url" - }, - { - "name": "ref", - "type": "string", - "required": true, - "description": "", - "location": "url" - } - ], - "description": "**Note:** To access this endpoint, you must provide a custom [media type](https://developer.github.com/v3/media) in the `Accept` header:\n\n```\napplication/vnd.github.VERSION.sha\n\n```\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.\n\n", - "responses": [ - { - "headers": { - "status": "200 OK" - } - } - ], - "idName": "get-commit-ref-sha", - "documentationUrl": "https://developer.github.com/enterprise/2.14/v3/repos/commits/#get-a-single-commit", - "deprecated": { - "date": "2019-05-22", - "message": "\"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." - } - }, { "name": "Compare two commits", "enabledForApps": true, @@ -5991,8 +5944,7 @@ { "name": "ref", "type": "string", - "description": "The name of the commit/branch/tag.", - "default": "the repository’s default branch (usually `master`)", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", "required": false, "location": "query" } @@ -6058,8 +6010,7 @@ { "name": "ref", "type": "string", - "description": "The name of the commit/branch/tag.", - "default": "the repository’s default branch (usually `master`)", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", "required": false, "location": "query" } @@ -6120,16 +6071,14 @@ { "name": "branch", "type": "string", - "description": "The branch name.", - "default": "the repository’s default branch (usually `master`)", + "description": "The branch name. Default: the repository’s default branch (usually `master`)", "required": false, "location": "body" }, { "name": "committer", "type": "object", - "description": "The person that committed the file.", - "default": "the authenticated user.", + "description": "The person that committed the file. Default: the authenticated user.", "required": false, "location": "body" }, @@ -6150,8 +6099,7 @@ { "name": "author", "type": "object", - "description": "The author of the file.", - "default": "The `committer` or the authenticated user if you omit `committer`.", + "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", "required": false, "location": "body" }, @@ -6296,16 +6244,14 @@ { "name": "branch", "type": "string", - "description": "The branch name.", - "default": "the repository’s default branch (usually `master`)", + "description": "The branch name. Default: the repository’s default branch (usually `master`)", "required": false, "location": "body" }, { "name": "committer", "type": "object", - "description": "The person that committed the file.", - "default": "the authenticated user.", + "description": "The person that committed the file. Default: the authenticated user.", "required": false, "location": "body" }, @@ -6326,8 +6272,7 @@ { "name": "author", "type": "object", - "description": "The author of the file.", - "default": "The `committer` or the authenticated user if you omit `committer`.", + "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", "required": false, "location": "body" }, @@ -6482,16 +6427,14 @@ { "name": "branch", "type": "string", - "description": "The branch name.", - "default": "the repository’s default branch (usually `master`)", + "description": "The branch name. Default: the repository’s default branch (usually `master`)", "required": false, "location": "body" }, { "name": "committer", "type": "object", - "description": "The person that committed the file.", - "default": "the authenticated user.", + "description": "The person that committed the file. Default: the authenticated user.", "required": false, "location": "body" }, @@ -6512,8 +6455,7 @@ { "name": "author", "type": "object", - "description": "The author of the file.", - "default": "The `committer` or the authenticated user if you omit `committer`.", + "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", "required": false, "location": "body" }, @@ -6661,8 +6603,7 @@ { "name": "branch", "type": "string", - "description": "The branch name.", - "default": "the repository’s default branch (usually `master`)", + "description": "The branch name. Default: the repository’s default branch (usually `master`)", "required": false, "location": "body" }, @@ -7090,7 +7031,7 @@ "name": "payload", "type": "string", "description": "JSON payload with extra information about the deployment.", - "default": "\"\"", + "default": "", "required": false, "location": "body" }, @@ -7106,7 +7047,7 @@ "name": "description", "type": "string", "description": "Short description of the deployment.", - "default": "\"\"", + "default": "", "required": false, "location": "body" }, @@ -7121,8 +7062,7 @@ { "name": "production_environment", "type": "boolean", - "description": "Specifies if the given environment is one that end-users directly interact with.", - "default": "`true` when `environment` is `production` and `false` otherwise", + "description": "Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise.", "required": false, "location": "body" } @@ -7379,7 +7319,7 @@ "name": "target_url", "type": "string", "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`.", - "default": "\"\"", + "default": "", "required": false, "location": "body" }, @@ -7387,7 +7327,7 @@ "name": "log_url", "type": "string", "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": "\"\"", + "default": "", "required": false, "location": "body" }, @@ -7395,7 +7335,7 @@ "name": "description", "type": "string", "description": "A short description of the status. The maximum description length is 140 characters.", - "default": "\"\"", + "default": "", "required": false, "location": "body" }, @@ -7403,7 +7343,7 @@ "name": "environment_url", "type": "string", "description": "Sets the URL for accessing your environment.", - "default": "\"\"", + "default": "", "required": false, "location": "body" }, @@ -8156,7 +8096,9 @@ "name": "events", "type": "string[]", "description": "Determines what [events](https://developer.github.com/enterprise/2.14/v3/activity/events/types/) the hook is triggered for.", - "default": "[\"push\"]", + "default": [ + "push" + ], "required": false, "location": "body" }, @@ -8288,7 +8230,9 @@ "name": "events", "type": "string[]", "description": "Determines what [events](https://developer.github.com/enterprise/2.14/v3/activity/events/types/) the hook is triggered for. This replaces the entire array of events.", - "default": "[\"push\"]", + "default": [ + "push" + ], "required": false, "location": "body" }, @@ -10154,8 +10098,7 @@ { "name": "target_commitish", "type": "string", - "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`).", + "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`).", "required": false, "location": "body" }, @@ -10290,8 +10233,7 @@ { "name": "target_commitish", "type": "string", - "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`).", + "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`).", "required": false, "location": "body" }, diff --git a/routes/ghe-2.14/repos/create-deployment-status.json b/routes/ghe-2.14/repos/create-deployment-status.json index 2e205e44e3..1bcfb8b5bb 100644 --- a/routes/ghe-2.14/repos/create-deployment-status.json +++ b/routes/ghe-2.14/repos/create-deployment-status.json @@ -50,7 +50,7 @@ "name": "target_url", "type": "string", "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`.", - "default": "\"\"", + "default": "", "required": false, "location": "body" }, @@ -58,7 +58,7 @@ "name": "log_url", "type": "string", "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": "\"\"", + "default": "", "required": false, "location": "body" }, @@ -66,7 +66,7 @@ "name": "description", "type": "string", "description": "A short description of the status. The maximum description length is 140 characters.", - "default": "\"\"", + "default": "", "required": false, "location": "body" }, @@ -74,7 +74,7 @@ "name": "environment_url", "type": "string", "description": "Sets the URL for accessing your environment.", - "default": "\"\"", + "default": "", "required": false, "location": "body" }, diff --git a/routes/ghe-2.14/repos/create-deployment.json b/routes/ghe-2.14/repos/create-deployment.json index 499228743f..99aeaa1780 100644 --- a/routes/ghe-2.14/repos/create-deployment.json +++ b/routes/ghe-2.14/repos/create-deployment.json @@ -59,7 +59,7 @@ "name": "payload", "type": "string", "description": "JSON payload with extra information about the deployment.", - "default": "\"\"", + "default": "", "required": false, "location": "body" }, @@ -75,7 +75,7 @@ "name": "description", "type": "string", "description": "Short description of the deployment.", - "default": "\"\"", + "default": "", "required": false, "location": "body" }, @@ -90,8 +90,7 @@ { "name": "production_environment", "type": "boolean", - "description": "Specifies if the given environment is one that end-users directly interact with.", - "default": "`true` when `environment` is `production` and `false` otherwise", + "description": "Specifies if the given environment is one that end-users directly interact with. Default: `true` when `environment` is `production` and `false` otherwise.", "required": false, "location": "body" } diff --git a/routes/ghe-2.14/repos/create-file.json b/routes/ghe-2.14/repos/create-file.json index f9e531275c..8867f8eb85 100644 --- a/routes/ghe-2.14/repos/create-file.json +++ b/routes/ghe-2.14/repos/create-file.json @@ -50,16 +50,14 @@ { "name": "branch", "type": "string", - "description": "The branch name.", - "default": "the repository’s default branch (usually `master`)", + "description": "The branch name. Default: the repository’s default branch (usually `master`)", "required": false, "location": "body" }, { "name": "committer", "type": "object", - "description": "The person that committed the file.", - "default": "the authenticated user.", + "description": "The person that committed the file. Default: the authenticated user.", "required": false, "location": "body" }, @@ -80,8 +78,7 @@ { "name": "author", "type": "object", - "description": "The author of the file.", - "default": "The `committer` or the authenticated user if you omit `committer`.", + "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", "required": false, "location": "body" }, diff --git a/routes/ghe-2.14/repos/create-hook.json b/routes/ghe-2.14/repos/create-hook.json index 553951c5cb..672a18169d 100644 --- a/routes/ghe-2.14/repos/create-hook.json +++ b/routes/ghe-2.14/repos/create-hook.json @@ -65,7 +65,9 @@ "name": "events", "type": "string[]", "description": "Determines what [events](https://developer.github.com/enterprise/2.14/v3/activity/events/types/) the hook is triggered for.", - "default": "[\"push\"]", + "default": [ + "push" + ], "required": false, "location": "body" }, diff --git a/routes/ghe-2.14/repos/create-or-update-file.json b/routes/ghe-2.14/repos/create-or-update-file.json index 26984c1658..5d47c7fc95 100644 --- a/routes/ghe-2.14/repos/create-or-update-file.json +++ b/routes/ghe-2.14/repos/create-or-update-file.json @@ -50,16 +50,14 @@ { "name": "branch", "type": "string", - "description": "The branch name.", - "default": "the repository’s default branch (usually `master`)", + "description": "The branch name. Default: the repository’s default branch (usually `master`)", "required": false, "location": "body" }, { "name": "committer", "type": "object", - "description": "The person that committed the file.", - "default": "the authenticated user.", + "description": "The person that committed the file. Default: the authenticated user.", "required": false, "location": "body" }, @@ -80,8 +78,7 @@ { "name": "author", "type": "object", - "description": "The author of the file.", - "default": "The `committer` or the authenticated user if you omit `committer`.", + "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", "required": false, "location": "body" }, diff --git a/routes/ghe-2.14/repos/create-release.json b/routes/ghe-2.14/repos/create-release.json index c23a1cc575..26fb21dd41 100644 --- a/routes/ghe-2.14/repos/create-release.json +++ b/routes/ghe-2.14/repos/create-release.json @@ -29,8 +29,7 @@ { "name": "target_commitish", "type": "string", - "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`).", + "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`).", "required": false, "location": "body" }, diff --git a/routes/ghe-2.14/repos/delete-file.json b/routes/ghe-2.14/repos/delete-file.json index 809eb1f598..7241182590 100644 --- a/routes/ghe-2.14/repos/delete-file.json +++ b/routes/ghe-2.14/repos/delete-file.json @@ -43,8 +43,7 @@ { "name": "branch", "type": "string", - "description": "The branch name.", - "default": "the repository’s default branch (usually `master`)", + "description": "The branch name. Default: the repository’s default branch (usually `master`)", "required": false, "location": "body" }, diff --git a/routes/ghe-2.14/repos/get-contents.json b/routes/ghe-2.14/repos/get-contents.json index c6a917b551..8d11b8d42d 100644 --- a/routes/ghe-2.14/repos/get-contents.json +++ b/routes/ghe-2.14/repos/get-contents.json @@ -29,8 +29,7 @@ { "name": "ref", "type": "string", - "description": "The name of the commit/branch/tag.", - "default": "the repository’s default branch (usually `master`)", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", "required": false, "location": "query" } diff --git a/routes/ghe-2.14/repos/get-readme.json b/routes/ghe-2.14/repos/get-readme.json index 6afd4cde7a..d64336f56b 100644 --- a/routes/ghe-2.14/repos/get-readme.json +++ b/routes/ghe-2.14/repos/get-readme.json @@ -22,8 +22,7 @@ { "name": "ref", "type": "string", - "description": "The name of the commit/branch/tag.", - "default": "the repository’s default branch (usually `master`)", + "description": "The name of the commit/branch/tag. Default: the repository’s default branch (usually `master`)", "required": false, "location": "query" } diff --git a/routes/ghe-2.14/repos/list-commits.json b/routes/ghe-2.14/repos/list-commits.json index bcd7292456..ccbd66fc1f 100644 --- a/routes/ghe-2.14/repos/list-commits.json +++ b/routes/ghe-2.14/repos/list-commits.json @@ -22,8 +22,7 @@ { "name": "sha", "type": "string", - "description": "SHA or branch to start listing commits from.", - "default": "the repository’s default branch (usually `master`).", + "description": "SHA or branch to start listing commits from. Default: the repository’s default branch (usually `master`).", "required": false, "location": "query" }, diff --git a/routes/ghe-2.14/repos/list-for-user.json b/routes/ghe-2.14/repos/list-for-user.json index 2e407169f2..663dcb2ef0 100644 --- a/routes/ghe-2.14/repos/list-for-user.json +++ b/routes/ghe-2.14/repos/list-for-user.json @@ -42,8 +42,7 @@ { "name": "direction", "type": "string", - "description": "Can be one of `asc` or `desc`.", - "default": "`asc` when using `full_name`, otherwise `desc`", + "description": "Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc`", "required": false, "enum": [ "asc", diff --git a/routes/ghe-2.14/repos/list.json b/routes/ghe-2.14/repos/list.json index ecf6b83e65..74ce23eda5 100644 --- a/routes/ghe-2.14/repos/list.json +++ b/routes/ghe-2.14/repos/list.json @@ -58,8 +58,7 @@ { "name": "direction", "type": "string", - "description": "Can be one of `asc` or `desc`.", - "default": "`asc` when using `full_name`, otherwise `desc`", + "description": "Can be one of `asc` or `desc`. Default: `asc` when using `full_name`, otherwise `desc`", "required": false, "enum": [ "asc", diff --git a/routes/ghe-2.14/repos/update-file.json b/routes/ghe-2.14/repos/update-file.json index c15d076a15..f70bed0dd7 100644 --- a/routes/ghe-2.14/repos/update-file.json +++ b/routes/ghe-2.14/repos/update-file.json @@ -50,16 +50,14 @@ { "name": "branch", "type": "string", - "description": "The branch name.", - "default": "the repository’s default branch (usually `master`)", + "description": "The branch name. Default: the repository’s default branch (usually `master`)", "required": false, "location": "body" }, { "name": "committer", "type": "object", - "description": "The person that committed the file.", - "default": "the authenticated user.", + "description": "The person that committed the file. Default: the authenticated user.", "required": false, "location": "body" }, @@ -80,8 +78,7 @@ { "name": "author", "type": "object", - "description": "The author of the file.", - "default": "The `committer` or the authenticated user if you omit `committer`.", + "description": "The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.", "required": false, "location": "body" }, diff --git a/routes/ghe-2.14/repos/update-hook.json b/routes/ghe-2.14/repos/update-hook.json index 0e8bdd160d..0130fd37f8 100644 --- a/routes/ghe-2.14/repos/update-hook.json +++ b/routes/ghe-2.14/repos/update-hook.json @@ -65,7 +65,9 @@ "name": "events", "type": "string[]", "description": "Determines what [events](https://developer.github.com/enterprise/2.14/v3/activity/events/types/) the hook is triggered for. This replaces the entire array of events.", - "default": "[\"push\"]", + "default": [ + "push" + ], "required": false, "location": "body" }, diff --git a/routes/ghe-2.14/repos/update-release.json b/routes/ghe-2.14/repos/update-release.json index b052bb36aa..d6a0b1e524 100644 --- a/routes/ghe-2.14/repos/update-release.json +++ b/routes/ghe-2.14/repos/update-release.json @@ -36,8 +36,7 @@ { "name": "target_commitish", "type": "string", - "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`).", + "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`).", "required": false, "location": "body" }, diff --git a/routes/ghe-2.14/search.json b/routes/ghe-2.14/search.json index 57b859850a..3dd9e46965 100644 --- a/routes/ghe-2.14/search.json +++ b/routes/ghe-2.14/search.json @@ -22,8 +22,7 @@ { "name": "sort", "type": "string", - "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/enterprise/2.14/v3/search/#ranking-search-results)", + "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/enterprise/2.14/v3/search/#ranking-search-results)", "required": false, "enum": [ "stars", @@ -89,8 +88,7 @@ { "name": "sort", "type": "string", - "description": "Sorts the results of your query by `author-date` or `committer-date`.", - "default": "[best match](https://developer.github.com/enterprise/2.14/v3/search/#ranking-search-results)", + "description": "Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://developer.github.com/enterprise/2.14/v3/search/#ranking-search-results)", "required": false, "enum": [ "author-date", @@ -148,8 +146,7 @@ { "name": "sort", "type": "string", - "description": "Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub Enterprise search infrastructure.", - "default": "[best match](https://developer.github.com/enterprise/2.14/v3/search/#ranking-search-results)", + "description": "Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub Enterprise search infrastructure. Default: [best match](https://developer.github.com/enterprise/2.14/v3/search/#ranking-search-results)", "required": false, "enum": [ "indexed" @@ -212,8 +209,7 @@ { "name": "sort", "type": "string", - "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/enterprise/2.14/v3/search/#ranking-search-results)", + "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/enterprise/2.14/v3/search/#ranking-search-results)", "required": false, "enum": [ "comments", @@ -286,8 +282,7 @@ { "name": "sort", "type": "string", - "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/enterprise/2.14/v3/search/#ranking-search-results)", + "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/enterprise/2.14/v3/search/#ranking-search-results)", "required": false, "enum": [ "comments", @@ -364,8 +359,7 @@ { "name": "sort", "type": "string", - "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise.", - "default": "[best match](https://developer.github.com/enterprise/2.14/v3/search/#ranking-search-results)", + "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise. Default: [best match](https://developer.github.com/enterprise/2.14/v3/search/#ranking-search-results)", "required": false, "enum": [ "followers", @@ -462,8 +456,7 @@ { "name": "sort", "type": "string", - "description": "Sorts the results of your query by when the label was `created` or `updated`.", - "default": "[best match](https://developer.github.com/enterprise/2.14/v3/search/#ranking-search-results)", + "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://developer.github.com/enterprise/2.14/v3/search/#ranking-search-results)", "required": false, "enum": [ "created", @@ -563,8 +556,7 @@ { "name": "sort", "type": "string", - "description": "The sort field. One of `stars`, `forks`, or `updated`.", - "default": "results are sorted by best match.", + "description": "The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match.", "required": false, "enum": [ "stars", @@ -613,8 +605,7 @@ { "name": "sort", "type": "string", - "description": "The sort field. One of `stars`, `forks`, or `updated`.", - "default": "results are sorted by best match.", + "description": "The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match.", "required": false, "enum": [ "stars", diff --git a/routes/ghe-2.14/search/code.json b/routes/ghe-2.14/search/code.json index 80104efc20..fad5a38d08 100644 --- a/routes/ghe-2.14/search/code.json +++ b/routes/ghe-2.14/search/code.json @@ -15,8 +15,7 @@ { "name": "sort", "type": "string", - "description": "Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub Enterprise search infrastructure.", - "default": "[best match](https://developer.github.com/enterprise/2.14/v3/search/#ranking-search-results)", + "description": "Sorts the results of your query. Can only be `indexed`, which indicates how recently a file has been indexed by the GitHub Enterprise search infrastructure. Default: [best match](https://developer.github.com/enterprise/2.14/v3/search/#ranking-search-results)", "required": false, "enum": [ "indexed" diff --git a/routes/ghe-2.14/search/commits.json b/routes/ghe-2.14/search/commits.json index 35d647ffc8..fc94b03035 100644 --- a/routes/ghe-2.14/search/commits.json +++ b/routes/ghe-2.14/search/commits.json @@ -21,8 +21,7 @@ { "name": "sort", "type": "string", - "description": "Sorts the results of your query by `author-date` or `committer-date`.", - "default": "[best match](https://developer.github.com/enterprise/2.14/v3/search/#ranking-search-results)", + "description": "Sorts the results of your query by `author-date` or `committer-date`. Default: [best match](https://developer.github.com/enterprise/2.14/v3/search/#ranking-search-results)", "required": false, "enum": [ "author-date", diff --git a/routes/ghe-2.14/search/issues-and-pull-requests.json b/routes/ghe-2.14/search/issues-and-pull-requests.json index 0a6579e3db..d85fe88d5d 100644 --- a/routes/ghe-2.14/search/issues-and-pull-requests.json +++ b/routes/ghe-2.14/search/issues-and-pull-requests.json @@ -21,8 +21,7 @@ { "name": "sort", "type": "string", - "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/enterprise/2.14/v3/search/#ranking-search-results)", + "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/enterprise/2.14/v3/search/#ranking-search-results)", "required": false, "enum": [ "comments", diff --git a/routes/ghe-2.14/search/issues.json b/routes/ghe-2.14/search/issues.json index 50d6e241db..695d40f4b1 100644 --- a/routes/ghe-2.14/search/issues.json +++ b/routes/ghe-2.14/search/issues.json @@ -21,8 +21,7 @@ { "name": "sort", "type": "string", - "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/enterprise/2.14/v3/search/#ranking-search-results)", + "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/enterprise/2.14/v3/search/#ranking-search-results)", "required": false, "enum": [ "comments", diff --git a/routes/ghe-2.14/search/labels.json b/routes/ghe-2.14/search/labels.json index be46a2022a..e7984ae5ed 100644 --- a/routes/ghe-2.14/search/labels.json +++ b/routes/ghe-2.14/search/labels.json @@ -28,8 +28,7 @@ { "name": "sort", "type": "string", - "description": "Sorts the results of your query by when the label was `created` or `updated`.", - "default": "[best match](https://developer.github.com/enterprise/2.14/v3/search/#ranking-search-results)", + "description": "Sorts the results of your query by when the label was `created` or `updated`. Default: [best match](https://developer.github.com/enterprise/2.14/v3/search/#ranking-search-results)", "required": false, "enum": [ "created", diff --git a/routes/ghe-2.14/search/repos-legacy.json b/routes/ghe-2.14/search/repos-legacy.json index 05dcc705da..3c02732c68 100644 --- a/routes/ghe-2.14/search/repos-legacy.json +++ b/routes/ghe-2.14/search/repos-legacy.json @@ -29,8 +29,7 @@ { "name": "sort", "type": "string", - "description": "The sort field. One of `stars`, `forks`, or `updated`.", - "default": "results are sorted by best match.", + "description": "The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match.", "required": false, "enum": [ "stars", diff --git a/routes/ghe-2.14/search/repos.json b/routes/ghe-2.14/search/repos.json index 5f42303edd..726e52cdc1 100644 --- a/routes/ghe-2.14/search/repos.json +++ b/routes/ghe-2.14/search/repos.json @@ -21,8 +21,7 @@ { "name": "sort", "type": "string", - "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/enterprise/2.14/v3/search/#ranking-search-results)", + "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/enterprise/2.14/v3/search/#ranking-search-results)", "required": false, "enum": [ "stars", diff --git a/routes/ghe-2.14/search/users-legacy.json b/routes/ghe-2.14/search/users-legacy.json index 3373620617..3fd953fbc9 100644 --- a/routes/ghe-2.14/search/users-legacy.json +++ b/routes/ghe-2.14/search/users-legacy.json @@ -22,8 +22,7 @@ { "name": "sort", "type": "string", - "description": "The sort field. One of `stars`, `forks`, or `updated`.", - "default": "results are sorted by best match.", + "description": "The sort field. One of `stars`, `forks`, or `updated`. Default: results are sorted by best match.", "required": false, "enum": [ "stars", diff --git a/routes/ghe-2.14/search/users.json b/routes/ghe-2.14/search/users.json index e6dd971081..e927c7471f 100644 --- a/routes/ghe-2.14/search/users.json +++ b/routes/ghe-2.14/search/users.json @@ -15,8 +15,7 @@ { "name": "sort", "type": "string", - "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise.", - "default": "[best match](https://developer.github.com/enterprise/2.14/v3/search/#ranking-search-results)", + "description": "Sorts the results of your query by number of `followers` or `repositories`, or when the person `joined` GitHub Enterprise. Default: [best match](https://developer.github.com/enterprise/2.14/v3/search/#ranking-search-results)", "required": false, "enum": [ "followers", diff --git a/routes/ghe-2.14/teams.json b/routes/ghe-2.14/teams.json index c44f726091..1a735b08de 100644 --- a/routes/ghe-2.14/teams.json +++ b/routes/ghe-2.14/teams.json @@ -193,8 +193,7 @@ { "name": "privacy", "type": "string", - "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` \n**Note**: You must pass the `hellcat-preview` media type to set privacy default to `closed` for child teams. **For a parent or child team:** ", - "default": "secret", + "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` \n**Note**: You must pass the `hellcat-preview` media type to set privacy default to `closed` for child teams.", "required": false, "enum": [ "secret", @@ -336,6 +335,10 @@ "type": "string", "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.", "required": false, + "enum": [ + "secret", + "closed" + ], "location": "body" }, { diff --git a/routes/ghe-2.14/teams/create.json b/routes/ghe-2.14/teams/create.json index 29723889f3..83f746fb65 100644 --- a/routes/ghe-2.14/teams/create.json +++ b/routes/ghe-2.14/teams/create.json @@ -49,8 +49,7 @@ { "name": "privacy", "type": "string", - "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` \n**Note**: You must pass the `hellcat-preview` media type to set privacy default to `closed` for child teams. **For a parent or child team:** ", - "default": "secret", + "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` \n**Note**: You must pass the `hellcat-preview` media type to set privacy default to `closed` for child teams.", "required": false, "enum": [ "secret", diff --git a/routes/ghe-2.14/teams/update.json b/routes/ghe-2.14/teams/update.json index 400e58c8d9..d3a3b9d868 100644 --- a/routes/ghe-2.14/teams/update.json +++ b/routes/ghe-2.14/teams/update.json @@ -37,6 +37,10 @@ "type": "string", "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.", "required": false, + "enum": [ + "secret", + "closed" + ], "location": "body" }, {